Class ChartPicfRecord
This record defines the format for a picture attached to a data series or point.
Inheritance
Inherited Members
Namespace: Syncfusion.XlsIO.Parser.Biff_Records.Charts
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[CLSCompliant(false)]
[Biff(TBIFFRecord.ChartPicf)]
public class ChartPicfRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
ChartPicfRecord()
Default constructor, initializes all fields with default values.
Declaration
public ChartPicfRecord()
ChartPicfRecord(Int32)
Reserved for record's internal data array.
Declaration
public ChartPicfRecord(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. |
ChartPicfRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public ChartPicfRecord(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
DefaultRecordSize
Correct size of the record.
Declaration
public const int DefaultRecordSize = 14
Field Value
Type |
---|
System.Int32 |
Properties
Environment
Environment from which the file was written.
Declaration
public ChartPicfRecord.TEnvironment Environment { get; set; }
Property Value
Type |
---|
ChartPicfRecord.TEnvironment |
ImageFormat
Image format.
Declaration
public ChartPicfRecord.TImageFormat ImageFormat { get; set; }
Property Value
Type |
---|
ChartPicfRecord.TImageFormat |
IsFormatOnly
Formatting only; no picture attached.
Declaration
public bool IsFormatOnly { get; set; }
Property Value
Type |
---|
System.Boolean |
IsPictureBackFront
Picture is attached to back and front of column.
Declaration
public bool IsPictureBackFront { get; set; }
Property Value
Type |
---|
System.Boolean |
IsPictureSides
Picture is attached to sides of column.
Declaration
public bool IsPictureSides { get; set; }
Property Value
Type |
---|
System.Boolean |
IsPictureTopBottom
Picture is attached to top and bottom of column.
Declaration
public bool IsPictureTopBottom { get; set; }
Property Value
Type |
---|
System.Boolean |
MaximumRecordSize
Maximum possible size of the record.
Declaration
public override int MaximumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
MinimumRecordSize
Minimum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
Options
Option flags. Read-only.
Declaration
public byte Options { get; }
Property Value
Type |
---|
System.Byte |
PictureType
Picture type.
Declaration
public ChartPicfRecord.TPicture PictureType { get; set; }
Property Value
Type |
---|
ChartPicfRecord.TPicture |
Scale
Scaling value for pictures, units/picture (IEEE floating-point number).
Declaration
public double Scale { get; set; }
Property Value
Type |
---|
System.Double |
Methods
ParseStructure(DataProvider, Int32, Int32, ExcelVersion)
Parse structure of record. Converts 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. |