ChartTextFrame
ChartTextFrame class
Encapsulates the object that represents the frame object which contains text.
Properties
| Name | Type | Description |
|---|---|---|
| IsAutoText | boolean | Indicates the text is auto generated. |
| IsDeleted | boolean | Indicates whether this data labels is deleted. |
| TextHorizontalAlignment | Number | Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant. |
| TextVerticalAlignment | Number | Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant. |
| RotationAngle | Number | Represents text rotation angle. 0: Not rotated. 255: Top to Bottom. -90: Downward. 90: Upward. |
| IsAutomaticRotation | boolean | Indicates whether the text of the chart is automatically rotated. |
| Text | String | Gets or sets the text of a frame’s title. |
| LinkedSource | String | Gets and sets a reference to the worksheet. |
| TextDirection | Number | Represents text reading order. The value of the property is TextDirectionType integer constant. NOTE: This member is now |
| ReadingOrder | Number | Represents text reading order. The value of the property is TextDirectionType integer constant. |
| DirectionType | Number | Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant. |
| IsTextWrapped | boolean | Gets or sets a value indicating whether the text is wrapped. |
| IsResizeShapeToFitText | boolean | Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text |
| IsInnerMode | boolean | Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the |
| Chart | Chart | Gets the chart to which this object belongs. |
| Border | Line | Gets the Line . |
| Area | Area | Gets the area . |
| TextFont | Font | Gets a Font object of the specified ChartFrame object. NOTE: This member is now obsolete. Instead, please use ChartFrame |
| TextOptions | TextOptions | Gets and sets the options of the text. |
| Font | Font | Gets a Font object of the specified ChartFrame object. |
| AutoScaleFont | boolean | True if the text in the object changes font size when the object size changes. The default value is True. |
| BackgroundMode | Number | Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant. |
| Background | Number | Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant. NOTE: Thi |
| IsAutomaticSize | boolean | Indicates whether the chart frame is automatic sized. |
| X | Number | Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. How to convert units of 1/4 |
| Y | Number | Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area. How to convert units of 1/4 |
| Height | Number | Gets or sets the height of frame in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? Height |
| Width | Number | Gets or sets the width of frame in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? Width In |
| Shadow | boolean | True if the frame has a shadow. |
| ShapeProperties | ShapePropertyCollection | Gets the ShapeProperties object. |
| IsDefaultPosBeSet | boolean | Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. |
| DefaultX | Number | Represents x of default position |
| DefaultY | Number | Represents y of default position |
| DefaultWidth | Number | Represents width of default position |
| DefaultHeight | Number | Represents height of default position |
| DefaultXRatioToChart | Number | |
| DefaultYRatioToChart | Number | |
| DefaultWidthRatioToChart | Number | |
| DefaultHeightRatioToChart | Number | |
| XRatioToChart | Number | |
| YRatioToChart | Number | |
| WidthRatioToChart | Number | |
| HeightRatioToChart | Number | |
| XPixel | Number | |
| YPixel | Number | |
| WidthPixel | Number | Represents width |
| HeightPixel | Number | Represents height |
Methods
| Name | Description |
|---|---|
| characters | Returns a Characters object that represents a range of characters within the text. |
| setPositionAuto | Set position of the frame to automatic |
ChartTextFrame.IsAutoText property
Indicates the text is auto generated.
Type: boolean
ChartTextFrame.IsDeleted property
Indicates whether this data labels is deleted.
Type: boolean
ChartTextFrame.TextHorizontalAlignment property
Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
Type: Number
ChartTextFrame.TextVerticalAlignment property
Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
Type: Number
ChartTextFrame.RotationAngle property
Represents text rotation angle. 0: Not rotated. 255: Top to Bottom. -90: Downward. 90: Upward.
Type: Number
ChartTextFrame.IsAutomaticRotation property
Indicates whether the text of the chart is automatically rotated.
Type: boolean
ChartTextFrame.Text property
Gets or sets the text of a frame’s title.
Type: String
ChartTextFrame.LinkedSource property
Gets and sets a reference to the worksheet.
Type: String
ChartTextFrame.TextDirection property
Represents text reading order. The value of the property is TextDirectionType integer constant. NOTE: This member is now obsolete. Instead, please use ChartTextFrame.ReadingOrder property. This property will be removed 12 months later since March 2020. Aspose apologizes for any inconvenience you may have experienced.
Type: Number
ChartTextFrame.ReadingOrder property
Represents text reading order. The value of the property is TextDirectionType integer constant.
Type: Number
ChartTextFrame.DirectionType property
Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.
Type: Number
ChartTextFrame.IsTextWrapped property
Gets or sets a value indicating whether the text is wrapped.
Type: boolean
ChartTextFrame.IsResizeShapeToFitText property
Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
Type: boolean
ChartTextFrame.IsInnerMode property
Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. Only for Xlsx file.
Type: boolean
ChartTextFrame.Chart property
Gets the chart to which this object belongs.
Type: Chart
ChartTextFrame.Border property
Gets the Line .
Type: Line
ChartTextFrame.Area property
Gets the area .
Type: Area
ChartTextFrame.TextFont property
Gets a Font object of the specified ChartFrame object. NOTE: This member is now obsolete. Instead, please use ChartFrame.Font property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
Type: Font
ChartTextFrame.TextOptions property
Gets and sets the options of the text.
Type: TextOptions
ChartTextFrame.Font property
Gets a Font object of the specified ChartFrame object.
Type: Font
ChartTextFrame.AutoScaleFont property
True if the text in the object changes font size when the object size changes. The default value is True.
Type: boolean
ChartTextFrame.BackgroundMode property
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
Type: Number
ChartTextFrame.Background property
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant. NOTE: This member is now obsolete. Instead, please use ChartFrame.BackgroundMode property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
Type: Number
ChartTextFrame.IsAutomaticSize property
Indicates whether the chart frame is automatic sized.
Type: boolean
ChartTextFrame.X property
Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? X In Pixels = X * Chart.ChartObject.Width / 4000;
Type: Number
ChartTextFrame.Y property
Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? Y In Pixels = Y * Chart.ChartObject.Height / 4000;
Type: Number
ChartTextFrame.Height property
Gets or sets the height of frame in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? Height In Pixels = Y * Chart.ChartObject.Height / 4000;
Type: Number
ChartTextFrame.Width property
Gets or sets the width of frame in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? Width In Pixels = Width * Chart.ChartObject.Height / 4000;
Type: Number
ChartTextFrame.Shadow property
True if the frame has a shadow.
Type: boolean
ChartTextFrame.ShapeProperties property
Gets the ShapeProperties object.
Type: ShapePropertyCollection
ChartTextFrame.IsDefaultPosBeSet property
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
Type: boolean
ChartTextFrame.DefaultX property
Represents x of default position
Type: Number
ChartTextFrame.DefaultY property
Represents y of default position
Type: Number
ChartTextFrame.DefaultWidth property
Represents width of default position
Type: Number
ChartTextFrame.DefaultHeight property
Represents height of default position
Type: Number
ChartTextFrame.DefaultXRatioToChart property
Type: Number
ChartTextFrame.DefaultYRatioToChart property
Type: Number
ChartTextFrame.DefaultWidthRatioToChart property
Type: Number
ChartTextFrame.DefaultHeightRatioToChart property
Type: Number
ChartTextFrame.XRatioToChart property
Type: Number
ChartTextFrame.YRatioToChart property
Type: Number
ChartTextFrame.WidthRatioToChart property
Type: Number
ChartTextFrame.HeightRatioToChart property
Type: Number
ChartTextFrame.XPixel property
Type: Number
ChartTextFrame.YPixel property
Type: Number
ChartTextFrame.WidthPixel property
Represents width
Type: Number
ChartTextFrame.HeightPixel property
Represents height
Type: Number
characters(startIndex, length)
Returns a Characters object that represents a range of characters within the text.
| Parameter | Type | Description |
|---|---|---|
| startIndex | Number | The index of the start of the character. |
| length | Number | The number of characters. |
Returns: Characters object.
setPositionAuto()
Set position of the frame to automatic