LibreOffice
LibreOffice 25.8 SDK API Reference
Loading...
Searching...
No Matches
FormulaParser Service Reference

import "FormulaParser.idl";

Inheritance diagram for FormulaParser:
PropertySet XFormulaParser XPropertySet XFastPropertySet XMultiPropertySet XPropertyAccess XPropertyState XInterface XInterface XInterface XInterface XInterface

Public Types

typedef sequence< FormulaOpCodeMapEntryOpCodeMap
 contains the complete mapping of names to op-codes.
typedef sequence< ExternalLinkInfoExternalLinks
 contains a list of external links referenced in formulas.

Included Services

service com::sun::star::beans::PropertySet

Exported Interfaces

interface XFormulaParser
Exported Interfaces inherited from PropertySet
interface com::sun::star::beans::XPropertySet
interface com::sun::star::beans::XFastPropertySet
interface com::sun::star::beans::XMultiPropertySet
interface com::sun::star::beans::XPropertyAccess
interface com::sun::star::beans::XPropertyState

Public Attributes

boolean CompileEnglish
 specifies whether to use English parser and formatter.
short FormulaConvention
 specifies which address reference style convention to use when parsing a formula string.
boolean IgnoreLeadingSpaces
string ParameterSeparator
boolean RefConventionChartOOXML
 specifies that use special ooxml chart syntax in case of OOXML reference convention, when parsing a formula string.

Additional Inherited Members

Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name.
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property.
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list.
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName.
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list.
Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object.
void acquire ()
 increases the reference counter by one.
void release ()
 decreases the reference counter by one.
Public Member Functions inherited from XFormulaParser
sequence< FormulaTokenparseFormula ([in] string aFormula, [in] ::com::sun::star::table::CellAddress aReferencePos)
 parses a formula into a sequence of tokens.
string printFormula ([in] sequence< FormulaToken > aTokens, [in] ::com::sun::star::table::CellAddress aReferencePos)
 converts a formula into a string.
Protected Member Functions inherited from XFastPropertySet
void setFastPropertyValue ([in] long nHandle, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value to the property with the specified name.
any getFastPropertyValue ([in] long nHandle) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
Protected Member Functions inherited from XMultiPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
void setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the values to the properties with the specified names.
sequence< any > getPropertyValues ([in] sequence< string > aPropertyNames)
void addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
 adds an XPropertiesChangeListener to the specified property with the specified names.
void removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener)
 removes an XPropertiesChangeListener from the listener list.
void firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
 fires a sequence of PropertyChangeEvents to the specified listener.
Protected Member Functions inherited from XPropertyAccess
sequence< com::sun::star::beans::PropertyValuegetPropertyValues ()
void setPropertyValues ([in] sequence< com::sun::star::beans::PropertyValue > aProps) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the values of given properties.
Protected Member Functions inherited from XPropertyState
com::sun::star::beans::PropertyState getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
sequence< com::sun::star::beans::PropertyStategetPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
void setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
 Sets the property to default value.
any getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

Member Typedef Documentation

◆ ExternalLinks

sequence< ExternalLinkInfo > ExternalLinks
property

contains a list of external links referenced in formulas.

Use of this property depends on the FormulaConvention in use. It is relevant only for AddressConvention::XL_OOX to map indices to external documents. The sequence must be in the order of indices used. Note that indices are 1-based, the sequence must start with an empty element.

Since
OOo 3.1

◆ OpCodeMap

sequence< FormulaOpCodeMapEntry > OpCodeMap
property

contains the complete mapping of names to op-codes.

Names and symbols not defined here lead to a parser/print error.

Exported Interfaces

◆ com::sun::star::beans::PropertySet

Exported Interfaces

◆ XFormulaParser

interface XFormulaParser

Member Data Documentation

◆ CompileEnglish

boolean CompileEnglish
property

specifies whether to use English parser and formatter.

Note: When changing this, an already existing OpCodeMap needs to be recreated internally, so for performance reasons set this before setting the OpCodeMap.

◆ FormulaConvention

short FormulaConvention
property

specifies which address reference style convention to use when parsing a formula string.

See also
AddressConvention

◆ IgnoreLeadingSpaces

boolean IgnoreLeadingSpaces
property

◆ ParameterSeparator

string ParameterSeparator
property

◆ RefConventionChartOOXML

boolean RefConventionChartOOXML
property

specifies that use special ooxml chart syntax in case of OOXML reference convention, when parsing a formula string.

Special syntax like: [0]!GlobalNamedRange, LocalSheet!LocalNamedRange

Since
LibreOffice 7.3

The documentation for this service was generated from the following file: