Aspose::Cells::Charts::IChartFrame Class Referenceabstract

Encapsulates the object that represents the frame object in a chart. More...

Inherits Object.

Inherited by Aspose::Cells::Charts::IChartArea [virtual], Aspose::Cells::Charts::IChartTextFrame [virtual], Aspose::Cells::Charts::ILegend [virtual], and Aspose::Cells::Charts::IPlotArea [virtual].

Public Member Functions

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 IShapePropertyCollection 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 in a chart.

Member Function Documentation

◆ GetAutoScaleFont()

virtual bool Aspose::Cells::Charts::IChartFrame::GetAutoScaleFont ( )
pure virtual

True if the text in the object changes font size when the object size changes. The default value is True.

Implemented in Aspose::Cells::Charts::IDisplayUnitLabel.

◆ GetBackground()

virtual Aspose::Cells::Charts::BackgroundMode Aspose::Cells::Charts::IChartFrame::GetBackground ( )
pure virtual

Gets the display mode of the background

NOTE: This member is now obsolete. Instead, please use GetBackgroundMode() mehtod.

◆ GetBackgroundMode()

virtual Aspose::Cells::Charts::BackgroundMode Aspose::Cells::Charts::IChartFrame::GetBackgroundMode ( )
pure virtual

Gets the display mode of the background

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

◆ GetBorderILine()

virtual intrusive_ptr<Aspose::Cells::Drawing::ILine> Aspose::Cells::Charts::IChartFrame::GetBorderILine ( )
pure virtual

Gets the border

◆ GetDefaultHeight()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Charts::IChartFrame::GetDefaultHeight ( )
pure virtual

Represents height of default position

◆ GetDefaultWidth()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Charts::IChartFrame::GetDefaultWidth ( )
pure virtual

Represents width of default position

◆ GetDefaultX()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Charts::IChartFrame::GetDefaultX ( )
pure virtual

Represents x of default position

◆ GetDefaultY()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Charts::IChartFrame::GetDefaultY ( )
pure virtual

Represents y of default position

◆ GetHeight()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Charts::IChartFrame::GetHeight ( )
pure virtual

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

Implemented in Aspose::Cells::Charts::IPlotArea, and Aspose::Cells::Charts::IChartArea.

◆ GetIArea()

virtual intrusive_ptr<Aspose::Cells::Drawing::IArea> Aspose::Cells::Charts::IChartFrame::GetIArea ( )
pure virtual

Gets the area

◆ GetIFont()

virtual intrusive_ptr<Aspose::Cells::IFont> Aspose::Cells::Charts::IChartFrame::GetIFont ( )
pure virtual

Gets a IFont object of the specified ChartFrame object.

Implemented in Aspose::Cells::Charts::IDataLabels, Aspose::Cells::Charts::IChartArea, and Aspose::Cells::Charts::IDisplayUnitLabel.

◆ GetIShapeProperties()

virtual intrusive_ptr<Aspose::Cells::Drawing::IShapePropertyCollection> Aspose::Cells::Charts::IChartFrame::GetIShapeProperties ( )
pure virtual

Gets the IShapePropertyCollection object.

◆ GetShadow()

virtual bool Aspose::Cells::Charts::IChartFrame::GetShadow ( )
pure virtual

True if the frame has a shadow.

◆ GetTextIFont()

virtual intrusive_ptr<Aspose::Cells::IFont> Aspose::Cells::Charts::IChartFrame::GetTextIFont ( )
pure virtual

Gets a IFont object of the specified ChartFrame object.

NOTE: This member is now obsolete. Instead, please use GetIFont method.

◆ GetWidth()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Charts::IChartFrame::GetWidth ( )
pure virtual

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

Implemented in Aspose::Cells::Charts::IPlotArea, and Aspose::Cells::Charts::IChartArea.

◆ GetX()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Charts::IChartFrame::GetX ( )
pure virtual

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

Implemented in Aspose::Cells::Charts::IChartArea, Aspose::Cells::Charts::IPlotArea, and Aspose::Cells::Charts::ITitle.

◆ GetY()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Charts::IChartFrame::GetY ( )
pure virtual

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

Implemented in Aspose::Cells::Charts::IPlotArea, Aspose::Cells::Charts::IChartArea, and Aspose::Cells::Charts::ITitle.

◆ IsAutomaticSize()

virtual bool Aspose::Cells::Charts::IChartFrame::IsAutomaticSize ( )
pure virtual

Indicates whether the chart frame is automatic sized.

◆ IsDefaultPosBeSet()

virtual bool Aspose::Cells::Charts::IChartFrame::IsDefaultPosBeSet ( )
pure virtual

Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.

◆ IsInnerMode()

virtual bool Aspose::Cells::Charts::IChartFrame::IsInnerMode ( )
pure virtual

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.

◆ SetAutomaticSize()

virtual void Aspose::Cells::Charts::IChartFrame::SetAutomaticSize ( bool  value)
pure virtual

Indicates whether the chart frame is automatic sized.

◆ SetAutoScaleFont()

virtual void Aspose::Cells::Charts::IChartFrame::SetAutoScaleFont ( bool  value)
pure virtual

True if the text in the object changes font size when the object size changes. The default value is True.

Implemented in Aspose::Cells::Charts::IDisplayUnitLabel.

◆ SetBackground()

virtual void Aspose::Cells::Charts::IChartFrame::SetBackground ( Aspose::Cells::Charts::BackgroundMode  value)
pure virtual

Sets the display mode of the background

NOTE: This member is now obsolete. Instead, please use GetBackgroundMode() mehtod.

◆ SetBackgroundMode()

virtual void Aspose::Cells::Charts::IChartFrame::SetBackgroundMode ( Aspose::Cells::Charts::BackgroundMode  value)
pure virtual

Sets the display mode of the background

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

◆ SetHeight()

virtual void Aspose::Cells::Charts::IChartFrame::SetHeight ( Aspose::Cells::Systems::Int32  value)
pure virtual

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;

Implemented in Aspose::Cells::Charts::IPlotArea, and Aspose::Cells::Charts::IChartArea.

◆ SetInnerMode()

virtual void Aspose::Cells::Charts::IChartFrame::SetInnerMode ( bool  value)
pure virtual

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.

◆ SetPositionAuto()

virtual void Aspose::Cells::Charts::IChartFrame::SetPositionAuto ( )
pure virtual

Set position of the frame to automatic

Implemented in Aspose::Cells::Charts::IPlotArea.

◆ SetShadow()

virtual void Aspose::Cells::Charts::IChartFrame::SetShadow ( bool  value)
pure virtual

True if the frame has a shadow.

◆ SetWidth()

virtual void Aspose::Cells::Charts::IChartFrame::SetWidth ( Aspose::Cells::Systems::Int32  value)
pure virtual

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;

Implemented in Aspose::Cells::Charts::IPlotArea, and Aspose::Cells::Charts::IChartArea.

◆ SetX()

virtual void Aspose::Cells::Charts::IChartFrame::SetX ( Aspose::Cells::Systems::Int32  value)
pure virtual

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;

Implemented in Aspose::Cells::Charts::IChartArea, Aspose::Cells::Charts::IPlotArea, and Aspose::Cells::Charts::ITitle.

◆ SetY()

virtual void Aspose::Cells::Charts::IChartFrame::SetY ( Aspose::Cells::Systems::Int32  value)
pure virtual

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;

Implemented in Aspose::Cells::Charts::IPlotArea, Aspose::Cells::Charts::IChartArea, and Aspose::Cells::Charts::ITitle.