Add Method
- Namespace
TXTextControl.DataVisualization
- Package
TXTextControl.asTextControl. WinForms. SDK TXTextControl.from the private NuGet feed or Text Control Offline Packagesdll
Description
Inserts a new chart in a Text Control document.
Syntax
Add(ChartFrame, int)
Inserts a chart inline, which means that it is treated in the text like a single character.
public bool Add(ChartFrame chartFrame, int textPosition);Public Function Add(chartFrame As ChartFrame, 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, int, 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.
public bool Add(ChartFrame chartFrame, HorizontalAlignment alignment, int textPosition, FrameInsertionMode insertionMode);Public Function Add(chartFrame As ChartFrame, alignment As HorizontalAlignment, textPosition As Integer, 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:
| ||||||||||||
| 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:
|
Add(ChartFrame, Point, int, 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.
public bool Add(ChartFrame chartFrame, Point location, int textPosition, FrameInsertionMode insertionMode);Public Function Add(chartFrame As ChartFrame, location As Point, textPosition As Integer, 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:
|
Add(ChartFrame, int, 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.
public bool Add(ChartFrame chartFrame, int pageNumber, Point location, FrameInsertionMode insertionMode);Public Function Add(chartFrame As ChartFrame, pageNumber As Integer, location As Point, insertionMode As FrameInsertionMode) As Boolean| Parameter | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| chartFrame | Specifies the chart and its frame to add. | ||||||||||||
| pageNumber | 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:
|
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.
public bool Add(ChartFrame chartFrame, Point location, FrameInsertionMode insertionMode);Public Function Add(chartFrame As ChartFrame, location As Point, 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:
|
Return Value
The return value is true, if the chart could be added. Otherwise, it is false.
Examples
The following example adds an item to the chart collection.
if (!chartCollection.Add(new TXTextControl.DataVisualization.ChartFrame(new System.ComponentModel.Component()), -1))
{
throw new InvalidOperationException("The item could not be inserted.");
}If Not chartCollection.Add(New TXTextControl.DataVisualization.ChartFrame(New System.ComponentModel.Component()), -1) Then
Throw New InvalidOperationException("The item could not be inserted.")
End If