TXTextControl.DataVisualization.DrawingCollection.Add Method

Inserts a new drawing in a Text Control document.

Add(DrawingFrame, Int32)

Inserts a drawing inline, which means that it is treated in the text like a single character.

[C#]
public bool Add(DataVisualization.DrawingFrame drawingFrame, int textPosition);
[Visual Basic]
Public Function Add(ByVal drawingFrame As DataVisualization.DrawingFrame, ByVal textPosition As Integer) As Boolean
Parameter Description
drawingFrame

Specifies the drawing and its frame to add.

textPosition

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

Add(DrawingFrame, HorizontalAlignment, Int32, FrameInsertionMode)

Inserts a drawing, which is anchored to the specified text position. It has the specified horizontal alignment relative to the paragraph into which it is inserted and the textflow is given through the insertionMode parameter. An anchored drawing is moved with the text. FrameInsertionMode.FixedOnPage and FrameInsertionMode.AsCharacter cannot be specified with this overload.

[C#]
public bool Add(DataVisualization.DrawingFrame drawingFrame, HorizontalAlignment alignment, int textPosition, FrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal drawingFrame As DataVisualization.DrawingFrame, ByVal alignment As HorizontalAlignment, ByVal textPosition As Integer, _
  ByVal insertionMode As FrameInsertionMode) As Boolean
Parameter Description
drawingFrame

Specifies the drawing and its frame to add.

alignment

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


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

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

insertionMode

Specifies how the text flow is handled. It can be one of the values of the FrameInsertionMode enumeration.

Add(DrawingFrame, Point, Int32, FrameInsertionMode)

Inserts a drawing, which is anchored to the specified text position. The specified location is relative to the paragraph into which it is inserted and the textflow is given through the insertionMode parameter. An anchored drawing is moved with the text. FrameInsertionMode.FixedOnPage and FrameInsertionMode.AsCharacter cannot be specified with this overload.

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

Specifies the drawing and its frame to add.

location

Specifies the location, in twips, at which the drawing is to be inserted.

textPosition

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

insertionMode

Specifies how the text flow is handled. It can be one of the values of the FrameInsertionMode enumeration.

Add(DrawingFrame, Int32, Point, FrameInsertionMode)

Inserts a drawing, which has a fixed geometrical position in the document. This position is specified through a page number and a location on this page and the textflow is given through the insertionMode parameter. FrameInsertionMode.MoveWithText and FrameInsertionMode.AsCharacter cannot be specified with this overload.

[C#]
public bool Add(DataVisualization.DrawingFrame drawingFrame, int page, System.Drawing.Point location, FrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal drawingFrame As DataVisualization.DrawingFrame, ByVal page As Integer, ByVal location As System.Drawing.Point, _
  ByVal insertionMode As FrameInsertionMode) As Boolean
Parameter Description
drawingFrame

Specifies the drawing and its frame to add.

page

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

location

Specifies the location, in twips, at which the drawing is to be inserted.

insertionMode

Specifies how the text flow is handled. It can be one of the values of the FrameInsertionMode enumeration.

Add(DrawingFrame, Point, FrameInsertionMode)

Inserts a drawing, which has a fixed geometrical position in the document. This position is specified relative to the complete document and the textflow is given through the insertionMode parameter. FrameInsertionMode.MoveWithText and FrameInsertionMode.AsCharacter cannot be specified with this overload.

[C#]
public bool Add(DataVisualization.DrawingFrame drawingFrame, System.Drawing.Point location, FrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal drawingFrame As DataVisualization.DrawingFrame, ByVal location As System.Drawing.Point, _
  ByVal insertionMode As FrameInsertionMode) As Boolean
Parameter Description
drawingFrame

Specifies the drawing and its frame to add.

location

Specifies the location, in twips, at which the drawing is to be inserted.

insertionMode

Specifies how the text flow is handled. It can be one of the values of the FrameInsertionMode enumeration.

Add(DrawingFrame, FrameInsertionMode)

Inserts a drawing with the built-in mouse interface. The drawing's size is determined through the end-user. A cross cursor indicates where the drawing can be inserted. Changing the document or pressing the ESC key aborts the insertion process.

[C#]
public bool Add(DataVisualization.DrawingFrame drawingFrame, FrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal drawingFrame As DataVisualization.DrawingFrame, ByVal insertionMode As FrameInsertionMode) As Boolean
Parameter Description
drawingFrame

Specifies the drawing and its frame to add.

insertionMode

Specifies how the text flow is handled. It can be one of the values of the FrameInsertionMode enumeration.

Return Value

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

See Also