XLL+ Class Library (6.3)

CXlOper Methods

The methods of the CXlOper class are listed here.

Construction

public method CXlOper Constructs a CXlOper object

Operations

public method Clear Reclaim resources from CXlOper

Comparisons

public method Compare Compare the contents of this CXlOper with another
public method operator != Compare the contents of this CXlOper with another
public method operator < Compare the contents of this CXlOper with another
public method operator <= Compare the contents of this CXlOper with another
public method operator == Compare the contents of this CXlOper with another
public method operator > Compare the contents of this CXlOper with another
public method operator >= Compare the contents of this CXlOper with another

Type inspection

public method IsArray Does the CXlOper contain an array?
public method IsBool Does the CXlOper contain a boolean?
public method IsDouble Does the CXlOper contain a double-precision floating point number?
public method IsEmpty Is the CXlOper empty?
public method IsError Does the CXlOper contain an error?
public method IsInt Does the CXlOper contain an integer?
public method IsMissing Is the CXlOper missing (i.e. omitted from the caller's argument list)?
public method IsMRef Does the CXlOper contain a multiple reference?
public method IsOfType Is the CXlOper of the specified type?
public method IsPresent Is the CXlOper not missing (i.e. not omitted from the caller's argument list)?
public method IsRef Does the CXlOper contain a reference?
public method IsScalar Does the CXlOper contain a single value?
public method IsSRef Does the CXlOper contain a single reference?
public method IsString Does the CXlOper contain a string?
public method IsValue Does the CXlOper contain one or more values?

Assignment operators

public method operator = Assigns a new value to the CXlOper, using a variety of input types

Output casting operators

public method operator [] Returns an item from an array
public method operator BOOL Returns a boolean value
public method operator bool Returns a boolean value
public method operator CString Returns a string value
public method operator double Returns a numeric value

Input functions

public method FromBool Assigns a boolean value and data type to the CXlOper
public method FromDouble Assigns an floating-point numeric value and data type to the CXlOper
public method FromDoubleArray Assigns the CXlOper to be an array of double's, and copies values into the array
public method FromError Assigns an error value and data type to the CXlOper
public method FromInt Assigns a single integer to the CXlOper
public method FromLongArray Assigns the CXlOper to be an array of double's wih integer values, and copies values into the array
public method FromMatrix Assigns a 2-dimensional array of numbers, booleans or strings to the CXlOper
public method FromMatrix2 Assigns a 2-dimensional array of numbers, booleans or strings to the CXlOper
public method FromMissing Sets the CXlOper to be a missing argument
public method FromMRef Assigns multiple range references to the CXlOper
public method FromNil Sets the CXlOper to be an empty argument
public method FromNumericMatrix Assigns a 2-dimensional array of numbers to the CXlOper
public method FromNumericVector Assigns a 1-dimensional array of numbers to the CXlOper
public method FromNumericVector2 Assigns a 1-dimensional array of numbers to the CXlOper
public method FromSRef Assigns a single range reference to the CXlOper
public method FromString Assigns a string value and data type to the CXlOper
public method FromVector Assigns a 1-dimensional array of numbers, booleans or strings to the CXlOper
public method FromVector2 Assigns a 1-dimensional array of numbers, booleans or strings to the CXlOper

Output functions

public method ToBool Returns a boolean value
public method ToDouble Retrieves a numeric value from the CXlOper
public method ToInt Returns an integer value
public method ToString Returns a string value

Array functions

public method AllocArray Assigns the CXlOper to be an array, sets it to a size and allocates the memory to contain its items
public method Cell Returns a reference to an item in an array
public method FreeArray Releases the resources of an array's items
public method GetCount Returns the number of cells in an array
public method GetCount2 Returns the number of cells in an array
public method GetDims Gets the number of rows and columns in an array
public method GetHeight Returns the number of rows in an array
public method GetHeight2 Returns the number of rows in an array
public method GetVectorCount Returns the number of cells in an array
public method GetVectorCount2 Returns the number of cells in an array
public method GetWidth Returns the number of columns in an array
public method GetWidth2 Returns the number of columns in an array
public method IsVector Returns TRUE if the CXlOper contains 1 row and/or 1 column
public method VectorCell Returns a reference to an item in a one-dimensional array

Matrix & vector functions

public method ReadMatrix Reads data from a 2-dimensional array into a matrix of numbers or strings
public method ReadVector Reads a row or a column from an array into a vector of numbers or strings

Reference functions

public method GetActiveCell Creates a reference to the active cell
public method GetRef Returns a copy of the first (or only) single reference in a single or multiple range reference
public method GetRefCount Returns the number of references in a multiple reference
public method GetRefItem Returns a copy of one of the single references in a multiple reference
public method GetSheetId Returns the SheetId of a CXlOper containing a reference
public method GetSheetName Returns the SheetName of a CXlOper containing a reference
public method GetSheetNameA Returns the SheetName of a CXlOper containing a reference
public method GetSheetNameW Returns the SheetName of a CXlOper containing a reference
public method MakeRef Creates a reference from an address
public method MakeRefA Creates a reference from an address
public method MakeRefIntl Creates a reference from an address in English
public method MakeRefIntlA Creates a reference from an address in English
public method MakeRefIntlW Creates a reference from an address in English
public method MakeRefW Creates a reference from an address
public method MoveRefBy Moves a reference by the specified number of rows and columns
public method Offset Returns a reference moved by the specified number of rows and columns
public method Resize Returns a reference resized to the specified number of rows and columns
public method SetActiveCell Sets the active cell to be the cell referred to by this CXlOper
public method SetRef Sets the first (or only) single reference in a single or multiple range reference
public method SetRefItem Sets one of the single references in a multiple reference

SDK interface

public method ChangeType Convert a CXlOper from one data type to another
public method Coerce Convert an Excel range into an array of values, forcing a recalculation if necessary
public method ConvertFormula Convert a formula between A1 and RC formats, using local language settings
public method ConvertFormulaA Convert a formula between A1 and RC formats, using local language settings
public method ConvertFormulaIntl Convert a formula between A1 and RC formats, using English language settings
public method ConvertFormulaIntlA Convert a formula between A1 and RC formats, using English language settings
public method ConvertFormulaIntlW Convert a formula between A1 and RC formats, using English language settings
public method ConvertFormulaW Convert a formula between A1 and RC formats, using local language settings
public method Evaluate Evaluate a formula expressed in local language
public method EvaluateIntl Evaluate a formula expressed in US English format
public method Excel Invoke the Excel SDK
public method GetCaller Retrieve a reference to the cell or cells that called the add-in function
public method GetFormula Get the formula in the referenced cell, in local format
public method GetFormulaA Get the formula in the referenced cell, in local format
public method GetFormulaIntl Get the formula in the referenced cell, in English
public method GetFormulaIntlA Get the formula in the referenced cell, in English
public method GetFormulaIntlW Get the formula in the referenced cell, in English
public method GetFormulaW Get the formula in the referenced cell, in local format
public method GetLongString Read a long string (of up to 1024 characters) from a single cell
public method GetLongStringA Read a long string (of up to 1024 characters) from a single cell
public method GetLongStringW Read a long string (of up to 1024 characters) from a single cell
public method SetFormula Set the formula of the referenced cell, in local format
public method SetFormulaA Set the formula of the referenced cell, in local format
public method SetFormulaIntl Set the formula of the referenced cell, in English
public method SetFormulaIntlA Set the formula of the referenced cell, in English
public method SetFormulaIntlW Set the formula of the referenced cell, in English
public method SetFormulaW Set the formula of the referenced cell, in local format
public method SetLongFormula Set the formula of the referenced cell, in local format, for formulae of more than 255 characters
public method SetLongFormulaA Set the formula of the referenced cell, in local format, for formulae of more than 255 characters
public method SetLongFormulaIntl Set the formula of the referenced cell, in English, for formulae of more than 255 characters
public method SetLongFormulaIntlA Set the formula of the referenced cell, in English, for formulae of more than 255 characters
public method SetLongFormulaIntlW Set the formula of the referenced cell, in English, for formulae of more than 255 characters
public method SetLongFormulaW Set the formula of the referenced cell, in local format, for formulae of more than 255 characters
public method SetValue Set the value of the referenced cells

Utilities

public method Format Fill the CXlOper with a formatted string (like sprintf() and CString::Format())
public method static method MissingArg Returns a placeholder to send to SDK calls as a missing argument
public method static method MissingArgP Returns a placeholder to send to SDK calls as a missing argument

Return handlers

public method CallAddin Call an add-in function directly, and store the result
public method Ret Prepares a CXlOper to be returned as a value to Excel
public method static method RetError Returns an error value to Excel
public method static method RetString Returns a string value to Excel
public method static method RetVal Returns a pointer to Excel's return value

Deprecated functions

public method ToDoubleArray Copies the contents of an OPER into a 'C' array of doubles or pointers to doubles

Requirements

Header: xllplus.h

See Also

CXlOper Class | xllplus.h

© 1997-2010 Planatech Solutions Ltd. All rights reserved.