TXTextControl.ImageCollection.Add Method

Inserts a new image in a Text Control document.

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.

[C#]
public bool Add();
[Visual Basic]
Public Function Add() As Boolean

Add(Image, Int32)

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.

[C#]
public bool Add(Image image, int textPosition);
[Visual Basic]
Public Function Add(ByVal image As Image, ByVal textPosition As Integer) As Boolean
Parameter Description
image

Specifies the image to add.

textPosition

Specifies the text position at which the image is to be inserted. If -1 is specified, the image is inserted at the current input position.

Add(Image, HorizontalAlignment, Int32, 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.

[C#]
public bool Add(Image image, HorizontalAlignment alignment, int textPosition, ImageInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal image As Image, ByVal alignment As HorizontalAlignment, ByVal textPosition As Integer, _
  ByVal insertionMode As ImageInsertionMode) As Boolean
Parameter Description
image

Specifies the image to add.

alignment

Specifies the image's horizontal alignment. It can be one of the HorizontalAlignment values:


Value Meaning
Left The image is left aligned, relative to the paragraph to which it is anchored.
Right The image is right aligned, relative to the paragraph to which it is anchored.
Centered The image is centered, relative to the paragraph to which it is anchored.
Justify This value is not supported for images.
textPosition

Specifies the text position at which the image is to be inserted. If -1 is specified, the image is inserted at the current input position.

insertionMode

Specifies how the text flow is handled. It can be one of the following values of the ImageInsertionMode enumeration:


Value Meaning
AboveTheText The image is inserted at a certain geometrical location above the text. This means that the image overwrites the text.
BelowTheText The image is inserted at a certain geometrical location below the text. This means that the text overwrites the image.
DisplaceCompleteLines The text stops at the top and continues at the bottom of the image.
DisplaceText The text flows around the image and empty areas at the left and right side are filled.
Other Vaues All other values cannot be used with the ImageCollection.Add method.

Add(Image, Point, Int32, ImageInsertionMode)

Inserts a new image which is anchored to the specified text position. It has the specified location relative to the paragraph it is anchored to 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.

[C#]
public bool Add(Image image, System.Drawing.Point location, int textPosition, ImageInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal image As Image, ByVal location As System.Drawing.Point, ByVal textPosition As Integer, _
  ByVal insertionMode As ImageInsertionMode) As Boolean
Parameter Description
image

Specifies the image to add.

location

Specifies the location, in twips, at which the image is to be inserted. This is a location relative to the top left corner either of a page or of a paragraph.

textPosition

Specifies the text position at which the image is to be inserted. If -1 is specified, the image is inserted at the current input position.

insertionMode

Specifies how the text flow is handled. It can be one of the following values of the ImageInsertionMode enumeration:


Value Meaning
AboveTheText The image is inserted at a certain geometrical location above the text. This means that the image overwrites the text.
BelowTheText The image is inserted at a certain geometrical location below the text. This means that the text overwrites the image.
DisplaceCompleteLines The text stops at the top and continues at the bottom of the image.
DisplaceText The text flows around the image and empty areas at the left and right side are filled.
Other Vaues All other values cannot be used with the ImageCollection.Add method.

Add(Image, Int32, Point, ImageInsertionMode)

Inserts a new image which has a fixed geometrical position in the document. This position is specified through a page number and a location on this page. 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.

[C#]
public bool Add(Image image, int pageNumber, System.Drawing.Point location, ImageInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal image As Image, ByVal pageNumber As Integer, ByVal location As System.Drawing.Point, _
  ByVal insertionMode As ImageInsertionMode) As Boolean
Parameter Description
image

Specifies the image to add.

pageNumber

Specifies the number of a page beginning with 1 where the image is located.

location

Specifies the location, in twips, at which the image is to be inserted. This is a location relative to the top left corner either of a page or of a paragraph.

insertionMode

Specifies how the text flow is handled. It can be one of the following values of the ImageInsertionMode enumeration:


Value Meaning
AboveTheText The image is inserted at a certain geometrical location above the text. This means that the image overwrites the text.
BelowTheText The image is inserted at a certain geometrical location below the text. This means that the text overwrites the image.
DisplaceCompleteLines The text stops at the top and continues at the bottom of the image.
DisplaceText The text flows around the image and empty areas at the left and right side are filled.
Other Vaues All other values cannot be used with the ImageCollection.Add method.

Add(Image, Point, ImageInsertionMode)

Inserts a new image which has a fixed geometrical position in the document. This position is specified through a location relative to the top left corner of the complete document. All gaps between the pages must be included. 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.

[C#]
public bool Add(Image image, System.Drawing.Point location, ImageInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal image As Image, ByVal location As System.Drawing.Point, _
  ByVal insertionMode As ImageInsertionMode) As Boolean
Parameter Description
image

Specifies the image to add.

location

Specifies the location, in twips, at which the image is to be inserted. This is a location relative to the top left corner either of a page or of a paragraph.

insertionMode

Specifies how the text flow is handled. It can be one of the following values of the ImageInsertionMode enumeration:


Value Meaning
AboveTheText The image is inserted at a certain geometrical location above the text. This means that the image overwrites the text.
BelowTheText The image is inserted at a certain geometrical location below the text. This means that the text overwrites the image.
DisplaceCompleteLines The text stops at the top and continues at the bottom of the image.
DisplaceText The text flows around the image and empty areas at the left and right side are filled.
Other Vaues All other values cannot be used with the ImageCollection.Add method.

Return Value

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

See Also