Class ChartTickRecord
This record defines tick mark and tick label formatting.
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.ChartTick)]
[CLSCompliant(false)]
public class ChartTickRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
ChartTickRecord()
Default constructor, initializes all fields with default values.
Declaration
public ChartTickRecord()
ChartTickRecord(Int32)
Reserved for record's internal data array.
Declaration
public ChartTickRecord(int iReserve)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iReserve | Amount of bytes for data array. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | If amount of bytes requested is less than zero. |
ChartTickRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public ChartTickRecord(Stream stream, out int itemSize)
Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.Stream | stream | Stream from which record data should be read. |
| System.Int32 | itemSize | Size of read item. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | If stream is not specified. |
| System.ApplicationException | If stream does not support read or seek operations. |
Fields
DEF_FIRST_ROTATION_BIT
First bit of the rotation value.
Declaration
public const ushort DEF_FIRST_ROTATION_BIT = 2
Field Value
| Type | Description |
|---|---|
| System.UInt16 |
DEF_RECORD_SIZE
Correct size of the record.
Declaration
public const int DEF_RECORD_SIZE = 30
Field Value
| Type | Description |
|---|---|
| System.Int32 |
DEF_ROTATION_MASK
Mask for the rotation value.
Declaration
public const ushort DEF_ROTATION_MASK = 28
Field Value
| Type | Description |
|---|---|
| System.UInt16 |
Properties
BackgroundMode
Background mode.
Declaration
public ExcelChartBackgroundMode BackgroundMode { get; set; }
Property Value
| Type | Description |
|---|---|
| ExcelChartBackgroundMode |
Flags
Display flags. Read-only.
Declaration
public ushort Flags { get; }
Property Value
| Type | Description |
|---|---|
| System.UInt16 |
IsAutoRotation
Automatic rotation.
Declaration
public bool IsAutoRotation { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsAutoTextBack
Automatic text background.
Declaration
public bool IsAutoTextBack { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsAutoTextColor
Automatic text color.
Declaration
public bool IsAutoTextColor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsLeftToRight
Indicates is axis label is left to right.
Declaration
public bool IsLeftToRight { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsRightToLeft
Indicates is axis label is right to left.
Declaration
public bool IsRightToLeft { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
LabelPos
Tick label position relative to axis line.
Declaration
public ExcelTickLabelPosition LabelPos { get; set; }
Property Value
| Type | Description |
|---|---|
| ExcelTickLabelPosition |
MajorMark
Type of major tick mark.
Declaration
public ExcelTickMark MajorMark { get; set; }
Property Value
| Type | Description |
|---|---|
| ExcelTickMark |
MaximumRecordSize
Maximum possible size of the record.
Declaration
public override int MaximumRecordSize { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
Overrides
MinimumRecordSize
Minimum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
Overrides
MinorMark
Type of minor tick mark.
Declaration
public ExcelTickMark MinorMark { get; set; }
Property Value
| Type | Description |
|---|---|
| ExcelTickMark |
Rotation
Rotation.
Declaration
public TRotation Rotation { get; set; }
Property Value
| Type | Description |
|---|---|
| TRotation |
RotationAngle
Reserved; must be zero.
Declaration
public short RotationAngle { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int16 |
TextColor
Tick-label text color; RGB value, high byte = 0.
Declaration
public uint TextColor { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt32 |
TickColorIndex
Index to color of tick label.
Declaration
public ushort TickColorIndex { get; set; }
Property Value
| Type | Description |
|---|---|
| System.UInt16 |
Methods
GetStoreSize(ExcelVersion)
Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
| Type | Name | Description |
|---|---|---|
| ExcelVersion | version |
Returns
| Type | Description |
|---|---|
| System.Int32 |
Overrides
ParseStructure(DataProvider, Int32, Int32, ExcelVersion)
Parse structure of record. Convert Data buffer to special values according to record specification.
Declaration
public override void ParseStructure(DataProvider provider, int iOffset, int iLength, ExcelVersion version)
Parameters
| Type | Name | Description |
|---|---|---|
| DataProvider | provider | Object that provides access to the data. |
| System.Int32 | iOffset | Offset to the record's data. |
| System.Int32 | iLength | Length of the record's data. |
| ExcelVersion | version | Excel version used for infill. |