Description

Removes an image from a Text Control document.

Syntax

public bool Remove(Image image);

Public Function Remove(image As Image) As Boolean

Parameters

Parameter	Description
image	Specifies the image to remove.

Return Value

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

Examples

The following example removes a document logo after locating it by name.

TXTextControl.Image logo = new() { FileName = @"Images\company-logo.png", Name = "CompanyLogo", DescriptiveText = "Company logo" };
textControl.Images.Add(logo, -1);
TXTextControl.Image image = textControl.Images.GetItem("CompanyLogo");
if (image != null)
{
    textControl.Images.Remove(image);
}

Dim logo As New TXTextControl.Image() With { .FileName = "Images\company-logo.png", .Name = "CompanyLogo", .DescriptiveText = "Company logo" }
textControl.Images.Add(logo, -1)
Dim image As TXTextControl.Image = textControl.Images.GetItem("CompanyLogo")
If image IsNot Nothing Then
    textControl.Images.Remove(image)
End If