Class SheetProtectionRecord
Summary description for SheetProtection.
Inheritance
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
[Biff]
public class SheetProtectionRecord : BiffRecordRaw, ICloneable, IBiffStorage
Constructors
SheetProtectionRecord()
Default constructor
Declaration
public SheetProtectionRecord()
SheetProtectionRecord(Int32)
Reserved for record's internal data array.
Declaration
public SheetProtectionRecord(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. |
SheetProtectionRecord(Stream, out Int32)
Read / initialize constructor.
Declaration
public SheetProtectionRecord(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
ErrorIndicatorType
Represents the Error Indicator sheet protection id.
Declaration
public const int ErrorIndicatorType = 3
Field Value
Type |
---|
System.Int32 |
Properties
ContainProtection
Indicates is record contain sheet protection.
Declaration
public bool ContainProtection { 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
MinimumRecordSize
Read-only. Minimum possible size of the record.
Declaration
public override int MinimumRecordSize { get; }
Property Value
Type |
---|
System.Int32 |
Overrides
ProtectedOptions
Represents protected options.
Declaration
public int ProtectedOptions { get; set; }
Property Value
Type |
---|
System.Int32 |
Methods
GetStoreSize(ExcelVersion)
Gets default record store size. Read-only.
Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type | Name | Description |
---|---|---|
ExcelVersion | version |
Returns
Type |
---|
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. |