Aspose::Cells::Charts::IChartTextFrame Class Referenceabstract

Encapsulates the object that represents the frame object which contains text. More...

Inherits Aspose::Cells::Charts::IChartFrame.

Inherited by Aspose::Cells::Charts::IDataLabels [virtual], Aspose::Cells::Charts::IDisplayUnitLabel [virtual], Aspose::Cells::Charts::ILegend [virtual], and Aspose::Cells::Charts::ITitle [virtual].

Public Member Functions

virtual bool IsAutoText ()=0
 Indicates the text is auto generated. More...
 
virtual void SetAutoText (bool value)=0
 Indicates the text is auto generated. More...
 
virtual bool IsDeleted ()=0
 Indicates whether this data lables is deleted. More...
 
virtual void SetDeleted (bool value)=0
 Indicates whether this data lables is deleted. More...
 
virtual Aspose::Cells::TextAlignmentType GetTextHorizontalAlignment ()=0
 Gets the text horizontal alignment. More...
 
virtual void SetTextHorizontalAlignment (Aspose::Cells::TextAlignmentType value)=0
 Sets the text horizontal alignment. More...
 
virtual Aspose::Cells::TextAlignmentType GetTextVerticalAlignment ()=0
 Gets the text vertical alignment of text. More...
 
virtual void SetTextVerticalAlignment (Aspose::Cells::TextAlignmentType value)=0
 Sets the text vertical alignment of text. More...
 
virtual Aspose::Cells::Systems::Int32 GetRotationAngle ()=0
 Represents text rotation angle. More...
 
virtual void SetRotationAngle (Aspose::Cells::Systems::Int32 value)=0
 Represents text rotation angle. More...
 
virtual intrusive_ptr< Aspose::Cells::IFontSettingGetCharacters (Aspose::Cells::Systems::Int32 startIndex, Aspose::Cells::Systems::Int32 length)=0
 Returns a Characters object that represents a range of characters within the text. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetText ()=0
 Gets the text of a frame's title. More...
 
virtual void SetText (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 Sets the text of a frame's title. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetLinkedSource ()=0
 Gets a reference to the worksheet. More...
 
virtual void SetLinkedSource (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 Sets a reference to the worksheet. More...
 
virtual Aspose::Cells::TextDirectionType GetTextDirection ()=0
 Represents text reading order. More...
 
virtual void SetTextDirection (Aspose::Cells::TextDirectionType value)=0
 Represents text reading order. More...
 
virtual Aspose::Cells::TextDirectionType GetReadingOrder ()=0
 Represents text reading order. More...
 
virtual void SetReadingOrder (Aspose::Cells::TextDirectionType value)=0
 Represents text reading order. More...
 
virtual Aspose::Cells::Charts::ChartTextDirectionType GetDirectionType ()=0
 Gets the direction of text. More...
 
virtual void SetDirectionType (Aspose::Cells::Charts::ChartTextDirectionType value)=0
 Sets the direction of text. More...
 
virtual bool IsTextWrapped ()=0
 Whether the text is wrapped. More...
 
virtual void SetTextWrapped (bool value)=0
 Sets a value indicating whether the text is wrapped. More...
 
virtual bool IsResizeShapeToFitText ()=0
 Gets 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. More...
 
virtual void SetResizeShapeToFitText (bool value)=0
 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. More...
 
- Public Member Functions inherited from Aspose::Cells::Charts::IChartFrame
virtual bool IsInnerMode ()=0
 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. More...
 
virtual void SetInnerMode (bool value)=0
 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. More...
 
virtual intrusive_ptr< Aspose::Cells::Drawing::ILineGetBorderILine ()=0
 Gets the border More...
 
virtual intrusive_ptr< Aspose::Cells::Drawing::IAreaGetIArea ()=0
 Gets the area More...
 
virtual intrusive_ptr< Aspose::Cells::IFontGetTextIFont ()=0
 Gets a IFont object of the specified ChartFrame object. More...
 
virtual intrusive_ptr< Aspose::Cells::IFontGetIFont ()=0
 Gets a IFont object of the specified ChartFrame object. More...
 
virtual bool GetAutoScaleFont ()=0
 True if the text in the object changes font size when the object size changes. The default value is True. More...
 
virtual void SetAutoScaleFont (bool value)=0
 True if the text in the object changes font size when the object size changes. The default value is True. More...
 
virtual Aspose::Cells::Charts::BackgroundMode GetBackgroundMode ()=0
 Gets the display mode of the background More...
 
virtual void SetBackgroundMode (Aspose::Cells::Charts::BackgroundMode value)=0
 Sets the display mode of the background More...
 
virtual Aspose::Cells::Charts::BackgroundMode GetBackground ()=0
 Gets the display mode of the background More...
 
virtual void SetBackground (Aspose::Cells::Charts::BackgroundMode value)=0
 Sets the display mode of the background More...
 
virtual bool IsAutomaticSize ()=0
 Indicates whether the chart frame is automatic sized. More...
 
virtual void SetAutomaticSize (bool value)=0
 Indicates whether the chart frame is automatic sized. More...
 
virtual Aspose::Cells::Systems::Int32 GetX ()=0
 Gets the x coordinate of the upper left corner in units of 1/4000 of the chart area. More...
 
virtual void SetX (Aspose::Cells::Systems::Int32 value)=0
 Sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. More...
 
virtual Aspose::Cells::Systems::Int32 GetY ()=0
 Gets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
More...
 
virtual void SetY (Aspose::Cells::Systems::Int32 value)=0
 Sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
More...
 
virtual Aspose::Cells::Systems::Int32 GetHeight ()=0
 Gets the height of frame in units of 1/4000 of the chart area. More...
 
virtual void SetHeight (Aspose::Cells::Systems::Int32 value)=0
 Sets the height of frame in units of 1/4000 of the chart area. More...
 
virtual Aspose::Cells::Systems::Int32 GetWidth ()=0
 Gets the width of frame in units of 1/4000 of the chart area. More...
 
virtual void SetWidth (Aspose::Cells::Systems::Int32 value)=0
 Sets the width of frame in units of 1/4000 of the chart area. More...
 
virtual bool GetShadow ()=0
 True if the frame has a shadow. More...
 
virtual void SetShadow (bool value)=0
 True if the frame has a shadow. More...
 
virtual intrusive_ptr< Aspose::Cells::Drawing::IShapePropertyCollectionGetIShapeProperties ()=0
 Gets the IShapeProperties object. More...
 
virtual bool IsDefaultPosBeSet ()=0
 Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. More...
 
virtual Aspose::Cells::Systems::Int32 GetDefaultX ()=0
 Represents x of default position More...
 
virtual Aspose::Cells::Systems::Int32 GetDefaultY ()=0
 Represents y of default position More...
 
virtual Aspose::Cells::Systems::Int32 GetDefaultWidth ()=0
 Represents width of default position More...
 
virtual Aspose::Cells::Systems::Int32 GetDefaultHeight ()=0
 Represents height of default position More...
 
virtual void SetPositionAuto ()=0
 Set position of the frame to automatic More...
 

Detailed Description

Encapsulates the object that represents the frame object which contains text.

Member Function Documentation

◆ GetCharacters()

virtual intrusive_ptr<Aspose::Cells::IFontSetting> Aspose::Cells::Charts::IChartTextFrame::GetCharacters ( Aspose::Cells::Systems::Int32  startIndex,
Aspose::Cells::Systems::Int32  length 
)
pure virtual

Returns a Characters object that represents a range of characters within the text.

Parameters
startIndexThe index of the start of the character.
lengthThe number of characters.
Returns
Characters object.

◆ GetDirectionType()

virtual Aspose::Cells::Charts::ChartTextDirectionType Aspose::Cells::Charts::IChartTextFrame::GetDirectionType ( )
pure virtual

Gets the direction of text.

Implemented in Aspose::Cells::Charts::IDataLabels.

◆ GetLinkedSource()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Charts::IChartTextFrame::GetLinkedSource ( )
pure virtual

Gets a reference to the worksheet.

◆ GetReadingOrder()

virtual Aspose::Cells::TextDirectionType Aspose::Cells::Charts::IChartTextFrame::GetReadingOrder ( )
pure virtual

Represents text reading order.

◆ GetRotationAngle()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Charts::IChartTextFrame::GetRotationAngle ( )
pure virtual

Represents text rotation angle.


0: Not rotated.
255: Top to Bottom.
-90: Downward.
90: Upward.

◆ GetText()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Charts::IChartTextFrame::GetText ( )
pure virtual

◆ GetTextDirection()

virtual Aspose::Cells::TextDirectionType Aspose::Cells::Charts::IChartTextFrame::GetTextDirection ( )
pure virtual

Represents text reading order.

◆ GetTextHorizontalAlignment()

virtual Aspose::Cells::TextAlignmentType Aspose::Cells::Charts::IChartTextFrame::GetTextHorizontalAlignment ( )
pure virtual

Gets the text horizontal alignment.

◆ GetTextVerticalAlignment()

virtual Aspose::Cells::TextAlignmentType Aspose::Cells::Charts::IChartTextFrame::GetTextVerticalAlignment ( )
pure virtual

Gets the text vertical alignment of text.

◆ IsAutoText()

virtual bool Aspose::Cells::Charts::IChartTextFrame::IsAutoText ( )
pure virtual

Indicates the text is auto generated.

Implemented in Aspose::Cells::Charts::IDataLabels.

◆ IsDeleted()

virtual bool Aspose::Cells::Charts::IChartTextFrame::IsDeleted ( )
pure virtual

Indicates whether this data lables is deleted.

◆ IsResizeShapeToFitText()

virtual bool Aspose::Cells::Charts::IChartTextFrame::IsResizeShapeToFitText ( )
pure virtual

Gets 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.

◆ IsTextWrapped()

virtual bool Aspose::Cells::Charts::IChartTextFrame::IsTextWrapped ( )
pure virtual

Whether the text is wrapped.

Implemented in Aspose::Cells::Charts::IDataLabels.

◆ SetAutoText()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetAutoText ( bool  value)
pure virtual

Indicates the text is auto generated.

Implemented in Aspose::Cells::Charts::IDataLabels.

◆ SetDeleted()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetDeleted ( bool  value)
pure virtual

Indicates whether this data lables is deleted.

◆ SetDirectionType()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetDirectionType ( Aspose::Cells::Charts::ChartTextDirectionType  value)
pure virtual

Sets the direction of text.

Implemented in Aspose::Cells::Charts::IDataLabels.

◆ SetLinkedSource()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetLinkedSource ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

Sets a reference to the worksheet.

◆ SetReadingOrder()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetReadingOrder ( Aspose::Cells::TextDirectionType  value)
pure virtual

Represents text reading order.

◆ SetResizeShapeToFitText()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetResizeShapeToFitText ( bool  value)
pure virtual

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.

◆ SetRotationAngle()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetRotationAngle ( Aspose::Cells::Systems::Int32  value)
pure virtual

Represents text rotation angle.


0: Not rotated.
255: Top to Bottom.
-90: Downward.
90: Upward.

◆ SetText()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetText ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

◆ SetTextDirection()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetTextDirection ( Aspose::Cells::TextDirectionType  value)
pure virtual

Represents text reading order.

◆ SetTextHorizontalAlignment()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetTextHorizontalAlignment ( Aspose::Cells::TextAlignmentType  value)
pure virtual

Sets the text horizontal alignment.

◆ SetTextVerticalAlignment()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetTextVerticalAlignment ( Aspose::Cells::TextAlignmentType  value)
pure virtual

Sets the text vertical alignment of text.

◆ SetTextWrapped()

virtual void Aspose::Cells::Charts::IChartTextFrame::SetTextWrapped ( bool  value)
pure virtual

Sets a value indicating whether the text is wrapped.

Implemented in Aspose::Cells::Charts::IDataLabels.