Class TextObjectRecord

This record stores a text object. The TXO record is followed by two CONTINUE records. The first CONTINUE record contains the text data and the second CONTINUE contains the formatting runs. If the text box contains no text, these CONTINUE records are not written to the file.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
BiffRecordRawWithArray
TextObjectRecord
Implements
System.ICloneable
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[Biff(TBIFFRecord.TextObject)]
[CLSCompliant(false)]
public class TextObjectRecord : BiffRecordRawWithArray, ICloneable, IBiffStorage, IDisposable

Constructors

TextObjectRecord()

Default constructor

Declaration
public TextObjectRecord()

TextObjectRecord(Int32)

Reserved for record's internal data array.

Declaration
public TextObjectRecord(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.

TextObjectRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public TextObjectRecord(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

HAlignmentBitMask

Bit mask for horizontal alignment.

Declaration
public const ushort HAlignmentBitMask = 14
Field Value
Type
System.UInt16

VAlignmentBitMask

Bit mask for vertical alignment.

Declaration
public const ushort VAlignmentBitMask = 112
Field Value
Type
System.UInt16

Properties

FormattingRunsLen

Length of formatting runs (in second CONTINUE record).

Declaration
public ushort FormattingRunsLen { get; set; }
Property Value
Type
System.UInt16

HAlignment

Horizontal text alignment. This property changes bits of m_usOptions private field.

Declaration
public ExcelCommentHAlign HAlignment { get; set; }
Property Value
Type
ExcelCommentHAlign

IsLockText

Whether the Lock Text option is on.

Declaration
public bool IsLockText { get; set; }
Property Value
Type
System.Boolean

MaximumRecordSize

Read-only. Maximum possible size of the record.

Declaration
public override int MaximumRecordSize { get; }
Property Value
Type
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MaximumRecordSize

MinimumRecordSize

Read-only. Minimum possible size of the record.

Declaration
public override int MinimumRecordSize { get; }
Property Value
Type
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

Reserved1

Not used.

Declaration
public uint Reserved1 { get; }
Property Value
Type
System.UInt32

Reserved2

Not used.

Declaration
public ushort Reserved2 { get; }
Property Value
Type
System.UInt16

Reserved3

Not used.

Declaration
public uint Reserved3 { get; }
Property Value
Type
System.UInt32

Rotation

Orientation of text within the object boundary.

Declaration
public ExcelTextRotation Rotation { get; set; }
Property Value
Type
ExcelTextRotation

TextLen

Length of text (in first CONTINUE record).

Declaration
public ushort TextLen { get; set; }
Property Value
Type
System.UInt16

VAlignment

Vertical text alignment: This property changes bits of m_usOptions private field.

Declaration
public ExcelCommentVAlign VAlignment { get; set; }
Property Value
Type
ExcelCommentVAlign

Methods

ParseStructure()

Parse structure of record. Converts data buffer to special values according to record specification.

Declaration
public override void ParseStructure()
Overrides

Implements

System.ICloneable
System.IDisposable