DocumentSettings.EmbeddedFiles Property — TX Text Control .NET for Windows Forms

Description

Gets or sets an array of EmbeddedFile objects providing the name, data and additional optional properties of files, which are embedded in the current document. The property value is null, if there are no embedded files contained in the document.

Syntax

public EmbeddedFile[] EmbeddedFiles { get; set; }

Public Property EmbeddedFiles As EmbeddedFile()

Examples

The following example configures document settings for the current document by using DocumentSettings.EmbeddedFiles.

DocumentSettings documentSettings = textControl.DocumentSettings;

documentSettings.EmbeddedFiles = new EmbeddedFile[] { new EmbeddedFile("document.docx", new Microsoft.Win32.SafeHandles.SafeFileHandle(IntPtr.Zero, ownsHandle: false), "Quarterly report") };
if (documentSettings.EmbeddedFiles != null)
{
    Console.WriteLine("Document Settings: Embedded Files is available.");
}

documentSettings.DocumentTitle = "Quarterly results";
documentSettings.Author = "Finance team";

Dim documentSettings As DocumentSettings = textControl.DocumentSettings

documentSettings.EmbeddedFiles = New EmbeddedFile() { New EmbeddedFile("document.docx", New Microsoft.Win32.SafeHandles.SafeFileHandle(IntPtr.Zero, ownsHandle:=False), "Quarterly report") }
If documentSettings.EmbeddedFiles IsNot Nothing Then
    Console.WriteLine("Document Settings: Embedded Files is available.")
End If

documentSettings.DocumentTitle = "Quarterly results"
documentSettings.Author = "Finance team"

Limitations

PDF and PDF/A only.