DisplayUnitLabel

DisplayUnitLabel class

Represents the display unit label.

Properties

NameTypeDescription
TextStringGets or sets the text of display unit label.
FontFontGets a Font object of the specified ChartFrame object.
AutoScaleFontbooleanTrue if the text in the object changes font size when the object size changes. The default value is True.
IsAutoTextbooleanIndicates the text is auto generated.
IsDeletedbooleanIndicates whether this data labels is deleted.
TextHorizontalAlignmentintGets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
TextVerticalAlignmentintGets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
RotationAngleintRepresents text rotation angle. 0: Not rotated. 255: Top to Bottom. -90: Downward. 90: Upward.
IsAutomaticRotationbooleanIndicates whether the text of the chart is automatically rotated.
LinkedSourceStringGets and sets a reference to the worksheet.
TextDirectionintRepresents text reading order. The value of the property is TextDirectionType integer constant. NOTE: This member is now
ReadingOrderintRepresents text reading order. The value of the property is TextDirectionType integer constant.
DirectionTypeintGets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.
IsTextWrappedbooleanGets or sets a value indicating whether the text is wrapped.
IsResizeShapeToFitTextbooleanGets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text
IsInnerModebooleanIndicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the
ChartChartGets the chart to which this object belongs.
BorderLineGets the Line .
AreaAreaGets the area .
TextFontFontGets a Font object of the specified ChartFrame object. NOTE: This member is now obsolete. Instead, please use ChartFrame
TextOptionsTextOptionsGets and sets the options of the text.
BackgroundModeintGets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
BackgroundintGets and sets the display mode of the background The value of the property is BackgroundMode integer constant. NOTE: Thi
IsAutomaticSizebooleanIndicates whether the chart frame is automatic sized.
XintGets 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
YintGets 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
HeightintGets 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
WidthintGets 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
ShadowbooleanTrue if the frame has a shadow.
ShapePropertiesShapePropertyCollectionGets the ShapeProperties object.
IsDefaultPosBeSetbooleanIndicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
DefaultXintRepresents x of default position
DefaultYintRepresents y of default position
DefaultWidthintRepresents width of default position
DefaultHeightintRepresents height of default position
DefaultXRatioToChartfloat
DefaultYRatioToChartfloat
DefaultWidthRatioToChartfloat
DefaultHeightRatioToChartfloat
XRatioToChartfloat
YRatioToChartfloat
WidthRatioToChartfloat
HeightRatioToChartfloat
XPixelint
YPixelint
WidthPixelintRepresents width
HeightPixelintRepresents height

Methods

NameDescription
charactersReturns a Characters object that represents a range of characters within the text.
setPositionAutoSet position of the frame to automatic

DisplayUnitLabel.Text property

Gets or sets the text of display unit label.

Type: String

DisplayUnitLabel.Font property

Gets a Font object of the specified ChartFrame object.

Type: Font

DisplayUnitLabel.AutoScaleFont property

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

Type: boolean

DisplayUnitLabel.IsAutoText property

Indicates the text is auto generated.

Type: boolean

DisplayUnitLabel.IsDeleted property

Indicates whether this data labels is deleted.

Type: boolean

DisplayUnitLabel.TextHorizontalAlignment property

Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.

Type: int

DisplayUnitLabel.TextVerticalAlignment property

Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.

Type: int

DisplayUnitLabel.RotationAngle property

Represents text rotation angle. 0: Not rotated. 255: Top to Bottom. -90: Downward. 90: Upward.

Type: int

DisplayUnitLabel.IsAutomaticRotation property

Indicates whether the text of the chart is automatically rotated.

Type: boolean

DisplayUnitLabel.LinkedSource property

Gets and sets a reference to the worksheet.

Type: String

DisplayUnitLabel.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: int

DisplayUnitLabel.ReadingOrder property

Represents text reading order. The value of the property is TextDirectionType integer constant.

Type: int

DisplayUnitLabel.DirectionType property

Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.

Type: int

DisplayUnitLabel.IsTextWrapped property

Gets or sets a value indicating whether the text is wrapped.

Type: boolean

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

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

DisplayUnitLabel.Chart property

Gets the chart to which this object belongs.

Type: Chart

DisplayUnitLabel.Border property

Gets the Line .

Type: Line

DisplayUnitLabel.Area property

Gets the area .

Type: Area

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

DisplayUnitLabel.TextOptions property

Gets and sets the options of the text.

Type: TextOptions

DisplayUnitLabel.BackgroundMode property

Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.

Type: int

DisplayUnitLabel.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: int

DisplayUnitLabel.IsAutomaticSize property

Indicates whether the chart frame is automatic sized.

Type: boolean

DisplayUnitLabel.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: int

DisplayUnitLabel.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: int

DisplayUnitLabel.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: int

DisplayUnitLabel.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: int

DisplayUnitLabel.Shadow property

True if the frame has a shadow.

Type: boolean

DisplayUnitLabel.ShapeProperties property

Gets the ShapeProperties object.

Type: ShapePropertyCollection

DisplayUnitLabel.IsDefaultPosBeSet property

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

Type: boolean

DisplayUnitLabel.DefaultX property

Represents x of default position

Type: int

DisplayUnitLabel.DefaultY property

Represents y of default position

Type: int

DisplayUnitLabel.DefaultWidth property

Represents width of default position

Type: int

DisplayUnitLabel.DefaultHeight property

Represents height of default position

Type: int

DisplayUnitLabel.DefaultXRatioToChart property

Type: float

DisplayUnitLabel.DefaultYRatioToChart property

Type: float

DisplayUnitLabel.DefaultWidthRatioToChart property

Type: float

DisplayUnitLabel.DefaultHeightRatioToChart property

Type: float

DisplayUnitLabel.XRatioToChart property

Type: float

DisplayUnitLabel.YRatioToChart property

Type: float

DisplayUnitLabel.WidthRatioToChart property

Type: float

DisplayUnitLabel.HeightRatioToChart property

Type: float

DisplayUnitLabel.XPixel property

Type: int

DisplayUnitLabel.YPixel property

Type: int

DisplayUnitLabel.WidthPixel property

Represents width

Type: int

DisplayUnitLabel.HeightPixel property

Represents height

Type: int

characters(startIndex, length)

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

ParameterTypeDescription
startIndexintThe index of the start of the character.
lengthintThe number of characters.

Returns: Characters object.

setPositionAuto()

Set position of the frame to automatic