Class ImagingSpreadsheetOptions

Represents the spreadsheet options set on an ImagingProfile instance.

Inheritance

System.Object

ImagingSpreadsheetOptions

Inherited Members

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: Relativity.Testing.Framework.Models

Assembly: Relativity.Testing.Framework.dll

Syntax

public class ImagingSpreadsheetOptions

Properties

| Improve this Doc View Source

FitToPagesTall

Gets or sets the option for resetting the page height for a spreadsheet.

Declaration

public int? FitToPagesTall { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

Corresponds to the Fit to ___ pages tall option under the Spreadsheet Options tab.

| Improve this Doc View Source

FitToPagesWide

Gets or sets the option for resetting the page width for a spreadsheet.

Declaration

public int? FitToPagesWide { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

Corresponds to the Fit to ___ pages wide option under the Spreadsheet Options tab.

| Improve this Doc View Source

Formatting

Gets or sets the options for formatting a spreadsheet, such as auto-fit rows and columns, and clearing empty rows and columns.

Declaration

public HashSet<ImagingSpreadsheetFormatting> Formatting { get; set; }

Property Value

Type	Description
System.Collections.Generic.HashSet<ImagingSpreadsheetFormatting>

Remarks

ImagingSpreadsheetFormatting options under the Spreadsheet Options tab.

| Improve this Doc View Source

HideAndPageBreakAfterConsecutiveBlankRowCol

Gets or sets the option controlling the maximum number of consecutive blank rows or columns.

Declaration

public int HideAndPageBreakAfterConsecutiveBlankRowCol { get; set; }

Property Value

Type	Description
System.Int32

Remarks

Corresponds to the Hide and page break after ___ consecutive blank rows and columns option under the Spreadsheet Options tab.

| Improve this Doc View Source

IncludeBorders

Gets or sets a value indicating whether to render the borders in a spreadsheet.

Declaration

public bool IncludeBorders { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Corresponds to the "ImagingWordInclude Borders" option under Spreadsheet Options.

| Improve this Doc View Source

IncludeComments

Gets or sets a value indicating whether to render comments added to a spreadsheet.

Declaration

public bool IncludeComments { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Corresponds to the "ImagingWordInclude Comments" option under the Spreadsheet Options tab.

| Improve this Doc View Source

IncludeGridlines

Gets or sets the option for rendering the gridlines between rows and columns in the spreadsheet.

Declaration

public ImagingIncludeElement IncludeGridlines { get; set; }

Property Value

Type	Description
ImagingIncludeElement

Remarks

Corresponds to the ImagingWordInclude Gridlines option under the Spreadsheet Options tab.

| Improve this Doc View Source

IncludeHeadersAndFooters

Gets or sets the option for rendering headers and footers in the spreadsheet.

Declaration

public ImagingIncludeElement IncludeHeadersAndFooters { get; set; }

Property Value

Type	Description
ImagingIncludeElement

Remarks

Corresponds to the ImagingWordInclude headers and footers option under the Spreadsheet Options tab.

| Improve this Doc View Source

IncludeRowAndColumnHeadings

Gets or sets the option for rendering row headings (1, 2, 3, etc.) and column headings (A, B, C, etc.) in a spreadsheet.

Declaration

public ImagingIncludeElement IncludeRowAndColumnHeadings { get; set; }

Property Value

Type	Description
ImagingIncludeElement

Remarks

Corresponds to the ImagingWordInclude Headers and footers under the Spreadsheet Options tab.

| Improve this Doc View Source

LimitToPages

Gets or sets the option that controls the number of pages to render.

Declaration

public int? LimitToPages { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

corresponds to the Limit spreadsheet rendering to ____ page(s) under the Spreadsheet Options tab.

| Improve this Doc View Source

PageOrder

Gets or sets the order used to render the pages in a spreadsheet, such as vertical or horizontal overflow.

Declaration

public ImagingSpreadsheetPageOrder PageOrder { get; set; }

Property Value

Type	Description
ImagingSpreadsheetPageOrder

Remarks

Corresponds to the Page Order option under the Spreadsheet Options tab.

| Improve this Doc View Source

PaperSizeOrientation

Gets or sets the option for paper size and orientation used to render the pages in a spreadsheet.

Declaration

public ImagingSpreadsheetPaperSizeOrientation PaperSizeOrientation { get; set; }

Property Value

Type	Description
ImagingSpreadsheetPaperSizeOrientation

Remarks

Corresponds to the Paper size/Orientation drop-down list under the Spreadsheet Options tab.

| Improve this Doc View Source

PrintArea

Gets or sets the print area in a spreadsheet used for an imaging job.

Declaration

public ImagingSpreadsheetPrintArea PrintArea { get; set; }

Property Value

Type	Description
ImagingSpreadsheetPrintArea

Remarks

corresponds to the Print Area option under Spreadsheet Options tab.

| Improve this Doc View Source

ShowTrackChanges

Gets or sets a value indicating whether to display modifications made through the Track Changes option in Excel.

Declaration

public bool ShowTrackChanges { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Corresponds to the Show track changes in spreadsheet option in Spreadsheet Options.

| Improve this Doc View Source

TextVisibility

Gets or sets the options for text visibility by controlling background and font color.

Declaration

public HashSet<ImagingSpreadsheetTextVisibility> TextVisibility { get; set; }

Property Value

Type	Description
System.Collections.Generic.HashSet<ImagingSpreadsheetTextVisibility>

Remarks

Corresponds to the Text Visibility option under the Spreadsheet Options tab.

| Improve this Doc View Source

UnhideHiddenWorksheets

Gets or sets a value indicating whether to display hidden worksheets.

Declaration

public bool UnhideHiddenWorksheets { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

Corresponds to the Unhide Hidden Worksheets option under the Spreadsheet Options tab.

| Improve this Doc View Source

ZoomLevelPercentage

Gets or sets the option for setting the zoom level on a spreadsheet.

Declaration

public int? ZoomLevelPercentage { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Remarks

Corresponds to the "Zoom Level %" option under the Spreadsheet Options tab.