Class DisplayOptions

Abstract base class which exposes the various display options available for a worksheet which can be saved with both a worksheet and a custom view.

Inheritance
System.Object
DisplayOptionsBase
DisplayOptions
CustomViewDisplayOptions
WorksheetDisplayOptions
Inherited Members
Namespace: Infragistics.Documents.Excel
Assembly: IgniteUI.Blazor.Documents.Excel.dll
Syntax
public abstract class DisplayOptions : DisplayOptionsBase
Remarks

This class provides a way to control how a worksheet is displayed when it is viewed in Microsoft Excel.

Properties

FrozenPaneSettings

Gets the settings which control the frozen panes in the worksheet.

Declaration
public FrozenPaneSettings FrozenPaneSettings { get; }
Property Value
Type Description
FrozenPaneSettings

The settings which control the frozen panes in the worksheet..
Remarks

For these settings to be saved in the workbook file, PanesAreFrozen must be True.

Note: Frozen and unfrozen panes cannot be used simultaneously, so depending on whether the panes are frozen or unfrozen, these settings may not be used.

See Also

GridlineColor

Gets or sets the color of the gridlines on the worksheet.

Declaration
public Color GridlineColor { get; set; }
Property Value
Type Description
Color

The color of the gridlines on the worksheet.
Remarks

If the workbook is using a standard palette, the color set may be changed if it is not in the palette. In this case, the closest color in the standard palette will be used.

Exceptions
Type Condition
System.InvalidOperationException

The workbook is using a custom palette and setting this color would cause the custom palette to use too many colors.

PanesAreFrozen

Gets or sets the value which indicates if the panes in the worksheet are frozen.

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

The value which indicates if the panes in the worksheet are frozen.
Remarks

Depending on the value of this property, either the FrozenPaneSettings or the UnfrozenPaneSettings will be used for the worksheet. The unused settings are ignored and are not saved with the workbook stream.

See Also

ShowExpansionIndicatorBelowGroupedRows

Gets or sets the value which indicates whether the expansion indicators should be shown below grouped, or indented rows.

Declaration
public ExcelDefaultableBoolean ShowExpansionIndicatorBelowGroupedRows { get; set; }
Property Value
Type Description
ExcelDefaultableBoolean

ShowExpansionIndicatorToRightOfGroupedColumns

Gets or sets the value which indicates whether the expansion indicators should be shown to the right of grouped, or indented rows.

Declaration
public ExcelDefaultableBoolean ShowExpansionIndicatorToRightOfGroupedColumns { get; set; }
Property Value
Type Description
ExcelDefaultableBoolean

ShowFormulasInCells

Gets or sets the value which indicates whether formulas are shown in cells.

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

The value which indicates whether formulas are shown in cells.
Remarks

If this value is True, the formula string will be displayed in the cell. If the value is False, the result of the formula will be displayed in the cell.

ShowGridlines

Gets or sets the value which indicates whether gridlines are shown between cells.

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

The value which indicates whether gridlines are shown between cells.
See Also

ShowOutlineSymbols

Gets or sets the value which indicates whether outline symbols are shown for outlined columns and rows.

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

The value which indicates whether outline symbols are shown for outlined columns and rows.
Remarks

If the outline symbols are displayed, they provide a visual representation of the outline levels or rows and columns in Microsoft Excel. In addition, the outline symbols include the expansion indicators which allow for the expanding and collapsing of outline groups.

See Also

ShowRowAndColumnHeaders

Gets or sets the value which indicates whether to display row and column headers.

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

The value which indicates whether to display row and column headers.
Remarks

The row and column headers show the identifier of the row or column. They also allow the user to easily select all cells in a row or column by clicking them.

See Also

ShowRulerInPageLayoutView

Gets or sets the value which indicates whether to show rulers in the page layout view.

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

The value which indicates whether to show rulers in the page layout view.
Remarks

When this value is True, one ruler will display above the column headers of the active page in page layout view. Another ruler will also display before the row headers of the active page.

Note: This property will only affect the worksheet view if the View is PageLayout.

Note: The WorksheetView value of PageLayout is only supported in Excel 2007. If a worksheet with that View is viewed in earlier versions of Microsoft Excel, the view will default to Normal view.

See Also

ShowZeroValues

Gets or sets the value which indicates whether zero values are shown in cells.

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

The value which indicates whether zero values are shown in cells.
Remarks

If this value is True, cells with a value of zero will display their values; otherwise, those cells will display as blanks.

UnfrozenPaneSettings

Gets the settings which control the unfrozen panes in the worksheet.

Declaration
public UnfrozenPaneSettings UnfrozenPaneSettings { get; }
Property Value
Type Description
UnfrozenPaneSettings

The settings which control the unfrozen panes in the worksheet.
Remarks

For these settings to be saved in the workbook file, PanesAreFrozen must be False.

Note: Frozen and unfrozen panes cannot be used simultaneously, so depending on whether the panes are frozen or unfrozen, these settings may not be used.

See Also

View

Gets or sets the current view of the worksheet.

Declaration
public WorksheetView View { get; set; }
Property Value
Type Description
WorksheetView

The current view of the worksheet.
Remarks

The view determines the overall display of the worksheet in Microsoft Excel.

Note: The WorksheetView value of PageLayout is only supported in Excel 2007. If a worksheet with that View is viewed in earlier versions of Microsoft Excel, the view will default to Normal view.

Exceptions
Type Condition
System.ComponentModel.InvalidEnumArgumentException

The value assigned is not defined in the WorksheetView enumeration.
See Also

Methods

ClearSelection()

Removes any saved selection information.

Declaration
public void ClearSelection()

ResetCore()

Resets the display options to their default settings.

Declaration
protected override void ResetCore()
Overrides
Remarks

The defaults used for each setting are the same defaults with which Microsoft Excel creates a blank worksheet.

See Also