Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OdsSheet

Namespace OfficeIMO.OpenDocument
Assembly OfficeIMO.OpenDocument
Source revision 804a7612eee4 with working tree changes
Modifiers sealed

An XML-backed ODS worksheet with sparse repeat-run editing.

Inheritance

  • Object
  • OdsSheet

Usage

Explore 3 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 3

Methods

public OdsChart AddChart(OdsChartType type, String categoriesAddress, IReadOnlyList<OdsChartSeries> series, Int64 anchorRow, Int64 anchorColumn, OdfRect bounds, String? title = null, String? name = null) #
Returns: OdsChart

Adds a bounded chart linked to existing ODS cells and anchored in this sheet.

Parameters

type OfficeIMO.OpenDocument.OdsChartType requiredposition: 0
categoriesAddress System.String requiredposition: 1
series System.Collections.Generic.IReadOnlyList<OfficeIMO.OpenDocument.OdsChartSeries> requiredposition: 2
anchorRow System.Int64 requiredposition: 3
anchorColumn System.Int64 requiredposition: 4
bounds OfficeIMO.OpenDocument.OdfRect requiredposition: 5
title System.String? = null optionalposition: 6
name System.String? = null optionalposition: 7
public OdsCell Cell(Int64 row, Int64 column) #
Returns: OdsCell

Gets an editable zero-based cell, splitting only the containing row and cell runs.

Parameters

row System.Int64 requiredposition: 0
column System.Int64 requiredposition: 1
public OdsColumn Column(Int64 column) #
Returns: OdsColumn

Gets an editable zero-based column definition, creating a sparse definition when needed.

Parameters

column System.Int64 requiredposition: 0
public String? GetFormula(Int64 row, Int64 column) #
Returns: String?

Reads a formula without splitting or expanding repeat runs.

Parameters

row System.Int64 requiredposition: 0
column System.Int64 requiredposition: 1
public OdsCellValue GetValue(Int64 row, Int64 column) #
Returns: OdsCellValue

Reads a value without splitting or expanding repeat runs.

Parameters

row System.Int64 requiredposition: 0
column System.Int64 requiredposition: 1
Merge 2 overloads
public OdsCell Merge(Int64 row, Int64 column, Int64 rowSpan, Int64 columnSpan) #
Returns: OdsCell

Merges a rectangular cell range and marks non-anchor positions as covered cells.

Parameters

row System.Int64 requiredposition: 0
column System.Int64 requiredposition: 1
rowSpan System.Int64 requiredposition: 2
columnSpan System.Int64 requiredposition: 3
public OdsCell Merge(Int64 row, Int64 column, Int64 rowSpan, Int64 columnSpan, Int64 maximumMaterializedCells) #
Returns: OdsCell

Merges a rectangular cell range under an explicit materialization bound.

Parameters

row System.Int64 requiredposition: 0
column System.Int64 requiredposition: 1
rowSpan System.Int64 requiredposition: 2
columnSpan System.Int64 requiredposition: 3
maximumMaterializedCells System.Int64 requiredposition: 4
public OdsRow Row(Int64 row) #
Returns: OdsRow

Gets an editable zero-based row, splitting its repeat run without expanding it.

Parameters

row System.Int64 requiredposition: 0

Properties

public String Name { get; set; } #

Worksheet name.

public Boolean Hidden { get; set; } #

Whether the sheet is hidden.

public IReadOnlyList<OdsChart> Charts { get; } #

Embedded charts whose chart content can be read safely from this package.

public String? PrintRanges { get; set; } #

Optional ODF print range expression.

public IReadOnlyList<OdsRowRun> RowRuns { get; } #

Sparse row runs without expanding table:number-rows-repeated.

public IReadOnlyList<OdsColumnRun> ColumnRuns { get; } #

Sparse column definition runs without expanding repeats.

public Int64 RowCount { get; } #

Logical row count represented by the sparse run model.

public OdsUsedRange? UsedRange { get; } #

Smallest rectangle containing cells with a value, formula, or text.

Fields

public const Int64 DefaultMaximumMergeCells #

Default maximum number of cells that one merge operation may materialize.

Value: 100000
public const Int32 DefaultMaximumChartFrames #

Maximum number of embedded chart frames projected from one sheet.

Value: 256