Class RStringRecord
This record stores a formatted text cell (Rich-Text). In BIFF8 it is replaced by the LABELSST record. Nevertheless, Excel uses this record if it copies formatted text cells to the clipboard.
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[CLSCompliant(false)]
[Biff(TBIFFRecord.RString)]
public class RStringRecord : BiffRecordRawWithArray, ICloneable, IBiffStorage, IDisposable, ICellPositionFormat, IStringValue
Constructors
RStringRecord()
Default constructor fills all data with default values.
Declaration
public RStringRecord()
RStringRecord(Int32)
Reserved for record's internal data array.
Declaration
public RStringRecord(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. |
RStringRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public RStringRecord(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. |
Properties
Column
Index to column.
Declaration
public int Column { get; set; }
Property Value
Type |
---|
System.Int32 |
ExtendedFormatIndex
Index to XF (Extended Format) record.
Declaration
public ushort ExtendedFormatIndex { get; set; }
Property Value
Type |
---|
System.UInt16 |
FormattingRun
Array of formatting runs.
Declaration
public RStringRecord.TFormattingRun[] FormattingRun { get; set; }
Property Value
Type |
---|
RStringRecord.TFormattingRun[] |
MinimumRecordSize
Read-only. Returns minimum possible size of record's internal data array.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
Row
Index to row.
Declaration
public int Row { get; set; }
Property Value
Type |
---|
System.Int32 |
Value
Unformatted Unicode string, 16-bit string length.
Declaration
public string Value { get; set; }
Property Value
Type |
---|
System.String |
Methods
ParseStructure()
Parse structure of record. Converts data buffer to special values according to record specification.
Declaration
public override void ParseStructure()
Overrides
Explicit Interface Implementations
IStringValue.StringValue
Returns string value. Read-only.
Declaration
string IStringValue.StringValue { get; }
Returns
Type |
---|
System.String |