Class Worksheet

A two-dimensional grid of cells that are organized into rows and columns.

Inheritance

System.Object

NotifyPropertyChangedBase

Sheet

Worksheet

Inherited Members

Sheet.ISheet.SuspendLayoutUpdate()

Sheet.ISheet.ResumeLayoutUpdate()

Sheet.SuspendLayoutUpdate()

Sheet.ResumeLayoutUpdate()

Sheet.BeginUndoGroup()

Sheet.EndUndoGroup()

Sheet.ISheet.InvalidateLayout()

Sheet.Dispose()

Sheet.OnLayoutInvalidated()

Sheet.OnIsProtectedChanged()

Sheet.Name

Sheet.Workbook

Sheet.Visibility

Sheet.IsLayoutUpdateSuspended

Sheet.ISheet.ViewState

Sheet.IsProtected

Sheet.LayoutInvalidated

Sheet.NameChanged

Sheet.IsProtectedChanged

NotifyPropertyChangedBase.OnPropertyChanged(String)

NotifyPropertyChangedBase.OnPropertyChanged(PropertyChangedEventArgs)

NotifyPropertyChangedBase.PropertyChanged

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Spreadsheet.Model

Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class Worksheet : Sheet, INotifyPropertyChanged, ISheet, IDisposable

Properties

Cells

Gets the cells of the worksheet.

Declaration

public Cells Cells { get; }

Property Value

Cells The cells of the worksheet.

Charts

Gets the collection of charts inserted in the current worksheet.

Declaration

public ChartCollection Charts { get; }

Property Value

ChartCollection The charts.

Columns

Gets the columns of the worksheet.

Declaration

public Columns Columns { get; }

Property Value

Columns The columns of the worksheet.

Comments

Gets the collection of comments inserted in the current worksheet.

Declaration

public CommentCollection Comments { get; }

Property Value

CommentCollection The comments.

DefaultColumnWidth

Gets or sets the default width of the column.

Declaration

public ColumnWidth DefaultColumnWidth { get; set; }

Property Value

ColumnWidth The default width of the column.

DefaultRowHeight

Gets or sets the default height of the row.

Declaration

public RowHeight DefaultRowHeight { get; set; }

Property Value

RowHeight The default height of the row.

Filter

Gets the filtering of the worksheet.

Declaration

public AutoFilter Filter { get; }

Property Value

AutoFilter The filtering of the worksheet.

GroupingProperties

Gets the grouping properties for the worksheet.

Declaration

public GroupingProperties GroupingProperties { get; }

Property Value

GroupingProperties The grouping properties.

HeaderNameRenderingConverter

Gets or sets the header name rendering converter.

Declaration

public HeaderNameRenderingConverterBase HeaderNameRenderingConverter { get; set; }

Property Value

HeaderNameRenderingConverterBase The header name rendering converter.

Hyperlinks

Gets the all hyperlinks in the worksheet.

Declaration

public HyperlinkCollection Hyperlinks { get; }

Property Value

HyperlinkCollection The hyperlinks.

Images

Gets the collection of images inserted in the current worksheet.

Declaration

public ImageCollection Images { get; }

Property Value

ImageCollection The images.

Names

Gets the collection of defined names of the worksheet.

Declaration

public NameCollection Names { get; }

Property Value

NameCollection The collection of defined names of the worksheet.

Notes

Gets the collection of notes inserted in the current worksheet.

Declaration

public NoteCollection Notes { get; }

Property Value

NoteCollection The notes.

ProtectionOptions

Gets or sets the protection options.

Declaration

public WorksheetProtectionOptions ProtectionOptions { get; }

Property Value

WorksheetProtectionOptions The protection options.

Rows

Gets the rows of the worksheet.

Declaration

public Rows Rows { get; }

Property Value

Rows The rows of the worksheet.

Shapes

Declaration

[Obsolete("This member will be removed in Q1 2023. Use Worksheet.Charts, Worksheet.Notes, or Worksheet.Images instead, in accordance to the shape type")]
public ShapeCollection Shapes { get; }

Property Value

ShapeCollection

SheetPageSetup

Gets the sheet page setup.

Declaration

protected override sealed SheetPageSetupBase SheetPageSetup { get; }

Property Value

SheetPageSetupBase The sheet page setup.

Overrides

Sheet.SheetPageSetup

SortState

Gets the sort state.

Declaration

public SortState SortState { get; }

Property Value

SortState The sort state.

Type

Gets the type of the sheet.

Declaration

public override SheetType Type { get; }

Property Value

SheetType The type of the sheet.

Overrides

Sheet.Type

UsedCellRange

Gets the used cell range.

Declaration

public CellRange UsedCellRange { get; }

Property Value

CellRange The used cell range.

ViewState

Gets the view state of the worksheet.

Declaration

public WorksheetViewState ViewState { get; }

Property Value

WorksheetViewState The view state of the worksheet.

WorksheetPageSetup

Gets the worksheet page setup.

Declaration

public WorksheetPageSetup WorksheetPageSetup { get; }

Property Value

WorksheetPageSetup The worksheet page setup.

Methods

CopyFrom(Worksheet)

Copies Worksheet contents from a source Worksheet into this instance. This Worksheet instance contents are overridden from the source Worksheet contents.

Declaration

public void CopyFrom(Worksheet sourceWorksheet)

Parameters

Worksheet sourceWorksheet The worksheet to copy from.

CreateViewState()

Creates the state of the view.

Declaration

protected override ISheetViewState CreateViewState()

Returns

ISheetViewState

Overrides

Sheet.CreateViewState()

Dispose(Boolean)

Disposes the specified disposing.

Declaration

protected override void Dispose(bool disposing)

Parameters

System.Boolean disposing The disposing.

Overrides

Sheet.Dispose(Boolean)

Find(FindOptions)

Executes find action according to the specified find options.

Declaration

public FindResult Find(FindOptions findOptions)

Parameters

FindOptions findOptions The find options.

Returns

FindResult The find results.

FindAll(FindOptions)

Executes find all action according to the specified find options.

Declaration

public IEnumerable<FindResult> FindAll(FindOptions findOptions)

Parameters

FindOptions findOptions The find options.

Returns

System.Collections.Generic.IEnumerable<FindResult> The find results.

GetUsedCellRange(IEnumerable<IPropertyDefinition>)

Gets the used cell range for specific cell property definitions.

Declaration

public CellRange GetUsedCellRange(IEnumerable<IPropertyDefinition> propertyDefinitions)

Parameters

System.Collections.Generic.IEnumerable<IPropertyDefinition> propertyDefinitions The cell property definitions from CellPropertyDefinitions

Returns

CellRange The used cell range for specific cell property definitions.

Protect(String, WorksheetProtectionOptions)

Protects the worksheet.

Declaration

public void Protect(string password, WorksheetProtectionOptions options)

Parameters

System.String password The password.

WorksheetProtectionOptions options The protection options of the worksheet.

Replace(ReplaceOptions)

Executes replace action according to the specified replace options.

Declaration

public bool Replace(ReplaceOptions replaceOptions)

Parameters

ReplaceOptions replaceOptions The replace options.

Returns

System.Boolean The value indicating whether a value was found to replace.

ReplaceAll(ReplaceOptions)

Executes replace all action according to the specified replace options.

Declaration

public int ReplaceAll(ReplaceOptions replaceOptions)

Parameters

ReplaceOptions replaceOptions The replace options.

Returns

System.Int32 The number of replacements made.

Unprotect(String)

Unprotects the worksheet.

Declaration

public bool Unprotect(string password)

Parameters

System.String password The password.

Returns

System.Boolean