Provides helper functions. More...

Inherits Object.

Static Public Member Functions
static Aspose::Cells::Systems::Int32	GetSignificantDigits ()
	Gets the number of significant digits. The default value is 17. More...

static void	SetSignificantDigits (Aspose::Cells::Systems::Int32 value)
	Sets the number of significant digits. The default value is 17. More...

static Aspose::Cells::Systems::Double	GetDPI ()
	Gets the DPI of the machine. More...

static void	SetDPI (Aspose::Cells::Systems::Double value)
	Gets the DPI of the machine. More...

static Aspose::Cells::Systems::Double	GetTextWidth (intrusive_ptr< Aspose::Cells::Systems::String > text, intrusive_ptr< Aspose::Cells::IFont > font, Aspose::Cells::Systems::Double scaling)
	Get width of text in unit of points. More...

static intrusive_ptr< Aspose::Cells::Systems::String >	GetVersion ()
	Get the release version. More...

static void	CellNameToIndex (intrusive_ptr< Aspose::Cells::Systems::String > cellName, Aspose::Cells::Systems::Int32 &row, Aspose::Cells::Systems::Int32 &column)
	Gets the cell row and column indexes according to its name. More...

static intrusive_ptr< Aspose::Cells::Systems::String >	CellIndexToName (Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column)
	Gets cell name according to its row and column indexes. More...

static intrusive_ptr< Aspose::Cells::Systems::String >	ColumnIndexToName (Aspose::Cells::Systems::Int32 column)
	Gets column name according to column index. More...

static Aspose::Cells::Systems::Int32	ColumnNameToIndex (intrusive_ptr< Aspose::Cells::Systems::String > columnName)
	Gets column index according to column name. More...

static intrusive_ptr< Aspose::Cells::Systems::String >	RowIndexToName (Aspose::Cells::Systems::Int32 row)
	Gets row name according to row index. More...

static Aspose::Cells::Systems::Int32	RowNameToIndex (intrusive_ptr< Aspose::Cells::Systems::String > rowName)
	Gets row index according to row name. More...

static intrusive_ptr< Aspose::Cells::Systems::String >	ConvertR1C1FormulaToA1 (intrusive_ptr< Aspose::Cells::Systems::String > r1c1Formula, Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column)
	Converts the r1c1 formula of the cell to A1 formula. More...

static intrusive_ptr< Aspose::Cells::Systems::String >	ConvertA1FormulaToR1C1 (intrusive_ptr< Aspose::Cells::Systems::String > formula, Aspose::Cells::Systems::Int32 row, Aspose::Cells::Systems::Int32 column)
	Converts A1 formula of the cell to the r1c1 formula. More...

static intrusive_ptr< Aspose::Cells::Systems::DateTime >	GetDateTimeFromDouble (Aspose::Cells::Systems::Double doubleValue, bool date1904)
	Convert the double value to the date time value. More...

static Aspose::Cells::Systems::Double	GetDoubleFromDateTime (intrusive_ptr< Aspose::Cells::Systems::DateTime > dateTime, bool date1904)
	Convert the date time to double value. More...

static intrusive_ptr< Aspose::Cells::Systems::String >	GetStartupPath ()
	Gets or sets the startup path, which is referred to by some external formula references. More...

static void	SetStartupPath (intrusive_ptr< Aspose::Cells::Systems::String > value)
	Sets the startup path, which is referred to by some external formula references. More...

static intrusive_ptr< Aspose::Cells::Systems::String >	GetAltStartPath ()
	Gets the alternate startup path, which is referred to by some external formula references. More...

static void	SetAltStartPath (intrusive_ptr< Aspose::Cells::Systems::String > value)
	Sets the alternate startup path, which is referred to by some external formula references. More...

static intrusive_ptr< Aspose::Cells::Systems::String >	GetLibraryPath ()
	Gets the library path which is referred to by some external formula references. More...

static void	SetLibraryPath (intrusive_ptr< Aspose::Cells::Systems::String > value)
	Sets the library path which is referred to by some external formula references. More...

static intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::Drawing::Color * > >	GetUsedColors (intrusive_ptr< Aspose::Cells::IWorkbook > workbook)
	Gets all used colors in the workbook. More...

static void	AddAddInFunction (intrusive_ptr< Aspose::Cells::Systems::String > function, Aspose::Cells::Systems::Int32 minCountOfParameters, Aspose::Cells::Systems::Int32 maxCountOfParameters, intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::ParameterType >> paramersType, Aspose::Cells::ParameterType functionValueType)
	Add addin function. More...

static void	MergeFiles (intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::String *>> files, intrusive_ptr< Aspose::Cells::Systems::String > cachedFile, intrusive_ptr< Aspose::Cells::Systems::String > destFile)
	Merges some large xls files to a xls file. More...

static intrusive_ptr< Aspose::Cells::Systems::String >	CreateSafeSheetName (intrusive_ptr< Aspose::Cells::Systems::String > nameProposal)
	Checks given sheet name and create a valid one when needed. If given sheet name conforms to the rules of excel sheet name, then return it. Otherwise string will be truncated if length exceeds the limit and invalid characters will be replaced with ' ', then return the rebuilt string value. More...

static intrusive_ptr< Aspose::Cells::Systems::String >	CreateSafeSheetName (intrusive_ptr< Aspose::Cells::Systems::String > nameProposal, Aspose::Cells::Systems::Char replaceChar)
	Checks given sheet name and create a valid one when needed. If given sheet name conforms to the rules of excel sheet name, then return it. Otherwise string will be truncated if length exceeds the limit and invalid characters will be replaced with given character, then return the rebuilt string value. More...

static bool	IsCloudPlatform ()
	Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc, More...

static void	SetCloudPlatform (bool value)
	Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc, More...

Detailed Description

Provides helper functions.

Member Function Documentation

◆ AddAddInFunction()

static void Aspose::Cells::ICellsHelper::AddAddInFunction	(	intrusive_ptr< Aspose::Cells::Systems::String >	function,
		Aspose::Cells::Systems::Int32	minCountOfParameters,
		Aspose::Cells::Systems::Int32	maxCountOfParameters,
		intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::ParameterType >>	paramersType,
		Aspose::Cells::ParameterType	functionValueType
	)

static

Add addin function.

Parameters

function	The function name.
minCountOfParameters	Minimum number of parameters this function requires
maxCountOfParameters	Maximum number of parameters this function allows.
paramersType	The excepted parameters type of the function
functionValueType	The function value type.

◆ CellIndexToName()

static intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ICellsHelper::CellIndexToName	(	Aspose::Cells::Systems::Int32	row,
		Aspose::Cells::Systems::Int32	column
	)

static

Gets cell name according to its row and column indexes.

Parameters

row	Row index.
column	Column index.

Returns: Name of cell.

◆ CellNameToIndex()

static void Aspose::Cells::ICellsHelper::CellNameToIndex	(	intrusive_ptr< Aspose::Cells::Systems::String >	cellName,
		Aspose::Cells::Systems::Int32 &	row,
		Aspose::Cells::Systems::Int32 &	column
	)

static

Gets the cell row and column indexes according to its name.

Parameters

cellName	Name of cell.
row	Output row index
column	Output column index

◆ ColumnIndexToName()

static intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ICellsHelper::ColumnIndexToName ( Aspose::Cells::Systems::Int32 column )

static

Gets column name according to column index.

Parameters

column Column index.

Returns: Name of column.

◆ ColumnNameToIndex()

static Aspose::Cells::Systems::Int32 Aspose::Cells::ICellsHelper::ColumnNameToIndex ( intrusive_ptr< Aspose::Cells::Systems::String > columnName )

static

Gets column index according to column name.

Parameters

columnName Column name.

Returns: Column index.

◆ ConvertA1FormulaToR1C1()

static intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ICellsHelper::ConvertA1FormulaToR1C1	(	intrusive_ptr< Aspose::Cells::Systems::String >	formula,
		Aspose::Cells::Systems::Int32	row,
		Aspose::Cells::Systems::Int32	column
	)

static

Converts A1 formula of the cell to the r1c1 formula.

Parameters

formula	The A1 formula.
row	The row index of the cell.
column	The column index of the cell.

Returns: The R1C1 formula.

◆ ConvertR1C1FormulaToA1()

static intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ICellsHelper::ConvertR1C1FormulaToA1	(	intrusive_ptr< Aspose::Cells::Systems::String >	r1c1Formula,
		Aspose::Cells::Systems::Int32	row,
		Aspose::Cells::Systems::Int32	column
	)

static

Converts the r1c1 formula of the cell to A1 formula.

Parameters

r1c1Formula	The r1c1 formula.
row	The row index of the cell.
column	The column index of the cell.

Returns: The A1 formula.

◆ CreateSafeSheetName() [1/2]

static intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ICellsHelper::CreateSafeSheetName ( intrusive_ptr< Aspose::Cells::Systems::String > nameProposal )

static

Checks given sheet name and create a valid one when needed. If given sheet name conforms to the rules of excel sheet name, then return it. Otherwise string will be truncated if length exceeds the limit and invalid characters will be replaced with ' ', then return the rebuilt string value.

Parameters

nameProposal sheet name to be used

Returns

◆ CreateSafeSheetName() [2/2]

static intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ICellsHelper::CreateSafeSheetName	(	intrusive_ptr< Aspose::Cells::Systems::String >	nameProposal,
		Aspose::Cells::Systems::Char	replaceChar
	)

static

Checks given sheet name and create a valid one when needed. If given sheet name conforms to the rules of excel sheet name, then return it. Otherwise string will be truncated if length exceeds the limit and invalid characters will be replaced with given character, then return the rebuilt string value.

Parameters

nameProposal	sheet name to be used
replaceChar	character which will be used to replace invalid characters in given sheet name

Returns

◆ GetAltStartPath()

static intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ICellsHelper::GetAltStartPath ( )

static

Gets the alternate startup path, which is referred to by some external formula references.

◆ GetDateTimeFromDouble()

static intrusive_ptr<Aspose::Cells::Systems::DateTime> Aspose::Cells::ICellsHelper::GetDateTimeFromDouble	(	Aspose::Cells::Systems::Double	doubleValue,
		bool	date1904
	)

static

Convert the double value to the date time value.

Parameters

doubleValue	The double value.
date1904	Date 1904 system.

Returns

◆ GetDoubleFromDateTime()

static Aspose::Cells::Systems::Double Aspose::Cells::ICellsHelper::GetDoubleFromDateTime	(	intrusive_ptr< Aspose::Cells::Systems::DateTime >	dateTime,
		bool	date1904
	)

static

Convert the date time to double value.

Parameters

dateTime	The date time.
date1904	Date 1904 system.

Returns

◆ GetDPI()

static Aspose::Cells::Systems::Double Aspose::Cells::ICellsHelper::GetDPI ( )

static

Gets the DPI of the machine.

◆ GetLibraryPath()

static intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ICellsHelper::GetLibraryPath ( )

static

Gets the library path which is referred to by some external formula references.

◆ GetSignificantDigits()

static Aspose::Cells::Systems::Int32 Aspose::Cells::ICellsHelper::GetSignificantDigits ( )

static

Gets the number of significant digits. The default value is 17.

Only could be 15 or 17 now.

◆ GetStartupPath()

static intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ICellsHelper::GetStartupPath ( )

static

Gets or sets the startup path, which is referred to by some external formula references.

◆ GetTextWidth()

static Aspose::Cells::Systems::Double Aspose::Cells::ICellsHelper::GetTextWidth	(	intrusive_ptr< Aspose::Cells::Systems::String >	text,
		intrusive_ptr< Aspose::Cells::IFont >	font,
		Aspose::Cells::Systems::Double	scaling
	)

static

Get width of text in unit of points.

Parameters

text	The text.
font	The font of the text.
scaling	The scaling of text.

Returns

◆ GetUsedColors()

static intrusive_ptr<Aspose::Cells::Systems::Array1D<Aspose::Cells::Systems::Drawing::Color*> > Aspose::Cells::ICellsHelper::GetUsedColors ( intrusive_ptr< Aspose::Cells::IWorkbook > workbook )

static

Gets all used colors in the workbook.

Parameters

workbook The workbook object.

Returns: The used colors.

◆ GetVersion()

static intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ICellsHelper::GetVersion ( )

static

Get the release version.

Returns: The release version.

◆ IsCloudPlatform()

static bool Aspose::Cells::ICellsHelper::IsCloudPlatform ( )

static

Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc,

◆ MergeFiles()

static void Aspose::Cells::ICellsHelper::MergeFiles	(	intrusive_ptr< Aspose::Cells::Systems::Array1D< Aspose::Cells::Systems::String *>>	files,
		intrusive_ptr< Aspose::Cells::Systems::String >	cachedFile,
		intrusive_ptr< Aspose::Cells::Systems::String >	destFile
	)

static

Merges some large xls files to a xls file.

Parameters

files	The files.
cachedFile	The cached file.
destFile	The dest file.

This method only supports merging data, style and formulas to the new file. The cached file is used to store some temporary data.

◆ RowIndexToName()

static intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::ICellsHelper::RowIndexToName ( Aspose::Cells::Systems::Int32 row )

static

Gets row name according to row index.

Parameters

row	Row index.

Returns: Name of row.

◆ RowNameToIndex()

static Aspose::Cells::Systems::Int32 Aspose::Cells::ICellsHelper::RowNameToIndex ( intrusive_ptr< Aspose::Cells::Systems::String > rowName )

static

Gets row index according to row name.

Parameters

rowName Row name.

Returns: Row index.

◆ SetAltStartPath()

static void Aspose::Cells::ICellsHelper::SetAltStartPath ( intrusive_ptr< Aspose::Cells::Systems::String > value )

static

Sets the alternate startup path, which is referred to by some external formula references.

◆ SetCloudPlatform()

static void Aspose::Cells::ICellsHelper::SetCloudPlatform ( bool value )

static

Please set this property True when running on a cloud platform, such as: Azure, AWSLambda, etc,

◆ SetDPI()

static void Aspose::Cells::ICellsHelper::SetDPI ( Aspose::Cells::Systems::Double value )

static

Gets the DPI of the machine.

◆ SetLibraryPath()

static void Aspose::Cells::ICellsHelper::SetLibraryPath ( intrusive_ptr< Aspose::Cells::Systems::String > value )

static

Sets the library path which is referred to by some external formula references.

◆ SetSignificantDigits()

static void Aspose::Cells::ICellsHelper::SetSignificantDigits ( Aspose::Cells::Systems::Int32 value )

static

Sets the number of significant digits. The default value is 17.

Only could be 15 or 17 now.

◆ SetStartupPath()

static void Aspose::Cells::ICellsHelper::SetStartupPath ( intrusive_ptr< Aspose::Cells::Systems::String > value )

static

Sets the startup path, which is referred to by some external formula references.

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AddAddInFunction()

◆ CellIndexToName()

◆ CellNameToIndex()

◆ ColumnIndexToName()

◆ ColumnNameToIndex()

◆ ConvertA1FormulaToR1C1()

◆ ConvertR1C1FormulaToA1()

◆ CreateSafeSheetName() [1/2]

◆ CreateSafeSheetName() [2/2]

◆ GetAltStartPath()

◆ GetDateTimeFromDouble()

◆ GetDoubleFromDateTime()

◆ GetDPI()

◆ GetLibraryPath()

◆ GetSignificantDigits()

◆ GetStartupPath()

◆ GetTextWidth()

◆ GetUsedColors()

◆ GetVersion()

◆ IsCloudPlatform()

◆ MergeFiles()

◆ RowIndexToName()

◆ RowNameToIndex()

◆ SetAltStartPath()

◆ SetCloudPlatform()

◆ SetDPI()

◆ SetLibraryPath()

◆ SetSignificantDigits()

◆ SetStartupPath()