Encapsulates the object that represents a single worksheet. More...

Inherits IDisposable, and Object.

Public Member Functions
virtual void	Dispose ()=0
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...

virtual intrusive_ptr< Aspose::Cells::IProtection >	GetIProtection ()=0
	Represents the various types of protection options available for a worksheet. Supports advanced protection options in ExcelXP and above version. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetUniqueId ()=0
	Gets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}. More...

virtual void	SetUniqueId (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}. More...

virtual intrusive_ptr< Aspose::Cells::IPaneCollection >	GetIPanes ()=0
	Gets the window panes. More...

virtual intrusive_ptr< Aspose::Cells::IWorkbook >	GetIWorkbook ()=0
	Gets the workbook object which contains this sheet. More...

virtual intrusive_ptr< Aspose::Cells::ICells >	GetICells ()=0
	Gets the ICells collection. More...

virtual intrusive_ptr< Aspose::Cells::Pivot::IPivotTableCollection >	GetIPivotTables ()=0
	Gets all pivot tables in this worksheet. More...

virtual Aspose::Cells::SheetType	GetType ()=0
	Represents worksheet type. More...

virtual void	SetType (Aspose::Cells::SheetType value)=0
	Represents worksheet type. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetName ()=0
	Gets the name of the worksheet. More...

virtual void	SetName (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Sets the name of the worksheet. More...

virtual bool	GetShowFormulas ()=0
	Indicates whether to show formulas or their results. More...

virtual void	SetShowFormulas (bool value)=0
	Indicates whether to show formulas or their results. More...

virtual bool	IsGridlinesVisible ()=0
	Gets a value indicating whether the gridlines are visible. Default is true. More...

virtual void	SetGridlinesVisible (bool value)=0
	Sets a value indicating whether the gridlines are visible. Default is true. More...

virtual bool	IsRowColumnHeadersVisible ()=0
	Gets a value indicating whether the worksheet will display row and column headers. Default is true. More...

virtual void	SetRowColumnHeadersVisible (bool value)=0
	Sets a value indicating whether the worksheet will display row and column headers. Default is true. More...

virtual Aspose::Cells::PaneStateType	GetPaneState ()=0
	Indicates whether the pane has horizontal or vertical splits, and whether those splits are frozen. More...

virtual bool	GetDisplayZeros ()=0
	True if zero values are displayed. More...

virtual void	SetDisplayZeros (bool value)=0
	True if zero values are displayed. More...

virtual bool	GetDisplayRightToLeft ()=0
	Indicates if the specified worksheet is displayed from right to left instead of from left to right. Default is false. More...

virtual void	SetDisplayRightToLeft (bool value)=0
	Indicates if the specified worksheet is displayed from right to left instead of from left to right. Default is false. More...

virtual bool	IsOutlineShown ()=0
	Indicates whether to show outline. More...

virtual void	SetOutlineShown (bool value)=0
	Indicates whether to show outline. More...

virtual bool	IsSelected ()=0
	Indicates whether this worksheet is selected when the workbook is opened. More...

virtual void	SetSelected (bool value)=0
	Indicates whether this worksheet is selected when the workbook is opened. More...

virtual void	FreezePanes (Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column, Aspose::Cells::Systems::Int32 freezedRows, Aspose::Cells::Systems::Int32 freezedColumns)=0
	Freezes panes at the specified cell in the worksheet. More...

virtual bool	GetFreezedPanes (Aspose::Cells::Systems::Int32 &row, Aspose::Cells::Systems::Int32 &column, Aspose::Cells::Systems::Int32 &freezedRows, Aspose::Cells::Systems::Int32 &freezedColumns)=0
	Gets the freeze panes. More...

virtual void	Split ()=0
	Splits window. More...

virtual void	FreezePanes (intrusive_ptr< Aspose::Cells::Systems::String > cellName, Aspose::Cells::Systems::Int32 freezedRows, Aspose::Cells::Systems::Int32 freezedColumns)=0
	Freezes panes at the specified cell in the worksheet. More...

virtual void	UnFreezePanes ()=0
	Unfreezes panes in the worksheet. More...

virtual void	RemoveSplit ()=0
	Removes splitted window. More...

virtual intrusive_ptr< Aspose::Cells::Tables::IListObjectCollection >	GetIListObjects ()=0
	Gets all ListObjects in this worksheet. More...

virtual Aspose::Cells::Systems::Int32	GetTabId ()=0
	Specifies the internal identifier for the sheet. More...

virtual void	SetTabId (Aspose::Cells::Systems::Int32 value)=0
	Specifies the internal identifier for the sheet. More...

virtual intrusive_ptr< Aspose::Cells::IHorizontalPageBreakCollection >	GetIHorizontalPageBreaks ()=0
	Gets the HorizontalPageBreakCollection collection. More...

virtual intrusive_ptr< Aspose::Cells::IVerticalPageBreakCollection >	GetIVerticalPageBreaks ()=0
	Gets the VerticalPageBreakCollection collection. More...

virtual void	AddPageBreaks (intrusive_ptr< Aspose::Cells::Systems::String > cellName)=0
	Adds page break. More...

virtual intrusive_ptr< Aspose::Cells::IHyperlinkCollection >	GetIHyperlinks ()=0
	Gets the HyperlinkCollection collection. More...

virtual void	Copy (intrusive_ptr< Aspose::Cells::IWorksheet > sourceSheet)=0
	Copies contents and formats from another worksheet. More...

virtual void	Copy (intrusive_ptr< Aspose::Cells::IWorksheet > sourceSheet, intrusive_ptr< Aspose::Cells::ICopyOptions > copyOptions)=0
	Copies contents and formats from another worksheet. More...

virtual void	AutoFitColumn (Aspose::Cells::Systems::Int32 columnIndex, Aspose::Cells::Systems::Int32 firstRow, Aspose::Cells::Systems::Int32 lastRow)=0
	Autofits the column width. More...

virtual void	AutoFitColumns ()=0
	Autofits all columns in this worksheet. More...

virtual void	AutoFitColumns (intrusive_ptr< Aspose::Cells::IAutoFitterOptions > options)=0
	Autofits all columns in this worksheet. More...

virtual void	AutoFitColumn (Aspose::Cells::Systems::Int32 columnIndex)=0
	Autofits the column width. More...

virtual void	AutoFitColumns (Aspose::Cells::Systems::Int32 firstColumn, Aspose::Cells::Systems::Int32 lastColumn)=0
	Autofits the columns width. More...

virtual void	AutoFitColumns (Aspose::Cells::Systems::Int32 firstColumn, Aspose::Cells::Systems::Int32 lastColumn, intrusive_ptr< Aspose::Cells::IAutoFitterOptions > options)=0
	Autofits the columns width. More...

virtual void	AutoFitColumns (Aspose::Cells::Systems::Int32 firstRow, Aspose::Cells::Systems::Int32 firstColumn, Aspose::Cells::Systems::Int32 lastRow, Aspose::Cells::Systems::Int32 lastColumn)=0
	Autofits the columns width. More...

virtual void	AutoFitColumns (Aspose::Cells::Systems::Int32 firstRow, Aspose::Cells::Systems::Int32 firstColumn, Aspose::Cells::Systems::Int32 lastRow, Aspose::Cells::Systems::Int32 lastColumn, intrusive_ptr< Aspose::Cells::IAutoFitterOptions > options)=0
	Autofits the columns width. More...

virtual void	AutoFitRow (Aspose::Cells::Systems::Int32 rowIndex, Aspose::Cells::Systems::Int32 firstColumn, Aspose::Cells::Systems::Int32 lastColumn)=0
	Autofits the row height. More...

virtual void	AutoFitRow (Aspose::Cells::Systems::Int32 rowIndex, Aspose::Cells::Systems::Int32 firstColumn, Aspose::Cells::Systems::Int32 lastColumn, intrusive_ptr< Aspose::Cells::IAutoFitterOptions > options)=0
	Autofits the row height. More...

virtual void	AutoFitRows ()=0
	Autofits all rows in this worksheet. More...

virtual void	AutoFitRows (bool onlyAuto)=0
	Autofits all rows in this worksheet. More...

virtual void	AutoFitRows (intrusive_ptr< Aspose::Cells::IAutoFitterOptions > options)=0
	Autofits all rows in this worksheet. More...

virtual void	AutoFitRows (Aspose::Cells::Systems::Int32 startRow, Aspose::Cells::Systems::Int32 endRow)=0
	Autofits row height in a range. More...

virtual void	AutoFitRows (Aspose::Cells::Systems::Int32 startRow, Aspose::Cells::Systems::Int32 endRow, intrusive_ptr< Aspose::Cells::IAutoFitterOptions > options)=0
	Autofits row height in a range. More...

virtual void	AutoFitRow (Aspose::Cells::Systems::Int32 startRow, Aspose::Cells::Systems::Int32 endRow, Aspose::Cells::Systems::Int32 startColumn, Aspose::Cells::Systems::Int32 endColumn)=0
	Autofits row height in a rectangle range. More...

virtual void	AutoFitRow (Aspose::Cells::Systems::Int32 rowIndex)=0
	Autofits the row height. More...

virtual intrusive_ptr< Aspose::Cells::IPageSetup >	GetIPageSetup ()=0
	Represents the page setup description in this sheet. More...

virtual intrusive_ptr< Aspose::Cells::IAutoFilter >	GetIAutoFilter ()=0
	Represents auto filter for the specified worksheet. More...

virtual void	AdvancedFilter (bool isFilter, intrusive_ptr< Aspose::Cells::Systems::String > listRange, intrusive_ptr< Aspose::Cells::Systems::String > criteriaRange, intrusive_ptr< Aspose::Cells::Systems::String > copyTo, bool uniqueRecordOnly)=0
	Filters data using complex criteria. More...

virtual void	RemoveAutoFilter ()=0
	Removes the auto filter of the worksheet. More...

virtual bool	HasAutofilter ()=0
	Indicates whether this worksheet has auto filter. More...

virtual bool	GetTransitionEvaluation ()=0
	Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled. More...

virtual void	SetTransitionEvaluation (bool value)=0
	Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled. More...

virtual bool	GetTransitionEntry ()=0
	Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled. More...

virtual void	SetTransitionEntry (bool value)=0
	Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled. More...

virtual Aspose::Cells::VisibilityType	GetVisibilityType ()=0
	Indicates the visible state for this sheet. More...

virtual void	SetVisibilityType (Aspose::Cells::VisibilityType value)=0
	Indicates the visible state for this sheet. More...

virtual void	SetVisible (bool isVisible, bool ignoreError)=0
	Sets the visible options. More...

virtual bool	IsVisible ()=0
	Represents if the worksheet is visible. More...

virtual void	SetVisible (bool value)=0
	Represents if the worksheet is visible. More...

virtual void	SelectRange (Aspose::Cells::Systems::Int32 startRow, Aspose::Cells::Systems::Int32 startColumn, Aspose::Cells::Systems::Int32 totalRows, Aspose::Cells::Systems::Int32 totalColumns, bool removeOthers)=0
	Selects a range. More...

virtual void	RemoveAllDrawingObjects ()=0
	Removes all drawing objects in this worksheet. More...

virtual void	ClearComments ()=0
	Clears all comments in designer spreadsheet. More...

virtual intrusive_ptr< Aspose::Cells::Charts::ISparklineGroupCollection >	GetISparklineGroupCollection ()=0
	Gets the sparkline group collection in the worksheet. More...

virtual intrusive_ptr< Aspose::Cells::Charts::ISparklineGroupCollection >	GetISparklineGroups ()=0
	Gets the sparkline groups in the worksheet. More...

virtual intrusive_ptr< Aspose::Cells::Charts::IChartCollection >	GetICharts ()=0
	Gets a IChart collection More...

virtual intrusive_ptr< Aspose::Cells::ICommentCollection >	GetIComments ()=0
	Gets the IComment collection. More...

virtual intrusive_ptr< Aspose::Cells::Drawing::IPictureCollection >	GetIPictures ()=0
	Gets a IPicture collection. More...

virtual intrusive_ptr< Aspose::Cells::Drawing::ITextBoxCollection >	GetITextBoxes ()=0
	Gets a ITextBoxe collection. More...

virtual intrusive_ptr< Aspose::Cells::Drawing::ICheckBoxCollection >	GetICheckBoxes ()=0
	Gets a ICheckBox collection. More...

virtual intrusive_ptr< Aspose::Cells::Drawing::IOleObjectCollection >	GetIOleObjects ()=0
	Represents a collection of IOleObject in a worksheet. More...

virtual intrusive_ptr< Aspose::Cells::Drawing::IShapeCollection >	GetIShapes ()=0
	Returns all drawing shapes in this worksheet. More...

virtual void	Protect (Aspose::Cells::ProtectionType type)=0
	Protects worksheet. More...

virtual void	Protect (Aspose::Cells::ProtectionType type, intrusive_ptr< Aspose::Cells::Systems::String > password, intrusive_ptr< Aspose::Cells::Systems::String > oldPassword)=0
	Protects worksheet. More...

virtual void	Unprotect ()=0
	Unprotects worksheet. More...

virtual void	Unprotect (intrusive_ptr< Aspose::Cells::Systems::String > password)=0
	Unprotects worksheet. More...

virtual Aspose::Cells::Systems::Int32	GetIndex ()=0
	Gets the index of sheet in the worksheet collection. More...

virtual void	MoveTo (Aspose::Cells::Systems::Int32 index)=0
	Moves the sheet to another location in the spreadsheet. More...

virtual bool	IsProtected ()=0
	Indicates if the worksheet is protected. More...

virtual intrusive_ptr< Aspose::Cells::IValidationCollection >	GetIValidations ()=0
	Gets the data validation setting collection in the worksheet. More...

virtual intrusive_ptr< Aspose::Cells::IProtectedRangeCollection >	GetIProtectedRangeCollection ()=0
	Gets the allow edit range collection in the worksheet. More...

virtual intrusive_ptr< Aspose::Cells::IErrorCheckOptionCollection >	GetIErrorCheckOptions ()=0
	Gets error check setting applied on certain ranges. More...

virtual intrusive_ptr< Aspose::Cells::IOutline >	GetIOutline ()=0
	Gets the outline on this worksheet. More...

virtual Aspose::Cells::Systems::Int32	GetFirstVisibleRow ()=0
	Represents first visible row index. More...

virtual void	SetFirstVisibleRow (Aspose::Cells::Systems::Int32 value)=0
	Represents first visible row index. More...

virtual Aspose::Cells::Systems::Int32	GetFirstVisibleColumn ()=0
	Represents first visible column index. More...

virtual void	SetFirstVisibleColumn (Aspose::Cells::Systems::Int32 value)=0
	Represents first visible column index. More...

virtual Aspose::Cells::Systems::Int32	Replace (intrusive_ptr< Aspose::Cells::Systems::String > oldString, intrusive_ptr< Aspose::Cells::Systems::String > newString)=0
	Replaces all cells' text with a new string. More...

virtual Aspose::Cells::Systems::Int32	GetZoom ()=0
	Represents the scaling factor in percentage. It should be between 10 and 400. More...

virtual void	SetZoom (Aspose::Cells::Systems::Int32 value)=0
	Represents the scaling factor in percentage. It should be between 10 and 400. More...

virtual Aspose::Cells::ViewType	GetViewType ()=0
	Gets and sets the view type. More...

virtual void	SetViewType (Aspose::Cells::ViewType value)=0
	Gets and sets the view type. More...

virtual bool	IsPageBreakPreview ()=0
	Indicates whether the specified worksheet is shown in normal view or page break preview. More...

virtual void	SetPageBreakPreview (bool value)=0
	Indicates whether the specified worksheet is shown in normal view or page break preview. More...

virtual bool	IsRulerVisible ()=0
	Indicates whether the ruler is visible. This property is only applied for page break preview. More...

virtual void	SetRulerVisible (bool value)=0
	Indicates whether the ruler is visible. This property is only applied for page break preview. More...

virtual intrusive_ptr< Aspose::Cells::Systems::Collections::ArrayList >	GetSelectedRanges ()=0
	Gets selected ranges of cells in the designer spreadsheet. More...

virtual intrusive_ptr< Aspose::Cells::Systems::Drawing::Color >	GetTabColor ()=0
	Represents worksheet tab color. More...

virtual void	SetTabColor (intrusive_ptr< Aspose::Cells::Systems::Drawing::Color > value)=0
	Represents worksheet tab color. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetCodeName ()=0
	Gets worksheet code name. More...

virtual void	SetCodeName (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Sets worksheet code name. More...

virtual intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte > >	GetBackgroundImage ()=0
	Gets worksheet background image. More...

virtual void	SetBackgroundImage (intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte >> value)=0
	Sets worksheet background image. More...

virtual intrusive_ptr< Aspose::Cells::IConditionalFormattingCollection >	GetIConditionalFormattings ()=0
	Gets the ConditionalFormattings in the worksheet. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	GetActiveCell ()=0
	Gets the active cell in the worksheet. More...

virtual void	SetActiveCell (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
	Sets the active cell in the worksheet. More...

virtual intrusive_ptr< Aspose::Cells::Properties::ICustomPropertyCollection >	GetICustomProperties ()=0
	Gets an object representing the identifier information associated with a worksheet. More...

virtual intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::ICellArea * > >	GetPrintingPageBreaks (intrusive_ptr< Aspose::Cells::Rendering::IImageOrPrintOptions > options)=0
	Gets automatic page breaks. More...

virtual intrusive_ptr< Aspose::Cells::Systems::String >	ToString ()=0
	Returns a string represents the current Worksheet object. More...

virtual intrusive_ptr< Aspose::Cells::IScenarioCollection >	GetIScenarios ()=0
	Gets the collection of Scenario More...

virtual void	StartAccessCache (Aspose::Cells::AccessCacheOptions opts)=0
	Starts the session that uses caches to access the data in this worksheet. More...

virtual void	CloseAccessCache (Aspose::Cells::AccessCacheOptions opts)=0
	Closes the session that uses caches to access the data in this worksheet. More...

virtual intrusive_ptr< Aspose::Cells::Systems::Object >	CalculateFormula (intrusive_ptr< Aspose::Cells::Systems::String > formula)=0
	Calculates a formula. More...

virtual intrusive_ptr< Aspose::Cells::Systems::Object >	CalculateFormulaByOption (intrusive_ptr< Aspose::Cells::Systems::String > formula, intrusive_ptr< Aspose::Cells::ICalculationOptions > opts)=0
	Calculates a formula. More...

virtual void	CalculateFormula (bool recursive, bool ignoreError, intrusive_ptr< Aspose::Cells::ICustomFunction > customFunction)=0
	Calculates all formulas in this worksheet. More...

virtual void	CalculateFormulaByOption (intrusive_ptr< Aspose::Cells::ICalculationOptions > options, bool recursive)=0
	Calculates all formulas in this worksheet. More...

virtual void	RefreshPivotTables ()=0
	Refreshes all the PivotTables in this Worksheet. More...

virtual void	add_ref ()

virtual int	release_ref ()

Detailed Description

Encapsulates the object that represents a single worksheet.

[C++]
intrusive_ptr<Aspose::Cells::IWorkbook> workbook = Factory::CreateIWorkbook();
intrusive_ptr<Aspose::Cells::IWorksheet> sheet = workbook->GetIWorksheets()->GetObjectByIndex(0);
//Freeze panes at "AS40" with 10 rows and 10 columns
sheet->FreezePanes(new String("AS40"), 10, 10);

Member Function Documentation

◆ add_ref()

virtual void Aspose::Cells::IWorksheet::add_ref ( )

inlinevirtual

◆ AddPageBreaks()

virtual void Aspose::Cells::IWorksheet::AddPageBreaks ( intrusive_ptr< Aspose::Cells::Systems::String > cellName )

pure virtual

Adds page break.

Parameters

cellName

◆ AdvancedFilter()

virtual void Aspose::Cells::IWorksheet::AdvancedFilter	(	bool	isFilter,
		intrusive_ptr< Aspose::Cells::Systems::String >	listRange,
		intrusive_ptr< Aspose::Cells::Systems::String >	criteriaRange,
		intrusive_ptr< Aspose::Cells::Systems::String >	copyTo,
		bool	uniqueRecordOnly
	)

pure virtual

Filters data using complex criteria.

Parameters

isFilter	Indicates whether filtering the list in place.
listRange	The list range.
criteriaRange	The criteria range.
copyTo	The range where copying data to.
uniqueRecordOnly	Only displaying or copying unique rows.

◆ AutoFitColumn() [1/2]

virtual void Aspose::Cells::IWorksheet::AutoFitColumn	(	Aspose::Cells::Systems::Int32	columnIndex,
		Aspose::Cells::Systems::Int32	firstRow,
		Aspose::Cells::Systems::Int32	lastRow
	)

pure virtual

Autofits the column width.

Parameters

columnIndex	Column index.
firstRow	First row index.
lastRow	Last row index.

This method autofits a row based on content in a range of cells within the row.

◆ AutoFitColumn() [2/2]

virtual void Aspose::Cells::IWorksheet::AutoFitColumn ( Aspose::Cells::Systems::Int32 columnIndex )

pure virtual

Autofits the column width.

Parameters

columnIndex Column index.

AutoFitColumn is an imprecise function.

◆ AutoFitColumns() [1/6]

virtual void Aspose::Cells::IWorksheet::AutoFitColumns ( )

pure virtual

Autofits all columns in this worksheet.

◆ AutoFitColumns() [2/6]

virtual void Aspose::Cells::IWorksheet::AutoFitColumns ( intrusive_ptr< Aspose::Cells::IAutoFitterOptions > options )

pure virtual

Autofits all columns in this worksheet.

Parameters

options The auto fitting options

◆ AutoFitColumns() [3/6]

virtual void Aspose::Cells::IWorksheet::AutoFitColumns	(	Aspose::Cells::Systems::Int32	firstColumn,
		Aspose::Cells::Systems::Int32	lastColumn
	)

pure virtual

Autofits the columns width.

Parameters

firstColumn	First column index.
lastColumn	Last column index.

AutoFitColumn is an imprecise function.

◆ AutoFitColumns() [4/6]

virtual void Aspose::Cells::IWorksheet::AutoFitColumns	(	Aspose::Cells::Systems::Int32	firstColumn,
		Aspose::Cells::Systems::Int32	lastColumn,
		intrusive_ptr< Aspose::Cells::IAutoFitterOptions >	options
	)

pure virtual

Autofits the columns width.

Parameters

firstColumn	First column index.
lastColumn	Last column index.
options	The auto fitting options

AutoFitColumn is an imprecise function.

◆ AutoFitColumns() [5/6]

virtual void Aspose::Cells::IWorksheet::AutoFitColumns	(	Aspose::Cells::Systems::Int32	firstRow,
		Aspose::Cells::Systems::Int32	firstColumn,
		Aspose::Cells::Systems::Int32	lastRow,
		Aspose::Cells::Systems::Int32	lastColumn
	)

pure virtual

Autofits the columns width.

Parameters

firstRow	First row index.
firstColumn	First column index.
lastRow	Last row index.
lastColumn	Last column index.

AutoFitColumn is an imprecise function.

◆ AutoFitColumns() [6/6]

virtual void Aspose::Cells::IWorksheet::AutoFitColumns	(	Aspose::Cells::Systems::Int32	firstRow,
		Aspose::Cells::Systems::Int32	firstColumn,
		Aspose::Cells::Systems::Int32	lastRow,
		Aspose::Cells::Systems::Int32	lastColumn,
		intrusive_ptr< Aspose::Cells::IAutoFitterOptions >	options
	)

pure virtual

Autofits the columns width.

Parameters

firstRow	First row index.
firstColumn	First column index.
lastRow	Last row index.
lastColumn	Last column index.
options	The auto fitting options

AutoFitColumn is an imprecise function.

◆ AutoFitRow() [1/4]

virtual void Aspose::Cells::IWorksheet::AutoFitRow	(	Aspose::Cells::Systems::Int32	rowIndex,
		Aspose::Cells::Systems::Int32	firstColumn,
		Aspose::Cells::Systems::Int32	lastColumn
	)

pure virtual

Autofits the row height.

Parameters

rowIndex	Row index.
firstColumn	First column index.
lastColumn	Last column index.

This method autofits a row based on content in a range of cells within the row.

◆ AutoFitRow() [2/4]

virtual void Aspose::Cells::IWorksheet::AutoFitRow	(	Aspose::Cells::Systems::Int32	rowIndex,
		Aspose::Cells::Systems::Int32	firstColumn,
		Aspose::Cells::Systems::Int32	lastColumn,
		intrusive_ptr< Aspose::Cells::IAutoFitterOptions >	options
	)

pure virtual

Autofits the row height.

Parameters

rowIndex	Row index.
firstColumn	First column index.
lastColumn	Last column index.
options	The auto fitter options

This method autofits a row based on content in a range of cells within the row.

◆ AutoFitRow() [3/4]

virtual void Aspose::Cells::IWorksheet::AutoFitRow	(	Aspose::Cells::Systems::Int32	startRow,
		Aspose::Cells::Systems::Int32	endRow,
		Aspose::Cells::Systems::Int32	startColumn,
		Aspose::Cells::Systems::Int32	endColumn
	)

pure virtual

Autofits row height in a rectangle range.

Parameters

startRow	Start row index.
endRow	End row index.
startColumn	Start column index.
endColumn	End column index.

◆ AutoFitRow() [4/4]

virtual void Aspose::Cells::IWorksheet::AutoFitRow ( Aspose::Cells::Systems::Int32 rowIndex )

pure virtual

Autofits the row height.

Parameters

rowIndex Row index.

AutoFitRow is an imprecise function.

◆ AutoFitRows() [1/5]

virtual void Aspose::Cells::IWorksheet::AutoFitRows ( )

pure virtual

Autofits all rows in this worksheet.

◆ AutoFitRows() [2/5]

virtual void Aspose::Cells::IWorksheet::AutoFitRows ( bool onlyAuto )

pure virtual

Autofits all rows in this worksheet.

Parameters

onlyAuto True,only autofits the row height when row height is not customed.

◆ AutoFitRows() [3/5]

virtual void Aspose::Cells::IWorksheet::AutoFitRows ( intrusive_ptr< Aspose::Cells::IAutoFitterOptions > options )

pure virtual

Autofits all rows in this worksheet.

Parameters

options The auto fitter options

◆ AutoFitRows() [4/5]

virtual void Aspose::Cells::IWorksheet::AutoFitRows	(	Aspose::Cells::Systems::Int32	startRow,
		Aspose::Cells::Systems::Int32	endRow
	)

pure virtual

Autofits row height in a range.

Parameters

startRow	Start row index.
endRow	End row index.

◆ AutoFitRows() [5/5]

virtual void Aspose::Cells::IWorksheet::AutoFitRows	(	Aspose::Cells::Systems::Int32	startRow,
		Aspose::Cells::Systems::Int32	endRow,
		intrusive_ptr< Aspose::Cells::IAutoFitterOptions >	options
	)

pure virtual

Autofits row height in a range.

Parameters

startRow	Start row index.
endRow	End row index.
options	The options of auto fitter.

◆ CalculateFormula() [1/2]

virtual intrusive_ptr<Aspose::Cells::Systems::Object> Aspose::Cells::IWorksheet::CalculateFormula ( intrusive_ptr< Aspose::Cells::Systems::String > formula )

pure virtual

Calculates a formula.

Parameters

formula Formula to be calculated.

Returns: Calculated formula result.

◆ CalculateFormula() [2/2]

virtual void Aspose::Cells::IWorksheet::CalculateFormula	(	bool	recursive,
		bool	ignoreError,
		intrusive_ptr< Aspose::Cells::ICustomFunction >	customFunction
	)

pure virtual

Calculates all formulas in this worksheet.

Parameters

recursive	True means if the worksheet' cells depend on the cells of other worksheets, the dependent cells in other worksheets will be calculated too. False means all the formulas in the worksheet have been calculated and the values are right.
ignoreError	Indicates if hide the error in calculating formulas. The error may be unsupported function, external links, etc.
customFunction	The custom formula calculation functions to extend the calculation engine.

◆ CalculateFormulaByOption() [1/2]

virtual intrusive_ptr<Aspose::Cells::Systems::Object> Aspose::Cells::IWorksheet::CalculateFormulaByOption	(	intrusive_ptr< Aspose::Cells::Systems::String >	formula,
		intrusive_ptr< Aspose::Cells::ICalculationOptions >	opts
	)

pure virtual

Calculates a formula.

Parameters

formula	Formula to be calculated.
opts	Options for calculating formula

Returns: Calculated formula result.

◆ CalculateFormulaByOption() [2/2]

virtual void Aspose::Cells::IWorksheet::CalculateFormulaByOption	(	intrusive_ptr< Aspose::Cells::ICalculationOptions >	options,
		bool	recursive
	)

pure virtual

Calculates all formulas in this worksheet.

Parameters

options	Options for calculation
recursive	True means if the worksheet' cells depend on the cells of other worksheets, the dependent cells in other worksheets will be calculated too. False means all the formulas in the worksheet have been calculated and the values are right.

◆ ClearComments()

virtual void Aspose::Cells::IWorksheet::ClearComments ( )

pure virtual

Clears all comments in designer spreadsheet.

◆ CloseAccessCache()

virtual void Aspose::Cells::IWorksheet::CloseAccessCache ( Aspose::Cells::AccessCacheOptions opts )

pure virtual

Closes the session that uses caches to access the data in this worksheet.

Parameters

opts	options of data access

◆ Copy() [1/2]

virtual void Aspose::Cells::IWorksheet::Copy ( intrusive_ptr< Aspose::Cells::IWorksheet > sourceSheet )

pure virtual

Copies contents and formats from another worksheet.

Parameters

sourceSheet Source worksheet.

◆ Copy() [2/2]

virtual void Aspose::Cells::IWorksheet::Copy	(	intrusive_ptr< Aspose::Cells::IWorksheet >	sourceSheet,
		intrusive_ptr< Aspose::Cells::ICopyOptions >	copyOptions
	)

pure virtual

Copies contents and formats from another worksheet.

Parameters

sourceSheet	Source worksheet.
copyOptions

You can copy data from another worksheet in the same file or another file. However, this method does not support to copy drawing objects, such as comments, images and charts.

◆ Dispose()

virtual void Aspose::Cells::IWorksheet::Dispose ( )

pure virtual

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

◆ FreezePanes() [1/2]

virtual void Aspose::Cells::IWorksheet::FreezePanes	(	Aspose::Cells::Systems::Int32	row,
		Aspose::Cells::Systems::Int32	column,
		Aspose::Cells::Systems::Int32	freezedRows,
		Aspose::Cells::Systems::Int32	freezedColumns
	)

pure virtual

Freezes panes at the specified cell in the worksheet.

Parameters

row	Row index.
column	Column index.
freezedRows	Number of visible rows in top pane, no more than row index.
freezedColumns	Number of visible columns in left pane, no more than column index.

Row index and column index cannot all be zero. Number of rows and number of columns also cannot all be zero.

The first two parameters specify the frozen position and the last two parameters specify the area frozen on the left top pane.

◆ FreezePanes() [2/2]

virtual void Aspose::Cells::IWorksheet::FreezePanes	(	intrusive_ptr< Aspose::Cells::Systems::String >	cellName,
		Aspose::Cells::Systems::Int32	freezedRows,
		Aspose::Cells::Systems::Int32	freezedColumns
	)

pure virtual

Freezes panes at the specified cell in the worksheet.

Parameters

cellName	Cell name.
freezedRows	Number of visible rows in top pane, no more than row index.
freezedColumns	Number of visible columns in left pane, no more than column index.

Row index and column index cannot all be zero. Number of rows and number of columns also cannot all be zero.

◆ GetActiveCell()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IWorksheet::GetActiveCell ( )

pure virtual

Gets the active cell in the worksheet.

◆ GetBackgroundImage()

virtual intrusive_ptr<Aspose::Cells::Systems::Array1D<Aspose::Cells::Systems::Byte> > Aspose::Cells::IWorksheet::GetBackgroundImage ( )

pure virtual

Gets worksheet background image.

◆ GetCodeName()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IWorksheet::GetCodeName ( )

pure virtual

Gets worksheet code name.

◆ GetDisplayRightToLeft()

virtual bool Aspose::Cells::IWorksheet::GetDisplayRightToLeft ( )

pure virtual

Indicates if the specified worksheet is displayed from right to left instead of from left to right. Default is false.

◆ GetDisplayZeros()

virtual bool Aspose::Cells::IWorksheet::GetDisplayZeros ( )

pure virtual

True if zero values are displayed.

◆ GetFirstVisibleColumn()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IWorksheet::GetFirstVisibleColumn ( )

pure virtual

Represents first visible column index.

◆ GetFirstVisibleRow()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IWorksheet::GetFirstVisibleRow ( )

pure virtual

Represents first visible row index.

◆ GetFreezedPanes()

virtual bool Aspose::Cells::IWorksheet::GetFreezedPanes	(	Aspose::Cells::Systems::Int32 &	row,
		Aspose::Cells::Systems::Int32 &	column,
		Aspose::Cells::Systems::Int32 &	freezedRows,
		Aspose::Cells::Systems::Int32 &	freezedColumns
	)

pure virtual

Gets the freeze panes.

Parameters

row	Row index.
column	Column index.
freezedRows	Number of visible rows in top pane, no more than row index.
freezedColumns	Number of visible columns in left pane, no more than column index.

Returns: Return whether the worksheet is frozen

◆ GetIAutoFilter()

virtual intrusive_ptr<Aspose::Cells::IAutoFilter> Aspose::Cells::IWorksheet::GetIAutoFilter ( )

pure virtual

Represents auto filter for the specified worksheet.

◆ GetICells()

virtual intrusive_ptr<Aspose::Cells::ICells> Aspose::Cells::IWorksheet::GetICells ( )

pure virtual

Gets the ICells collection.

◆ GetICharts()

virtual intrusive_ptr<Aspose::Cells::Charts::IChartCollection> Aspose::Cells::IWorksheet::GetICharts ( )

pure virtual

Gets a IChart collection

◆ GetICheckBoxes()

virtual intrusive_ptr<Aspose::Cells::Drawing::ICheckBoxCollection> Aspose::Cells::IWorksheet::GetICheckBoxes ( )

pure virtual

Gets a ICheckBox collection.

◆ GetIComments()

virtual intrusive_ptr<Aspose::Cells::ICommentCollection> Aspose::Cells::IWorksheet::GetIComments ( )

pure virtual

Gets the IComment collection.

◆ GetIConditionalFormattings()

virtual intrusive_ptr<Aspose::Cells::IConditionalFormattingCollection> Aspose::Cells::IWorksheet::GetIConditionalFormattings ( )

pure virtual

Gets the ConditionalFormattings in the worksheet.

◆ GetICustomProperties()

virtual intrusive_ptr<Aspose::Cells::Properties::ICustomPropertyCollection> Aspose::Cells::IWorksheet::GetICustomProperties ( )

pure virtual

Gets an object representing the identifier information associated with a worksheet.

Worksheet.CustomProperties provide a preferred mechanism for storing arbitrary data. It supports legacy third-party document components, as well as those situations that have a stringent need for binary parts.

◆ GetIErrorCheckOptions()

virtual intrusive_ptr<Aspose::Cells::IErrorCheckOptionCollection> Aspose::Cells::IWorksheet::GetIErrorCheckOptions ( )

pure virtual

Gets error check setting applied on certain ranges.

◆ GetIHorizontalPageBreaks()

virtual intrusive_ptr<Aspose::Cells::IHorizontalPageBreakCollection> Aspose::Cells::IWorksheet::GetIHorizontalPageBreaks ( )

pure virtual

Gets the HorizontalPageBreakCollection collection.

◆ GetIHyperlinks()

virtual intrusive_ptr<Aspose::Cells::IHyperlinkCollection> Aspose::Cells::IWorksheet::GetIHyperlinks ( )

pure virtual

Gets the HyperlinkCollection collection.

◆ GetIListObjects()

virtual intrusive_ptr<Aspose::Cells::Tables::IListObjectCollection> Aspose::Cells::IWorksheet::GetIListObjects ( )

pure virtual

Gets all ListObjects in this worksheet.

◆ GetIndex()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IWorksheet::GetIndex ( )

pure virtual

Gets the index of sheet in the worksheet collection.

◆ GetIOleObjects()

virtual intrusive_ptr<Aspose::Cells::Drawing::IOleObjectCollection> Aspose::Cells::IWorksheet::GetIOleObjects ( )

pure virtual

Represents a collection of IOleObject in a worksheet.

◆ GetIOutline()

virtual intrusive_ptr<Aspose::Cells::IOutline> Aspose::Cells::IWorksheet::GetIOutline ( )

pure virtual

Gets the outline on this worksheet.

◆ GetIPageSetup()

virtual intrusive_ptr<Aspose::Cells::IPageSetup> Aspose::Cells::IWorksheet::GetIPageSetup ( )

pure virtual

Represents the page setup description in this sheet.

◆ GetIPanes()

virtual intrusive_ptr<Aspose::Cells::IPaneCollection> Aspose::Cells::IWorksheet::GetIPanes ( )

pure virtual

Gets the window panes.

If the window is not splitted or frozen.

◆ GetIPictures()

virtual intrusive_ptr<Aspose::Cells::Drawing::IPictureCollection> Aspose::Cells::IWorksheet::GetIPictures ( )

pure virtual

Gets a IPicture collection.

◆ GetIPivotTables()

virtual intrusive_ptr<Aspose::Cells::Pivot::IPivotTableCollection> Aspose::Cells::IWorksheet::GetIPivotTables ( )

pure virtual

Gets all pivot tables in this worksheet.

◆ GetIProtectedRangeCollection()

virtual intrusive_ptr<Aspose::Cells::IProtectedRangeCollection> Aspose::Cells::IWorksheet::GetIProtectedRangeCollection ( )

pure virtual

Gets the allow edit range collection in the worksheet.

◆ GetIProtection()

virtual intrusive_ptr<Aspose::Cells::IProtection> Aspose::Cells::IWorksheet::GetIProtection ( )

pure virtual

Represents the various types of protection options available for a worksheet. Supports advanced protection options in ExcelXP and above version.

This property can protect worksheet in all versions of Excel file and support advanced protection options in ExcelXP and above version.

◆ GetIScenarios()

virtual intrusive_ptr<Aspose::Cells::IScenarioCollection> Aspose::Cells::IWorksheet::GetIScenarios ( )

pure virtual

Gets the collection of Scenario

◆ GetIShapes()

virtual intrusive_ptr<Aspose::Cells::Drawing::IShapeCollection> Aspose::Cells::IWorksheet::GetIShapes ( )

pure virtual

Returns all drawing shapes in this worksheet.

◆ GetISparklineGroupCollection()

virtual intrusive_ptr<Aspose::Cells::Charts::ISparklineGroupCollection> Aspose::Cells::IWorksheet::GetISparklineGroupCollection ( )

pure virtual

Gets the sparkline group collection in the worksheet.

◆ GetISparklineGroups()

virtual intrusive_ptr<Aspose::Cells::Charts::ISparklineGroupCollection> Aspose::Cells::IWorksheet::GetISparklineGroups ( )

pure virtual

Gets the sparkline groups in the worksheet.

◆ GetITextBoxes()

virtual intrusive_ptr<Aspose::Cells::Drawing::ITextBoxCollection> Aspose::Cells::IWorksheet::GetITextBoxes ( )

pure virtual

Gets a ITextBoxe collection.

◆ GetIValidations()

virtual intrusive_ptr<Aspose::Cells::IValidationCollection> Aspose::Cells::IWorksheet::GetIValidations ( )

pure virtual

Gets the data validation setting collection in the worksheet.

◆ GetIVerticalPageBreaks()

virtual intrusive_ptr<Aspose::Cells::IVerticalPageBreakCollection> Aspose::Cells::IWorksheet::GetIVerticalPageBreaks ( )

pure virtual

Gets the VerticalPageBreakCollection collection.

◆ GetIWorkbook()

virtual intrusive_ptr<Aspose::Cells::IWorkbook> Aspose::Cells::IWorksheet::GetIWorkbook ( )

pure virtual

Gets the workbook object which contains this sheet.

◆ GetName()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IWorksheet::GetName ( )

pure virtual

Gets the name of the worksheet.

The max length of sheet name is 31. And you cannot assign same name (case insensitive) to two worksheets. For example, you cannot set "SheetName1" to the first worksheet and set "SHEETNAME1" to the second worksheet.

◆ GetPaneState()

virtual Aspose::Cells::PaneStateType Aspose::Cells::IWorksheet::GetPaneState ( )

pure virtual

Indicates whether the pane has horizontal or vertical splits, and whether those splits are frozen.

◆ GetPrintingPageBreaks()

virtual intrusive_ptr<Aspose::Cells::Systems::Array1D<Aspose::Cells::ICellArea*> > Aspose::Cells::IWorksheet::GetPrintingPageBreaks ( intrusive_ptr< Aspose::Cells::Rendering::IImageOrPrintOptions > options )

pure virtual

Gets automatic page breaks.

Parameters

options The print options

Returns: The automatic page breaks areas.

Each cell area represents a paper.

◆ GetSelectedRanges()

virtual intrusive_ptr<Aspose::Cells::Systems::Collections::ArrayList> Aspose::Cells::IWorksheet::GetSelectedRanges ( )

pure virtual

Gets selected ranges of cells in the designer spreadsheet.

Returns: An ArrayList which contains selected ranges.

◆ GetShowFormulas()

virtual bool Aspose::Cells::IWorksheet::GetShowFormulas ( )

pure virtual

Indicates whether to show formulas or their results.

◆ GetTabColor()

virtual intrusive_ptr<Aspose::Cells::Systems::Drawing::Color> Aspose::Cells::IWorksheet::GetTabColor ( )

pure virtual

Represents worksheet tab color.

This feature is only supported in ExcelXP(Excel2002) and later versions. If you save file as Excel97 or Excel2000 format, it will be omitted.

◆ GetTabId()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IWorksheet::GetTabId ( )

pure virtual

Specifies the internal identifier for the sheet.

◆ GetTransitionEntry()

virtual bool Aspose::Cells::IWorksheet::GetTransitionEntry ( )

pure virtual

Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.

◆ GetTransitionEvaluation()

virtual bool Aspose::Cells::IWorksheet::GetTransitionEvaluation ( )

pure virtual

Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.

◆ GetType()

virtual Aspose::Cells::SheetType Aspose::Cells::IWorksheet::GetType ( )

pure virtual

Represents worksheet type.

◆ GetUniqueId()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IWorksheet::GetUniqueId ( )

pure virtual

Gets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}.

◆ GetViewType()

virtual Aspose::Cells::ViewType Aspose::Cells::IWorksheet::GetViewType ( )

pure virtual

Gets and sets the view type.

◆ GetVisibilityType()

virtual Aspose::Cells::VisibilityType Aspose::Cells::IWorksheet::GetVisibilityType ( )

pure virtual

Indicates the visible state for this sheet.

◆ GetZoom()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IWorksheet::GetZoom ( )

pure virtual

Represents the scaling factor in percentage. It should be between 10 and 400.

Please set the view type first.

◆ HasAutofilter()

virtual bool Aspose::Cells::IWorksheet::HasAutofilter ( )

pure virtual

Indicates whether this worksheet has auto filter.

◆ IsGridlinesVisible()

virtual bool Aspose::Cells::IWorksheet::IsGridlinesVisible ( )

pure virtual

Gets a value indicating whether the gridlines are visible. Default is true.

◆ IsOutlineShown()

virtual bool Aspose::Cells::IWorksheet::IsOutlineShown ( )

pure virtual

Indicates whether to show outline.

◆ IsPageBreakPreview()

virtual bool Aspose::Cells::IWorksheet::IsPageBreakPreview ( )

pure virtual

Indicates whether the specified worksheet is shown in normal view or page break preview.

◆ IsProtected()

virtual bool Aspose::Cells::IWorksheet::IsProtected ( )

pure virtual

Indicates if the worksheet is protected.

◆ IsRowColumnHeadersVisible()

virtual bool Aspose::Cells::IWorksheet::IsRowColumnHeadersVisible ( )

pure virtual

Gets a value indicating whether the worksheet will display row and column headers. Default is true.

◆ IsRulerVisible()

virtual bool Aspose::Cells::IWorksheet::IsRulerVisible ( )

pure virtual

Indicates whether the ruler is visible. This property is only applied for page break preview.

◆ IsSelected()

virtual bool Aspose::Cells::IWorksheet::IsSelected ( )

pure virtual

Indicates whether this worksheet is selected when the workbook is opened.

◆ IsVisible()

virtual bool Aspose::Cells::IWorksheet::IsVisible ( )

pure virtual

Represents if the worksheet is visible.

◆ MoveTo()

virtual void Aspose::Cells::IWorksheet::MoveTo ( Aspose::Cells::Systems::Int32 index )

pure virtual

Moves the sheet to another location in the spreadsheet.

Parameters

index Destination sheet index.

◆ Protect() [1/2]

virtual void Aspose::Cells::IWorksheet::Protect ( Aspose::Cells::ProtectionType type )

pure virtual

Protects worksheet.

Parameters

type	Protection type.

This method protects worksheet without password. It can protect worksheet in all versions of Excel file.

◆ Protect() [2/2]

virtual void Aspose::Cells::IWorksheet::Protect	(	Aspose::Cells::ProtectionType	type,
		intrusive_ptr< Aspose::Cells::Systems::String >	password,
		intrusive_ptr< Aspose::Cells::Systems::String >	oldPassword
	)

pure virtual

Protects worksheet.

Parameters

type	Protection type.
password	Password.
oldPassword	If the worksheet is already protected by a password, please supply the old password. Otherwise, you can set a null value or blank string to this parameter.

This method can protect worksheet in all versions of Excel file.

[C++]
//Creating a file stream containing the Excel file to be opened
intrusive_ptr<FileStream> fstream = new FileStream(new String("C:\\book1.xls"), FileMode_Open);
//Instantiating a Workbook object and Opening the Excel file through the file stream
intrusive_ptr<IWorkbook> excel = Factory::CreateIWorkbook(fstream);
//Accessing the first worksheet in the Excel file
intrusive_ptr <IWorksheet> worksheet = excel->GetIWorksheets()->GetObjectByIndex(0);
//Protecting the worksheet with a password
//worksheet->Protect(ProtectionType_All, new String("aspose"), NULL);
//Saving the modified Excel file in default (that is Excel 20003) format
//excel->Save(new String("C:\\output.xls"));
//Closing the file stream to free all resources  
<br>

◆ RefreshPivotTables()

virtual void Aspose::Cells::IWorksheet::RefreshPivotTables ( )

pure virtual

Refreshes all the PivotTables in this Worksheet.

◆ release_ref()

virtual int Aspose::Cells::IWorksheet::release_ref ( )

inlinevirtual

◆ RemoveAllDrawingObjects()

virtual void Aspose::Cells::IWorksheet::RemoveAllDrawingObjects ( )

pure virtual

Removes all drawing objects in this worksheet.

◆ RemoveAutoFilter()

virtual void Aspose::Cells::IWorksheet::RemoveAutoFilter ( )

pure virtual

Removes the auto filter of the worksheet.

◆ RemoveSplit()

virtual void Aspose::Cells::IWorksheet::RemoveSplit ( )

pure virtual

Removes splitted window.

◆ Replace()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::IWorksheet::Replace	(	intrusive_ptr< Aspose::Cells::Systems::String >	oldString,
		intrusive_ptr< Aspose::Cells::Systems::String >	newString
	)

pure virtual

Replaces all cells' text with a new string.

Parameters

oldString	Old string value.
newString	New string value.

◆ SelectRange()

virtual void Aspose::Cells::IWorksheet::SelectRange	(	Aspose::Cells::Systems::Int32	startRow,
		Aspose::Cells::Systems::Int32	startColumn,
		Aspose::Cells::Systems::Int32	totalRows,
		Aspose::Cells::Systems::Int32	totalColumns,
		bool	removeOthers
	)

pure virtual

Selects a range.

Parameters

startRow	The start row.
startColumn	The start column
totalRows	The number of rows.
totalColumns	The number of columns
removeOthers	True means removing other selected range and only select this range.

◆ SetActiveCell()

virtual void Aspose::Cells::IWorksheet::SetActiveCell ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Sets the active cell in the worksheet.

◆ SetBackgroundImage()

virtual void Aspose::Cells::IWorksheet::SetBackgroundImage ( intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Byte >> value )

pure virtual

Sets worksheet background image.

◆ SetCodeName()

virtual void Aspose::Cells::IWorksheet::SetCodeName ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Sets worksheet code name.

◆ SetDisplayRightToLeft()

virtual void Aspose::Cells::IWorksheet::SetDisplayRightToLeft ( bool value )

pure virtual

Indicates if the specified worksheet is displayed from right to left instead of from left to right. Default is false.

◆ SetDisplayZeros()

virtual void Aspose::Cells::IWorksheet::SetDisplayZeros ( bool value )

pure virtual

True if zero values are displayed.

◆ SetFirstVisibleColumn()

virtual void Aspose::Cells::IWorksheet::SetFirstVisibleColumn ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represents first visible column index.

◆ SetFirstVisibleRow()

virtual void Aspose::Cells::IWorksheet::SetFirstVisibleRow ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represents first visible row index.

◆ SetGridlinesVisible()

virtual void Aspose::Cells::IWorksheet::SetGridlinesVisible ( bool value )

pure virtual

Sets a value indicating whether the gridlines are visible. Default is true.

◆ SetName()

virtual void Aspose::Cells::IWorksheet::SetName ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Sets the name of the worksheet.

The max length of sheet name is 31. And you cannot assign same name(case insensitive) to two worksheets. For example, you cannot set "SheetName1" to the first worksheet and set "SHEETNAME1" to the second worksheet.

◆ SetOutlineShown()

virtual void Aspose::Cells::IWorksheet::SetOutlineShown ( bool value )

pure virtual

Indicates whether to show outline.

◆ SetPageBreakPreview()

virtual void Aspose::Cells::IWorksheet::SetPageBreakPreview ( bool value )

pure virtual

Indicates whether the specified worksheet is shown in normal view or page break preview.

◆ SetRowColumnHeadersVisible()

virtual void Aspose::Cells::IWorksheet::SetRowColumnHeadersVisible ( bool value )

pure virtual

Sets a value indicating whether the worksheet will display row and column headers. Default is true.

◆ SetRulerVisible()

virtual void Aspose::Cells::IWorksheet::SetRulerVisible ( bool value )

pure virtual

Indicates whether the ruler is visible. This property is only applied for page break preview.

◆ SetSelected()

virtual void Aspose::Cells::IWorksheet::SetSelected ( bool value )

pure virtual

Indicates whether this worksheet is selected when the workbook is opened.

◆ SetShowFormulas()

virtual void Aspose::Cells::IWorksheet::SetShowFormulas ( bool value )

pure virtual

Indicates whether to show formulas or their results.

◆ SetTabColor()

virtual void Aspose::Cells::IWorksheet::SetTabColor ( intrusive_ptr< Aspose::Cells::Systems::Drawing::Color > value )

pure virtual

Represents worksheet tab color.

This feature is only supported in ExcelXP(Excel2002) and later versions. If you save file as Excel97 or Excel2000 format, it will be omitted.

◆ SetTabId()

virtual void Aspose::Cells::IWorksheet::SetTabId ( Aspose::Cells::Systems::Int32 value )

pure virtual

Specifies the internal identifier for the sheet.

◆ SetTransitionEntry()

virtual void Aspose::Cells::IWorksheet::SetTransitionEntry ( bool value )

pure virtual

Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.

◆ SetTransitionEvaluation()

virtual void Aspose::Cells::IWorksheet::SetTransitionEvaluation ( bool value )

pure virtual

Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.

◆ SetType()

virtual void Aspose::Cells::IWorksheet::SetType ( Aspose::Cells::SheetType value )

pure virtual

Represents worksheet type.

◆ SetUniqueId()

virtual void Aspose::Cells::IWorksheet::SetUniqueId ( intrusive_ptr< Aspose::Cells::Systems::String > value )

pure virtual

Sets the unique id, it is same as {15DB5C3C-A5A1-48AF-8F25-3D86AC232D4F}.

◆ SetViewType()

virtual void Aspose::Cells::IWorksheet::SetViewType ( Aspose::Cells::ViewType value )

pure virtual

Gets and sets the view type.

◆ SetVisibilityType()

virtual void Aspose::Cells::IWorksheet::SetVisibilityType ( Aspose::Cells::VisibilityType value )

pure virtual

Indicates the visible state for this sheet.

◆ SetVisible() [1/2]

virtual void Aspose::Cells::IWorksheet::SetVisible	(	bool	isVisible,
		bool	ignoreError
	)

pure virtual

Sets the visible options.

Parameters

isVisible	Whether the worksheet is visible
ignoreError	Whether to ignore error if this option is not valid.

◆ SetVisible() [2/2]

virtual void Aspose::Cells::IWorksheet::SetVisible ( bool value )

pure virtual

Represents if the worksheet is visible.

◆ SetZoom()

virtual void Aspose::Cells::IWorksheet::SetZoom ( Aspose::Cells::Systems::Int32 value )

pure virtual

Represents the scaling factor in percentage. It should be between 10 and 400.

Please set the view type first.

◆ Split()

virtual void Aspose::Cells::IWorksheet::Split ( )

pure virtual

Splits window.

◆ StartAccessCache()

virtual void Aspose::Cells::IWorksheet::StartAccessCache ( Aspose::Cells::AccessCacheOptions opts )

pure virtual

Starts the session that uses caches to access the data in this worksheet.

Parameters

opts	options of data access

After finishing the access to the data, CloseAccessCache(AccessCacheOptions) should be invoked with same options to clear all caches and recover normal access mode.

◆ ToString()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IWorksheet::ToString ( )

pure virtual

Returns a string represents the current Worksheet object.

Returns

◆ UnFreezePanes()

virtual void Aspose::Cells::IWorksheet::UnFreezePanes ( )

pure virtual

Unfreezes panes in the worksheet.

◆ Unprotect() [1/2]

virtual void Aspose::Cells::IWorksheet::Unprotect ( )

pure virtual

Unprotects worksheet.

This method unprotects worksheet which is protected without password.

◆ Unprotect() [2/2]

virtual void Aspose::Cells::IWorksheet::Unprotect ( intrusive_ptr< Aspose::Cells::Systems::String > password )

pure virtual

Unprotects worksheet.

Parameters

password Password

If the worksheet is protected without a password, you can set a null value or blank string to password parameter.

Public Member Functions

Detailed Description

Member Function Documentation

◆ add_ref()

◆ AddPageBreaks()

◆ AdvancedFilter()

◆ AutoFitColumn() [1/2]

◆ AutoFitColumn() [2/2]

◆ AutoFitColumns() [1/6]

◆ AutoFitColumns() [2/6]

◆ AutoFitColumns() [3/6]

◆ AutoFitColumns() [4/6]

◆ AutoFitColumns() [5/6]

◆ AutoFitColumns() [6/6]

◆ AutoFitRow() [1/4]

◆ AutoFitRow() [2/4]

◆ AutoFitRow() [3/4]

◆ AutoFitRow() [4/4]

◆ AutoFitRows() [1/5]

◆ AutoFitRows() [2/5]

◆ AutoFitRows() [3/5]

◆ AutoFitRows() [4/5]

◆ AutoFitRows() [5/5]

◆ CalculateFormula() [1/2]

◆ CalculateFormula() [2/2]

◆ CalculateFormulaByOption() [1/2]

◆ CalculateFormulaByOption() [2/2]

◆ ClearComments()

◆ CloseAccessCache()

◆ Copy() [1/2]

◆ Copy() [2/2]

◆ Dispose()

◆ FreezePanes() [1/2]

◆ FreezePanes() [2/2]

◆ GetActiveCell()

◆ GetBackgroundImage()

◆ GetCodeName()

◆ GetDisplayRightToLeft()

◆ GetDisplayZeros()

◆ GetFirstVisibleColumn()

◆ GetFirstVisibleRow()

◆ GetFreezedPanes()

◆ GetIAutoFilter()

◆ GetICells()

◆ GetICharts()

◆ GetICheckBoxes()

◆ GetIComments()

◆ GetIConditionalFormattings()

◆ GetICustomProperties()

◆ GetIErrorCheckOptions()

◆ GetIHorizontalPageBreaks()

◆ GetIHyperlinks()

◆ GetIListObjects()

◆ GetIndex()

◆ GetIOleObjects()

◆ GetIOutline()

◆ GetIPageSetup()

◆ GetIPanes()

◆ GetIPictures()

◆ GetIPivotTables()

◆ GetIProtectedRangeCollection()

◆ GetIProtection()

◆ GetIScenarios()

◆ GetIShapes()

◆ GetISparklineGroupCollection()

◆ GetISparklineGroups()

◆ GetITextBoxes()

◆ GetIValidations()

◆ GetIVerticalPageBreaks()

◆ GetIWorkbook()

◆ GetName()

◆ GetPaneState()

◆ GetPrintingPageBreaks()

◆ GetSelectedRanges()

◆ GetShowFormulas()

◆ GetTabColor()

◆ GetTabId()

◆ GetTransitionEntry()

◆ GetTransitionEvaluation()

◆ GetType()