menu

Xamarin.Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class WorksheetBaseImpl - Xamarin.Forms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class WorksheetBaseImpl

    Base class for all worksheet objects (objects that have own tab in the workbook) like worksheets and charts.

    Inheritance
    System.Object
    CommonObject
    WorksheetBaseImpl
    ChartImpl
    WorksheetImpl
    Implements
    System.IDisposable
    INamedObject
    IParseable
    ITabSheet
    IParentApplication
    ICloneParent
    Inherited Members
    CommonObject.AddReference()
    CommonObject.AppImplementation
    CommonObject.Application
    CommonObject.CheckDisposed()
    CommonObject.Finalize()
    CommonObject.FindParent(Object, Type)
    CommonObject.FindParent(Object, Type, Boolean)
    CommonObject.FindParent(Type)
    CommonObject.FindParent(Type, Boolean)
    CommonObject.FindParent(Type[])
    CommonObject.FindParents(Type[])
    CommonObject.m_bIsDisposed
    CommonObject.OnDispose()
    CommonObject.Parent
    CommonObject.ReferenceCount
    CommonObject.ReleaseReference()
    CommonObject.SetParent(Object)
    Namespace: Syncfusion.XlsIO.Implementation
    Assembly: Syncfusion.XlsIO.Portable.dll
    Syntax
    public abstract class WorksheetBaseImpl : CommonObject, IDisposable, INamedObject, IParseable, ITabSheet, IParentApplication, ICloneParent

    Constructors

    WorksheetBaseImpl(IApplication, Object)

    Initializes new instance and sets its application and parent properties.

    Declaration
    public WorksheetBaseImpl(IApplication application, object parent)
    Parameters
    Type Name Description
    IApplication application

    Application object for the new instance.

    System.Object parent

    Parent object for the new instance.

    WorksheetBaseImpl(IApplication, Object, BiffReader, ExcelParseOptions, Boolean, Dictionary<Int32, Int32>, IDecryptor)

    Initializes new instance and sets its application and parent properties.

    Declaration
    public WorksheetBaseImpl(IApplication application, object parent, BiffReader reader, ExcelParseOptions options, bool bSkipParsing, Dictionary<int, int> hashNewXFormatIndexes, IDecryptor decryptor)
    Parameters
    Type Name Description
    IApplication application

    Application object for the new instance.

    System.Object parent

    Parent object for the new instance.

    BiffReader reader

    BiffReader to extract data from.

    ExcelParseOptions options

    Parse options.

    System.Boolean bSkipParsing

    Indicates whether to skip parsing.

    System.Collections.Generic.Dictionary<System.Int32, System.Int32> hashNewXFormatIndexes

    Dictionary with new extended format indexes for ignore styles mode.

    IDecryptor decryptor

    Object used to decrypt encrypted records.

    Fields

    DEF_DEFAULT_TAB_COLOR

    Default tab color.

    Declaration
    public const ExcelKnownColors DEF_DEFAULT_TAB_COLOR
    Field Value
    Type
    ExcelKnownColors

    DEF_MAX_COLUMN_ONE_INDEX

    Maximum one-based index of the column.

    Declaration
    public const int DEF_MAX_COLUMN_ONE_INDEX = 256
    Field Value
    Type
    System.Int32

    DEF_MAX_PASSWORDLEN

    Maximum length of the password.

    Declaration
    public const int DEF_MAX_PASSWORDLEN = 255
    Field Value
    Type
    System.Int32

    DEF_MAX_ROW_ONE_INDEX

    Maximum one-based index of the row.

    Declaration
    public const int DEF_MAX_ROW_ONE_INDEX = 65536
    Field Value
    Type
    System.Int32

    DEF_MIN_COLUMN_INDEX

    Min column index.

    Declaration
    public const int DEF_MIN_COLUMN_INDEX = 2147483647
    Field Value
    Type
    System.Int32

    DEF_MIN_ROW_INDEX

    Min row index.

    Declaration
    public const int DEF_MIN_ROW_INDEX = -1
    Field Value
    Type
    System.Int32

    KeepRecord

    Indicates whether to keep record inside of internal storage.

    Declaration
    protected bool KeepRecord
    Field Value
    Type
    System.Boolean

    m_arrRecords

    List in which all records which belong to worksheet are stored.

    Declaration
    protected List<BiffRecordRaw> m_arrRecords
    Field Value
    Type
    System.Collections.Generic.List<Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw>

    m_book

    Parent workbook.

    Declaration
    protected WorkbookImpl m_book
    Field Value
    Type
    WorkbookImpl

    m_dataHolder

    Data holder for 2007 Excel.

    Declaration
    protected WorksheetDataHolder m_dataHolder
    Field Value
    Type
    WorksheetDataHolder

    m_errorIndicators

    Collection of worksheet's error indicators.

    Declaration
    protected ErrorIndicatorsCollection m_errorIndicators
    Field Value
    Type
    ErrorIndicatorsCollection

    m_iFirstColumn

    One field from Worksheet dimension records.

    Declaration
    protected int m_iFirstColumn
    Field Value
    Type
    System.Int32

    m_iFirstRow

    One field from Worksheet dimension records.

    Declaration
    protected int m_iFirstRow
    Field Value
    Type
    System.Int32

    m_iLastColumn

    One field from Worksheet dimension records.

    Declaration
    protected int m_iLastColumn
    Field Value
    Type
    System.Int32

    m_iLastRow

    One field from Worksheet dimension records

    Declaration
    protected int m_iLastRow
    Field Value
    Type
    System.Int32

    m_iMsoStartIndex

    Starting index for Mso record.

    Declaration
    protected int m_iMsoStartIndex
    Field Value
    Type
    System.Int32

    m_isCustomHeight

    Custom height

    Declaration
    protected bool m_isCustomHeight
    Field Value
    Type
    System.Boolean

    m_parseOptions

    Parse options.

    Declaration
    protected ExcelParseOptions m_parseOptions
    Field Value
    Type
    ExcelParseOptions

    m_rangeProtectionRecord

    Represents Range Protection Record

    Declaration
    protected RangeProtectionRecord m_rangeProtectionRecord
    Field Value
    Type
    RangeProtectionRecord

    m_strCodeName

    Code name.

    Declaration
    protected string m_strCodeName
    Field Value
    Type
    System.String

    Properties

    AlgorithmName

    Alogrithm name to protect/unprotect worksheet.

    Declaration
    public string AlgorithmName { get; set; }
    Property Value
    Type
    System.String

    Charts

    Gets charts collection in the worksheet. Read-only.

    Declaration
    public IChartShapes Charts { get; }
    Property Value
    Type
    IChartShapes

    CheckBoxes

    Gets inner checkboxes collection in the sheet. Read-only.

    Declaration
    public ICheckBoxes CheckBoxes { get; }
    Property Value
    Type
    ICheckBoxes

    CodeName

    Name used by macros to access workbook items. Read-only.

    Declaration
    public string CodeName { get; }
    Property Value
    Type
    System.String

    ComboBoxes

    Gets inner combo boxes collection in the sheet. Read-only.

    Declaration
    public IComboBoxes ComboBoxes { get; }
    Property Value
    Type
    IComboBoxes

    Comments

    Gets a Comments collection that represents all the comments for the worksheet.

    Declaration
    public IComments Comments { get; }
    Property Value
    Type
    IComments

    ContainsProtection

    Inidicates whether protection should be serialized.

    Declaration
    protected virtual bool ContainsProtection { get; }
    Property Value
    Type
    System.Boolean

    DefaultGridlineColor

    Indicates whether gridline color has default value.

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

    DefaultProtectionOptions

    Gets default protection options for the worksheet.

    Declaration
    protected abstract ExcelSheetProtection DefaultProtectionOptions { get; }
    Property Value
    Type
    ExcelSheetProtection

    FirstColumn

    Gets or sets one-based index of the first column of the worksheet.

    Declaration
    public virtual int FirstColumn { get; set; }
    Property Value
    Type
    System.Int32

    FirstRow

    Gets or sets one-based index of the first row of the worksheet.

    Declaration
    public virtual int FirstRow { get; set; }
    Property Value
    Type
    System.Int32

    GridLineColor

    Gets or sets the color of the Grid line in the worksheet.

    Declaration
    public ExcelKnownColors GridLineColor { get; set; }
    Property Value
    Type
    ExcelKnownColors

    HasCharts

    Indicates whether tabsheet has charts. Read-only.

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

    HashValue

    Hash value to ensure the sheet protected password.

    Declaration
    public byte[] HashValue { get; set; }
    Property Value
    Type
    System.Byte[]

    HasPictures

    Indicates whether tabsheet contains any picture. Read-only.

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

    HasVmlShapes

    Indicates whether worksheet has vml shapes. Read-only.

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

    HeaderFooterShapes

    Header / footer shapes collection.

    Declaration
    public HeaderFooterShapeCollection HeaderFooterShapes { get; }
    Property Value
    Type
    HeaderFooterShapeCollection

    Index

    Gets the index number of the worksheet within the collection of worksheet. Read-only.

    Declaration
    public int Index { get; set; }
    Property Value
    Type
    System.Int32

    InnerCharts

    Returns embedded charts collection. Read-only.

    Declaration
    protected WorksheetChartsCollection InnerCharts { get; }
    Property Value
    Type
    WorksheetChartsCollection

    InnerCheckBoxes

    Returns checkboxes collection for this sheet. Read-only.

    Declaration
    protected CheckBoxCollection InnerCheckBoxes { get; }
    Property Value
    Type
    CheckBoxCollection

    InnerComments

    Returns comments collection for this worksheet. Read-only.

    Declaration
    protected CommentsCollection InnerComments { get; }
    Property Value
    Type
    CommentsCollection

    InnerHeaderFooterShapes

    Header / footer shapes collection.

    Declaration
    public HeaderFooterShapeCollection InnerHeaderFooterShapes { get; }
    Property Value
    Type
    HeaderFooterShapeCollection

    InnerPictures

    Returns pictures collection. Read-only.

    Declaration
    protected PicturesCollection InnerPictures { get; }
    Property Value
    Type
    PicturesCollection

    InnerProtection

    Gets protected options. Read-only. For sets protection options use "Protect" method.

    Declaration
    protected virtual ExcelSheetProtection InnerProtection { get; }
    Property Value
    Type
    ExcelSheetProtection

    InnerShapes

    Returns shapes collection. Read-only.

    Declaration
    protected ShapesCollection InnerShapes { get; }
    Property Value
    Type
    ShapesCollection

    InnerShapesBase

    Returns InnerShapes base collection.

    Declaration
    public ShapeCollectionBase InnerShapesBase { get; }
    Property Value
    Type
    ShapeCollectionBase

    IsParsed

    Indicates whether object was parsed.

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

    IsParsing

    Indicates whether object is currently being parsed.

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

    IsPasswordProtected

    Gets a value indicating whether worksheet is protected with password.

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

    IsRightToLeft

    Indicates whether worksheet is displayed right to left.

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

    IsSaved

    Indicates whether worksheet was saved.

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

    IsSelected

    Indicates whether tab of this sheet is selected. Read-only.

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

    IsSkipParsing

    Indicates whether worksheet was opened in skip parsing mode. Read-only.

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

    IsSupported

    Indicates whether worksheet type is supported. Read-only.

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

    IsTransitionEvaluation

    Gets or sets IsTransitionEvaluation

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

    LastColumn

    Gets or sets one-based index of the last column of the worksheet.

    Declaration
    public virtual int LastColumn { get; set; }
    Property Value
    Type
    System.Int32

    LastRow

    Gets or sets one-based index of the last row of the worksheet.

    Declaration
    public virtual int LastRow { get; set; }
    Property Value
    Type
    System.Int32

    LeftVisibleColumn

    Gets or sets the left visible column of the worksheet.

    Declaration
    public int LeftVisibleColumn { get; set; }
    Property Value
    Type
    System.Int32

    Name

    Returns or sets the name of the object. Read / write String.

    Declaration
    public string Name { get; set; }
    Property Value
    Type
    System.String

    OptionButtons

    Gets inner option buttons collection in the sheet. Read-only.

    Declaration
    public IOptionButtons OptionButtons { get; }
    Property Value
    Type
    IOptionButtons

    PageSetupBase

    Return page setup. Read-only.

    Declaration
    public abstract PageSetupBaseImpl PageSetupBase { get; }
    Property Value
    Type
    PageSetupBaseImpl

    ParentWorkbook

    Gets parent workbook. Read-only.

    Declaration
    public WorkbookImpl ParentWorkbook { get; }
    Property Value
    Type
    WorkbookImpl

    ParseOnDemand

    Gets or Sets a boolean value to parse worksheets on demand

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

    Pictures

    Gets pictures collection in the worksheet. Read-only.

    Declaration
    public IPictures Pictures { get; }
    Property Value
    Type
    IPictures

    ProtectContents

    Indicates is current sheet is protected.

    Declaration
    public virtual bool ProtectContents { get; }
    Property Value
    Type
    System.Boolean

    ProtectDrawingObjects

    True if objects are protected. Read-only.

    Declaration
    public virtual bool ProtectDrawingObjects { get; }
    Property Value
    Type
    System.Boolean

    Protection

    Gets protected options. Read-only. To set protection options use "Protect" method.

    Declaration
    public virtual ExcelSheetProtection Protection { get; }
    Property Value
    Type
    ExcelSheetProtection

    ProtectScenarios

    True if the scenarios of the current sheet are protected. Read-only.

    Declaration
    public virtual bool ProtectScenarios { get; }
    Property Value
    Type
    System.Boolean

    RealIndex

    Index of the worksheet in the workbook (not necessary in Worksheets collection)

    Declaration
    public int RealIndex { get; set; }
    Property Value
    Type
    System.Int32

    SaltValue

    Random generated Salt for the sheet password.

    Declaration
    public byte[] SaltValue { get; set; }
    Property Value
    Type
    System.Byte[]

    Shapes

    Gets shape collection in the worksheet.

    Declaration
    public IShapes Shapes { get; }
    Property Value
    Type
    IShapes

    SheetProtection

    Returns sheet protection record.

    Declaration
    protected SheetProtectionRecord SheetProtection { get; }
    Property Value
    Type
    SheetProtectionRecord

    SpinCount

    Spin count to loop the hash algorithm.

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

    TabColor

    Gets or Sets Tab color.

    Declaration
    public virtual ExcelKnownColors TabColor { get; set; }
    Property Value
    Type
    ExcelKnownColors

    TabColorObject

    Gets Tab color object.

    Declaration
    public virtual ColorObject TabColorObject { get; }
    Property Value
    Type
    ColorObject

    TabColorRGB

    Gets or Sets Tab color RGB.

    Declaration
    public virtual Color TabColorRGB { get; set; }
    Property Value
    Type
    Color

    TextBoxes

    Gets inner textboxes collection. Read-only.

    Declaration
    public ITextBoxes TextBoxes { get; }
    Property Value
    Type
    ITextBoxes

    TopVisibleRow

    Gets or sets the top visible row of the worksheet.

    Declaration
    public int TopVisibleRow { get; set; }
    Property Value
    Type
    System.Int32

    TypedCheckBoxes

    Returns inner checkboxes collection. Read-only.

    Declaration
    public CheckBoxCollection TypedCheckBoxes { get; }
    Property Value
    Type
    CheckBoxCollection

    TypedComboBoxes

    Returns inner comboboxes collection. Read-only.

    Declaration
    public ComboBoxCollection TypedComboBoxes { get; }
    Property Value
    Type
    ComboBoxCollection

    TypedOptionButtons

    Returns inner checkboxes collection. Read-only.

    Declaration
    public OptionButtonCollection TypedOptionButtons { get; }
    Property Value
    Type
    OptionButtonCollection

    TypedTextBoxes

    Gets inner textboxes collection. Read-only.

    Declaration
    public TextBoxCollection TypedTextBoxes { get; }
    Property Value
    Type
    TextBoxCollection

    UnknownVmlShapes

    Indicates whether worksheet contains some unknown vml shapes.

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

    UnprotectedOptions

    Returnd unprotected options

    Declaration
    protected virtual ExcelSheetProtection UnprotectedOptions { get; }
    Property Value
    Type
    ExcelSheetProtection

    Visibility

    Controls end user visibility of worksheet.

    Declaration
    public WorksheetVisibility Visibility { get; set; }
    Property Value
    Type
    WorksheetVisibility

    VmlShapesCount

    Returns number of known vml shapes. Read-only.

    Declaration
    public int VmlShapesCount { get; }
    Property Value
    Type
    System.Int32

    WindowTwo

    Sheet window settings.

    Declaration
    public WindowTwoRecord WindowTwo { get; }
    Property Value
    Type
    WindowTwoRecord

    Workbook

    Get parent workbook of current worksheet.

    Declaration
    public IWorkbook Workbook { get; }
    Property Value
    Type
    IWorkbook

    Zoom

    Gets or sets the value that represents zoom factor of document. Value must be in range from 10 till 400.

    Declaration
    public int Zoom { get; set; }
    Property Value
    Type
    System.Int32

    Methods

    Activate()

    Makes the current sheet the active sheet.

    Declaration
    public virtual void Activate()
    Remarks

    Calling this method is equivalent to clicking the sheet's tab in MS Excel.

    add_NameChanged(ValueChangedEventHandler)

    Declaration
    public void add_NameChanged(ValueChangedEventHandler value)
    Parameters
    Type Name Description
    Syncfusion.XlsIO.Implementation.ValueChangedEventHandler value

    ClearAll(ExcelWorksheetCopyFlags)

    Clear all internal collections but excluding mentioned flags.

    Declaration
    protected virtual void ClearAll(ExcelWorksheetCopyFlags flags)
    Parameters
    Type Name Description
    ExcelWorksheetCopyFlags flags

    Allows to avoid clearing of some properties.

    Clone(Object)

    Creates copy of the current object.

    Declaration
    public virtual object Clone(object parent)
    Parameters
    Type Name Description
    System.Object parent

    Parent object for the new object.

    Returns
    Type Description
    System.Object

    Copy of the current object.

    Clone(Object, Boolean)

    Creates copy of the current object and indicates whether we should copy the shapes or not.

    Declaration
    public virtual object Clone(object parent, bool cloneShapes)
    Parameters
    Type Name Description
    System.Object parent

    Parent object for the new object.

    System.Boolean cloneShapes

    Indicates whether we should clone shapes or not.

    Returns
    Type Description
    System.Object

    Copy of the current object and indicates whether we should copy the shapes or not

    CloneShapes(WorksheetBaseImpl)

    Create copy of the shapes collection inside specified worksheet object.

    Declaration
    public void CloneShapes(WorksheetBaseImpl result)
    Parameters
    Type Name Description
    WorksheetBaseImpl result

    Object to put shapes into.

    CombineArrays(Int32, List<Byte[]>)

    Combines several byte arrays into one.

    Declaration
    public static byte[] CombineArrays(int iCombinedLength, List<byte[]> arrCombined)
    Parameters
    Type Name Description
    System.Int32 iCombinedLength

    Size of the combined data.

    System.Collections.Generic.List<System.Byte[]> arrCombined

    List that contains byte arrays to combine.

    Returns
    Type Description
    System.Byte[]

    Combined array.

    CopyFrom(WorksheetBaseImpl, Dictionary<String, String>, Dictionary<String, String>, Dictionary<Int32, Int32>, ExcelWorksheetCopyFlags, Dictionary<Int32, Int32>)

    Copies all data from another worksheet.

    Declaration
    public void CopyFrom(WorksheetBaseImpl worksheet, Dictionary<string, string> hashStyleNames, Dictionary<string, string> hashWorksheetNames, Dictionary<int, int> dicFontIndexes, ExcelWorksheetCopyFlags flags, Dictionary<int, int> hashExtFormatIndexes)
    Parameters
    Type Name Description
    WorksheetBaseImpl worksheet

    Parent worksheet.

    System.Collections.Generic.Dictionary<System.String, System.String> hashStyleNames

    Dictionary with style names.

    System.Collections.Generic.Dictionary<System.String, System.String> hashWorksheetNames

    Dictionary with new worksheet names.

    System.Collections.Generic.Dictionary<System.Int32, System.Int32> dicFontIndexes

    Dictionary with new font indexes.

    ExcelWorksheetCopyFlags flags

    Copy flags.

    System.Collections.Generic.Dictionary<System.Int32, System.Int32> hashExtFormatIndexes

    Dictionary with extended format indexes, key - old index, value - new index.

    CopyHeaderFooterImages(WorksheetBaseImpl, Dictionary<String, String>, IDictionary)

    Copies preserved header/footer images.

    Declaration
    protected void CopyHeaderFooterImages(WorksheetBaseImpl sourceSheet, Dictionary<string, string> hashNewNames, IDictionary dicFontIndexes)
    Parameters
    Type Name Description
    WorksheetBaseImpl sourceSheet

    Source worksheet.

    System.Collections.Generic.Dictionary<System.String, System.String> hashNewNames

    Hash with new WorkSheet names.

    System.Collections.IDictionary dicFontIndexes

    Dictionary with new font indexes.

    CopyOptions(WorksheetBaseImpl)

    Copies different sheet options.

    Declaration
    protected virtual void CopyOptions(WorksheetBaseImpl sourceSheet)
    Parameters
    Type Name Description
    WorksheetBaseImpl sourceSheet

    Source sheet.

    CopyShapes(WorksheetBaseImpl, Dictionary<String, String>, Dictionary<Int32, Int32>)

    Copies all shapes from a source worksheet.

    Declaration
    protected void CopyShapes(WorksheetBaseImpl sourceSheet, Dictionary<string, string> hashNewNames, Dictionary<int, int> dicFontIndexes)
    Parameters
    Type Name Description
    WorksheetBaseImpl sourceSheet

    Source worksheet.

    System.Collections.Generic.Dictionary<System.String, System.String> hashNewNames

    Hash with new WorkSheet names.

    System.Collections.Generic.Dictionary<System.Int32, System.Int32> dicFontIndexes

    Dictionary with new font indexes.

    CreateSalt(Int32)

    Creates random salt.

    Declaration
    protected byte[] CreateSalt(int length)
    Parameters
    Type Name Description
    System.Int32 length

    Desired salt length.

    Returns
    Type Description
    System.Byte[]

    Array with random data.

    Dispose()

    Dispose

    Declaration
    public override void Dispose()
    Overrides
    CommonObject.Dispose()

    ExtractMSODrawing(Int32, ExcelParseOptions)

    Extracts MsoDrawing records from internal array.

    Declaration
    protected void ExtractMSODrawing(int startIndex, ExcelParseOptions options)
    Parameters
    Type Name Description
    System.Int32 startIndex

    Index to the first MsoDrawing record.

    ExcelParseOptions options

    Parse options.

    FindParents()

    Searches for all necessary parent objects.

    Declaration
    protected virtual void FindParents()

    GetPasswordHash(String)

    Returns hash value for the password string.

    Declaration
    public static ushort GetPasswordHash(string password)
    Parameters
    Type Name Description
    System.String password

    Password to hash.

    Returns
    Type Description
    System.UInt16

    Hash value for the password string.

    InitializeCollections()

    Initializes all required collections.

    Declaration
    protected virtual void InitializeCollections()

    MarkUsedReferences(Boolean[])

    Sets items with used reference indexes to true.

    Declaration
    public abstract void MarkUsedReferences(bool[] usedItems)
    Parameters
    Type Name Description
    System.Boolean[] usedItems

    Array to mark used references in.

    OnNameChanged(ValueChangedEventArgs)

    This method is called when Name of the worksheet was changed.

    Declaration
    protected virtual void OnNameChanged(ValueChangedEventArgs args)
    Parameters
    Type Name Description
    Syncfusion.XlsIO.Implementation.ValueChangedEventArgs args

    Event arguments.

    OnRealIndexChanged(Int32)

    This method is called after RealIndex property change.

    Declaration
    protected virtual void OnRealIndexChanged(int iOldIndex)
    Parameters
    Type Name Description
    System.Int32 iOldIndex

    Old index.

    Parse()

    Parses internal records.

    Declaration
    public virtual void Parse()

    Parse(BiffReader, ExcelParseOptions, Boolean, Dictionary<Int32, Int32>, IDecryptor)

    Method extracts biff records belonging to the worksheet.

    Declaration
    protected void Parse(BiffReader reader, ExcelParseOptions options, bool bSkipParsing, Dictionary<int, int> hashNewXFormatIndexes, IDecryptor decryptor)
    Parameters
    Type Name Description
    BiffReader reader

    BiffReader that contains worksheet's records.

    ExcelParseOptions options

    Parse options.

    System.Boolean bSkipParsing

    Indicates whether to skip parsing.

    System.Collections.Generic.Dictionary<System.Int32, System.Int32> hashNewXFormatIndexes

    Dictionary with new extended format indexes for ignore styles mode.

    IDecryptor decryptor

    Object used to decrypt encrypted records.

    ParseData()

    Parses worksheet's data.

    Declaration
    protected void ParseData()

    ParseData(Dictionary<Int32, Int32>)

    Parses worksheet's data.

    Declaration
    protected abstract void ParseData(Dictionary<int, int> dictUpdatedSSTIndexes)
    Parameters
    Type Name Description
    System.Collections.Generic.Dictionary<System.Int32, System.Int32> dictUpdatedSSTIndexes

    ParseDimensions(DimensionsRecord)

    Parses dimensions record.

    Declaration
    protected virtual void ParseDimensions(DimensionsRecord dimensions)
    Parameters
    Type Name Description
    DimensionsRecord dimensions

    Record to parse.

    ParseNextRecord(BiffReader, Int32, ExcelParseOptions, Boolean, Dictionary<Int32, Int32>, IDecryptor)

    Extracts next record from reader and parses it.

    Declaration
    protected virtual int ParseNextRecord(BiffReader reader, int iBOFCounter, ExcelParseOptions options, bool bSkipStyles, Dictionary<int, int> hashNewXFormatIndexes, IDecryptor decryptor)
    Parameters
    Type Name Description
    BiffReader reader

    Reader to extract record from.

    System.Int32 iBOFCounter

    Number of BOF records without closing EOF record.

    ExcelParseOptions options

    Parsing options.

    System.Boolean bSkipStyles

    Indicates whether styles information must be skipped.

    System.Collections.Generic.Dictionary<System.Int32, System.Int32> hashNewXFormatIndexes

    Dictionary with new extended format indexes for ignore styles mode.

    IDecryptor decryptor

    Object used to decrypt encrypted records.

    Returns
    Type Description
    System.Int32

    Updated number of BOF records without closing EOF record.

    ParseObjectProtect(ObjectProtectRecord)

    Parse ObjectProtect record.

    Declaration
    protected void ParseObjectProtect(ObjectProtectRecord objectProtect)
    Parameters
    Type Name Description
    ObjectProtectRecord objectProtect

    Record to parse.

    ParsePassword(PasswordRecord)

    Parses Password record.

    Declaration
    protected void ParsePassword(PasswordRecord passwordRecord)
    Parameters
    Type Name Description
    PasswordRecord passwordRecord

    Record to parse.

    ParseProtect(ProtectRecord)

    Parses Protect record.

    Declaration
    protected void ParseProtect(ProtectRecord protectRecord)
    Parameters
    Type Name Description
    ProtectRecord protectRecord

    Record to parse.

    ParseRecord(BiffRecordRaw, Boolean, Dictionary<Int32, Int32>)

    Parses single record.

    Declaration
    protected virtual void ParseRecord(BiffRecordRaw raw, bool bIgnoreStyles, Dictionary<int, int> hashNewXFormatIndexes)
    Parameters
    Type Name Description
    Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw raw

    Record to parse.

    System.Boolean bIgnoreStyles

    Indicates whether to ignore styles.

    System.Collections.Generic.Dictionary<System.Int32, System.Int32> hashNewXFormatIndexes

    Dictionary with new extended format indexes for ignore styles mode.

    ParseScenProtect(ScenProtectRecord)

    Parse ScenProtect record.

    Declaration
    protected void ParseScenProtect(ScenProtectRecord scenProtect)
    Parameters
    Type Name Description
    ScenProtectRecord scenProtect

    Record to parse.

    ParseSheetLayout(SheetLayoutRecord)

    Parses sheet layout record.

    Declaration
    protected void ParseSheetLayout(SheetLayoutRecord sheetLayout)
    Parameters
    Type Name Description
    SheetLayoutRecord sheetLayout

    Record to parse.

    ParseWindowTwo(WindowTwoRecord)

    Parse WindowTwo record.

    Declaration
    protected virtual void ParseWindowTwo(WindowTwoRecord windowTwo)
    Parameters
    Type Name Description
    WindowTwoRecord windowTwo

    Record to parse.

    ParseWindowZoom(WindowZoomRecord)

    Parses WindowZoom record.

    Declaration
    protected virtual void ParseWindowZoom(WindowZoomRecord windowZoom)
    Parameters
    Type Name Description
    WindowZoomRecord windowZoom

    Record to parse.

    PrepareProtection()

    Prepares protection variables.

    Declaration
    protected void PrepareProtection()

    PrepareProtectionOptions(ExcelSheetProtection)

    Prepares protection options before setting protection.

    Declaration
    protected virtual ExcelSheetProtection PrepareProtectionOptions(ExcelSheetProtection options)
    Parameters
    Type Name Description
    ExcelSheetProtection options
    Returns
    Type
    ExcelSheetProtection

    PrepareVariables(ExcelParseOptions, Boolean)

    Prepares variables to worksheet parsing.

    Declaration
    protected virtual void PrepareVariables(ExcelParseOptions options, bool bSkipParsing)
    Parameters
    Type Name Description
    ExcelParseOptions options

    Parse options.

    System.Boolean bSkipParsing

    Indicates whether to skip parsing.

    Protect(String)

    Protects worksheet with password.

    Declaration
    public void Protect(string password)
    Parameters
    Type Name Description
    System.String password

    Protection password.

    Exceptions
    Type Condition
    System.ApplicationException

    If worksheet is already protected.

    System.ArgumentNullException

    If specified password is null.

    System.ArgumentOutOfRangeException

    If length of the password is more than 15 symbols.

    Protect(String, ExcelSheetProtection)

    Protects current worksheet.

    Declaration
    public void Protect(string password, ExcelSheetProtection options)
    Parameters
    Type Name Description
    System.String password

    Represents password to protect.

    ExcelSheetProtection options

    Represents params to protect.

    RaiseNameChangedEvent(ValueChangedEventArgs)

    This method raises NameChanged event.

    Declaration
    protected void RaiseNameChangedEvent(ValueChangedEventArgs args)
    Parameters
    Type Name Description
    Syncfusion.XlsIO.Implementation.ValueChangedEventArgs args

    Event arguments.

    remove_NameChanged(ValueChangedEventHandler)

    Declaration
    public void remove_NameChanged(ValueChangedEventHandler value)
    Parameters
    Type Name Description
    Syncfusion.XlsIO.Implementation.ValueChangedEventHandler value

    Round(Int32, Int32)

    Rounds value.

    Declaration
    public static int Round(int value, int degree)
    Parameters
    Type Name Description
    System.Int32 value

    Value to be rounded.

    System.Int32 degree

    Represents degree used to round the given value.

    Returns
    Type Description
    System.Int32

    Rounded value.

    Select()

    Selects current tab sheet.

    Declaration
    public virtual void Select()

    SelectTab()

    Adds sheet tab to the selected tab.

    Declaration
    public void SelectTab()

    Serialize(OffsetArrayList)

    Serializes records.

    Declaration
    public virtual void Serialize(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    Records to be serialized.

    SerializeHeaderFooterPictures(OffsetArrayList)

    Serializes header / footer pictures.

    Declaration
    protected virtual void SerializeHeaderFooterPictures(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    List to save records into.

    SerializeMacrosSupport(OffsetArrayList)

    Serializes macros support.

    Declaration
    protected virtual void SerializeMacrosSupport(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    List to save records into.

    SerializeMsoDrawings(OffsetArrayList)

    Saves all shapes.

    Declaration
    protected virtual void SerializeMsoDrawings(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    List to save records into.

    SerializePageLayoutView(OffsetArrayList)

    Serializes page layout view

    Declaration
    protected virtual void SerializePageLayoutView(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    List to save records into.

    SerializeProtection(OffsetArrayList, Boolean)

    Saves protection block.

    Declaration
    protected virtual void SerializeProtection(OffsetArrayList records, bool bContentNotNecessary)
    Parameters
    Type Name Description
    OffsetArrayList records

    List to save records into.

    System.Boolean bContentNotNecessary

    SerializeSheetLayout(OffsetArrayList)

    Serializes sheet layout record.

    Declaration
    protected void SerializeSheetLayout(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    List to save records into.

    SerializeSheetProtection(OffsetArrayList)

    Serialize sheet protection.

    Declaration
    protected void SerializeSheetProtection(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    Represents record storage.

    SerializeWindowTwo(OffsetArrayList)

    Serializes WindowTwo record.

    Declaration
    protected virtual void SerializeWindowTwo(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    List to save records into.

    SerializeWindowZoom(OffsetArrayList)

    Serializes WindowZoom.

    Declaration
    protected void SerializeWindowZoom(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    List to save records into.

    SetChanged()

    This method should be called after any changes in the worksheet. Sets Saved property of the parent workbook to false.

    Declaration
    public void SetChanged()

    Unprotect()

    Unprotects this worksheet without password.

    Declaration
    public void Unprotect()

    Unprotect(String)

    Unprotects this worksheet using specified password.

    Declaration
    public void Unprotect(string password)
    Parameters
    Type Name Description
    System.String password

    Password to unprotect.

    Unselect()

    Unselects current tab sheet if possible.

    Declaration
    public void Unselect()

    Unselect(Boolean)

    Unselects current tab sheet if possible.

    Declaration
    public void Unselect(bool bCheckNumber)
    Parameters
    Type Name Description
    System.Boolean bCheckNumber

    Indicates whether to allow unselect last sheet.

    UpdateExtendedFormatIndex(Dictionary<Int32, Int32>)

    This method should be called immediately after extended format removal.

    Declaration
    public virtual void UpdateExtendedFormatIndex(Dictionary<int, int> dictFormats)
    Parameters
    Type Name Description
    System.Collections.Generic.Dictionary<System.Int32, System.Int32> dictFormats

    Dictionary with updated extended formats.

    UpdateFormula(Int32, Int32, Rectangle, Int32, Rectangle)

    Updates formulas after copy operation.

    Declaration
    public virtual void UpdateFormula(int iCurIndex, int iSourceIndex, Rectangle sourceRect, int iDestIndex, Rectangle destRect)
    Parameters
    Type Name Description
    System.Int32 iCurIndex

    Current worksheet index.

    System.Int32 iSourceIndex

    Source worksheet index.

    Rectangle sourceRect

    Source rectangle.

    System.Int32 iDestIndex

    Destination worksheet index.

    Rectangle destRect

    Destination rectangle.

    UpdateReferenceIndexes(Int32[])

    Updates reference indexes.

    Declaration
    public abstract void UpdateReferenceIndexes(int[] arrUpdatedIndexes)
    Parameters
    Type Name Description
    System.Int32[] arrUpdatedIndexes

    Array with updated indexes.

    UpdateStyleIndexes(Int32[])

    Updates style indexes.

    Declaration
    protected virtual void UpdateStyleIndexes(int[] styleIndexes)
    Parameters
    Type Name Description
    System.Int32[] styleIndexes

    Array with changed style indexes.

    Events

    NameChanged

    This event is raised when name of the worksheet is changed.

    Declaration
    public event ValueChangedEventHandler NameChanged
    Event Type
    Type
    Syncfusion.XlsIO.Implementation.ValueChangedEventHandler

    Explicit Interface Implementations

    ITabSheet.TabIndex

    Returns index in the parent ITabSheets collection. Read-only.

    Declaration
    int ITabSheet.TabIndex { get; }
    Returns
    Type
    System.Int32

    Implements

    System.IDisposable
    INamedObject
    IParseable
    ITabSheet
    IParentApplication
    ICloneParent
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved