TXTextControl.DataVisualization.ChartCollection.Add Method

Inserts a new chart in a Text Control document.

Add(ChartFrame, Int32)

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

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

Specifies the chart and its frame to add.

textPosition

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

Add(ChartFrame, HorizontalAlignment, Int32, FrameInsertionMode)

Inserts a chart 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 chart is moved with the text.

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

Specifies the chart and its frame to add.

alignment

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


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

Specifies the text position at which the chart is to be inserted. If -1 is specified, the chart 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 FrameInsertionMode enumeration:


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

Add(ChartFrame, Point, Int32, FrameInsertionMode)

Inserts a chart 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 chart is moved with the text.

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

Specifies the chart and its frame to add.

location

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

textPosition

Specifies the text position at which the chart is to be inserted. If -1 is specified, the chart 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 FrameInsertionMode enumeration:


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

Add(ChartFrame, Int32, Point, FrameInsertionMode)

Inserts a chart 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.

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

Specifies the chart and its frame to add.

page

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

location

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

insertionMode

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


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

Add(ChartFrame, Point, FrameInsertionMode)

Inserts a chart 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.

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

Specifies the chart and its frame to add.

location

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

insertionMode

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


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

Return Value

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

See Also