Add Method

Description

Inserts a new image in a Text Control document.

Syntax

Add()

Inserts an image inline, which means that it is treated in the text like a single character. The image is inserted at the current text input position. A file open dialog box is shown to get the image's file name and filter.

public bool Add();

Public Function Add() As Boolean

Add(Image, int)

Inserts an image inline, which means that it is treated in the text like a single character. The image is inserted at the specified text input position. A file open dialog box is shown to get the image's file name and filter. To avoid opening the dialog box set the Image.FileName and the Image.FilterIndex properties of the specified Image object.

public bool Add(Image image, int textPosition);

Public Function Add(image As Image, textPosition As Integer) As Boolean

Add(Image, HorizontalAlignment, int, ImageInsertionMode)

Inserts a new image which is anchored to the specified text position. It has the specified horizontal alignment and a textflow which is given through the insertionMode parameter. Anchored images are moved with the text. A file open dialog box is shown to get the image's file name and filter. To avoid opening the dialog box set the Image.FileName and the Image.FilterIndex properties of the specified Image object.

public bool Add(Image image, HorizontalAlignment alignment, int textPosition, ImageInsertionMode insertionMode);

Public Function Add(image As Image, alignment As HorizontalAlignment, textPosition As Integer, insertionMode As ImageInsertionMode) As Boolean

public bool Add(Image image, Point location, int textPosition, ImageInsertionMode insertionMode);

Public Function Add(image As Image, location As Point, textPosition As Integer, insertionMode As ImageInsertionMode) As Boolean

public bool Add(Image image, int pageNumber, Point location, ImageInsertionMode insertionMode);

Public Function Add(image As Image, pageNumber As Integer, location As Point, insertionMode As ImageInsertionMode) As Boolean

public bool Add(Image image, Point location, ImageInsertionMode insertionMode);

Public Function Add(image As Image, location As Point, insertionMode As ImageInsertionMode) As Boolean

Return Value

The return value is true, if the image could be added. Otherwise, it is false.

Examples

The following example inserts a named, accessible company logo at the current input position.

TXTextControl.Image logo = new() { FileName = @"Images\company-logo.png", Name = "CompanyLogo", DescriptiveText = "Company logo" };
if (!textControl.Images.Add(logo, -1))
{
    throw new InvalidOperationException("The logo could not be inserted.");
}

Dim logo As New TXTextControl.Image() With { .FileName = "Images\company-logo.png", .Name = "CompanyLogo", .DescriptiveText = "Company logo" }
If Not textControl.Images.Add(logo, -1) Then
    Throw New InvalidOperationException("The logo could not be inserted.")
End If

Further Reading

• Custom Insert Image Dialog in TX Text Control .NET for WPF – July 2, 2020