LibreOffice LibreOffice 25.2 SDK API Reference

Public Attributes | List of all members
FormulaProperties Service Referencepublished

The formula properties provide access to the properties of a formula in a formula generator. More...

`import"FormulaProperties.idl";`

## Public Attributes
short | Alignment
| contains the alignment of the formula. More...
short | BaseFontHeight
| contains the base font height in point the formula will be formatted in. More...
string | CustomFontNameFixed
| customized name for fixed font. More...
boolean | FontFixedIsItalic
| determines if the customized fixed font is italic. More...
boolean | FontFixedIsBold
| determines if the customized fixed font is bold. More...
string | CustomFontNameSans
| customized name for sans serif font More...
boolean | FontSansIsItalic
| determines if the customized sans serif font is italic. More...
boolean | FontSansIsBold
| determines if the customized sans serif font is bold. More...
string | CustomFontNameSerif
| customized name for serif font More...
boolean | FontSerifIsItalic
| determines if the customized serif font is italic. More...
boolean | FontSerifIsBold
| determines if the customized serif font is bold. More...
string | FontNameFunctions
| contains the name of the font that is used to display functions contained in the formula. More...
boolean | FontFunctionsIsItalic
| determines if the font that is used to display functions is italic. More...
boolean | FontFunctionsIsBold
| determines if the font that is used to display functions is bold. More...
string | FontNameNumbers
| contains the name of the font that is used to display numbers contained in the formula. More...
boolean | FontNumbersIsItalic
| determines if the font that is used to display numbers is italic. More...
boolean | FontNumbersIsBold
| determines if the font that is used to display numbers is bold. More...
string | FontNameText
| contains the name of the font that is used to display text contained in the formula. More...
boolean | FontTextIsItalic
| determines if the font that is used to display text is italic. More...
boolean | FontTextIsBold
| determines if the font that is used to display text is bold. More...
string | FontNameVariables
| contains the name of the font that is used to display variables contained in the formula. More...
boolean | FontVariablesIsItalic
| determines if the font that is used to display variables is italic. More...
boolean | FontVariablesIsBold
| determines if the font that is used to display variables is bold. More...
string | Formula
| contains the command string of the formula More...
boolean | IsScaleAllBrackets
| decides if all brackets (even those without "left"/"right" modifier) are scaled. More...
boolean | IsTextMode
| switches into text mode. More...
short | RelativeFontHeightFunctions
| contains the relative height of the font for functions. More...
short | RelativeFontHeightIndices
| contains the relative height of the font for indices. More...
short | RelativeFontHeightLimits
| contains the relative height of the font for limits. More...
short | RelativeFontHeightOperators
| contains the relative height of the font for operators. More...
short | RelativeFontHeightText
| contains the relative height of the font for text. More...
short | RelativeBracketDistance
| contains the relative distance of brackets. More...
short | RelativeBracketExcessSize
| contains the relative excess size of brackets. More...
short | RelativeFractionBarExcessLength
| contains the relative excess length of a fraction bar. More...
short | RelativeFractionBarLineWeight
| contains the relative line weight of a fraction bar. More...
short | RelativeFractionDenominatorDepth
| contains the relative depth of the denominator of a fraction More...
short | RelativeFractionNumeratorHeight
| contains the relative height of the numerator of a fraction. More...
short | RelativeIndexSubscript
| contains the relative superscript of indices. More...
short | RelativeIndexSuperscript
| contains the relative subscript of indices. More...
short | RelativeLineSpacing
| contains the relative line spacing. More...
short | RelativeLowerLimitDistance
| contains the relative distance of lower limits. More...
short | RelativeMatrixColumnSpacing
| contains the relative column spacing of matrices. More...
short | RelativeMatrixLineSpacing
| contains the relative line spacing of matrices. More...
short | RelativeOperatorExcessSize
| contains the relative excess of operators. More...
short | RelativeOperatorSpacing
| contains the relative spacing of operators. More...
short | RelativeRootSpacing
| contains the relative root spacing More...
short | RelativeScaleBracketExcessSize
| contains the relative scaling of the bracket excess. More...
short | RelativeSpacing
| contains the relative spacing. More...
short | RelativeSymbolMinimumHeight
| contains the relative minimum height of the formula. More...
short | RelativeSymbolPrimaryHeight
| contains the relative primary height of symbols. More...
short | RelativeUpperLimitDistance
| contains the relative distance of upper limits More...
short | TopMargin
| contains the metric value of the top margin of the formula. More...
short | BottomMargin
| contains the metric value of the bottom margin of the formula. More...
short | LeftMargin
| contains the metric value of the left margin of the formula. More...
short | RightMargin
| contains the metric value of the right margin of the formula. More...
short | BaseLine
| contains the baselines offset in respect to the top of the formula rectangle More...
boolean | IsRightToLeft
| switches into right-to-left layout. More...

## Detailed Description

The formula properties provide access to the properties of a formula in a formula generator.

## Member Data Documentation

## ◆ Alignment

short Alignment
| property

contains the alignment of the formula.

See also
  com::sun::star::style::HorizontalAlignment

## ◆ BaseFontHeight

short BaseFontHeight
| property

contains the base font height in point the formula will be formatted in.

All properties containing relative values are related to this value.

## ◆ BaseLine

short BaseLine
| optional property

contains the baselines offset in respect to the top of the formula rectangle

Since
  OOo 3.4

## ◆ BottomMargin

short BottomMargin
| property

contains the metric value of the bottom margin of the formula.

## ◆ CustomFontNameFixed

string CustomFontNameFixed
| property

customized name for fixed font.

## ◆ CustomFontNameSans

string CustomFontNameSans
| property

customized name for sans serif font

## ◆ CustomFontNameSerif

string CustomFontNameSerif
| property

customized name for serif font

## ◆ FontFixedIsBold

boolean FontFixedIsBold
| property

determines if the customized fixed font is bold.

## ◆ FontFixedIsItalic

boolean FontFixedIsItalic
| property

determines if the customized fixed font is italic.

## ◆ FontFunctionsIsBold

boolean FontFunctionsIsBold
| property

determines if the font that is used to display functions is bold.

## ◆ FontFunctionsIsItalic

boolean FontFunctionsIsItalic
| property

determines if the font that is used to display functions is italic.

## ◆ FontNameFunctions

string FontNameFunctions
| property

contains the name of the font that is used to display functions contained in the formula.

## ◆ FontNameNumbers

string FontNameNumbers
| property

contains the name of the font that is used to display numbers contained in the formula.

## ◆ FontNameText

string FontNameText
| property

contains the name of the font that is used to display text contained in the formula.

## ◆ FontNameVariables

string FontNameVariables
| property

contains the name of the font that is used to display variables contained in the formula.

## ◆ FontNumbersIsBold

boolean FontNumbersIsBold
| property

determines if the font that is used to display numbers is bold.

## ◆ FontNumbersIsItalic

boolean FontNumbersIsItalic
| property

determines if the font that is used to display numbers is italic.

## ◆ FontSansIsBold

boolean FontSansIsBold
| property

determines if the customized sans serif font is bold.

## ◆ FontSansIsItalic

boolean FontSansIsItalic
| property

determines if the customized sans serif font is italic.

## ◆ FontSerifIsBold

boolean FontSerifIsBold
| property

determines if the customized serif font is bold.

## ◆ FontSerifIsItalic

boolean FontSerifIsItalic
| property

determines if the customized serif font is italic.

## ◆ FontTextIsBold

boolean FontTextIsBold
| property

determines if the font that is used to display text is bold.

## ◆ FontTextIsItalic

boolean FontTextIsItalic
| property

determines if the font that is used to display text is italic.

## ◆ FontVariablesIsBold

boolean FontVariablesIsBold
| property

determines if the font that is used to display variables is bold.

## ◆ FontVariablesIsItalic

boolean FontVariablesIsItalic
| property

determines if the font that is used to display variables is italic.

## ◆ Formula

string Formula
| property

contains the command string of the formula

## ◆ IsRightToLeft

boolean IsRightToLeft
| optional property

switches into right-to-left layout.

Since
  LibreOffice 24.2

## ◆ IsScaleAllBrackets

boolean IsScaleAllBrackets
| property

decides if all brackets (even those without "left"/"right" modifier) are scaled.

## ◆ IsTextMode

boolean IsTextMode
| property

switches into text mode.

This is a mode where formulas are displayed the same height as a line of text.

## ◆ LeftMargin

short LeftMargin
| property

contains the metric value of the left margin of the formula.

## ◆ RelativeBracketDistance

short RelativeBracketDistance
| property

contains the relative distance of brackets.

## ◆ RelativeBracketExcessSize

short RelativeBracketExcessSize
| property

contains the relative excess size of brackets.

## ◆ RelativeFontHeightFunctions

short RelativeFontHeightFunctions
| property

contains the relative height of the font for functions.

The values unit is percent of the com::sun::star::formula::FormulaProperties::BaseFontHeight

## ◆ RelativeFontHeightIndices

short RelativeFontHeightIndices
| property

contains the relative height of the font for indices.

The values unit is percent of the com::sun::star::formula::FormulaProperties::BaseFontHeight

## ◆ RelativeFontHeightLimits

short RelativeFontHeightLimits
| property

contains the relative height of the font for limits.

The values unit is percent of the com::sun::star::formula::FormulaProperties::BaseFontHeight

## ◆ RelativeFontHeightOperators

short RelativeFontHeightOperators
| property

contains the relative height of the font for operators.

The values unit is percent of the com::sun::star::formula::FormulaProperties::BaseFontHeight

## ◆ RelativeFontHeightText

short RelativeFontHeightText
| property

contains the relative height of the font for text.

The values unit is percent of the com::sun::star::formula::FormulaProperties::BaseFontHeight

## ◆ RelativeFractionBarExcessLength

short RelativeFractionBarExcessLength
| property

contains the relative excess length of a fraction bar.

## ◆ RelativeFractionBarLineWeight

short RelativeFractionBarLineWeight
| property

contains the relative line weight of a fraction bar.

## ◆ RelativeFractionDenominatorDepth

short RelativeFractionDenominatorDepth
| property

contains the relative depth of the denominator of a fraction

## ◆ RelativeFractionNumeratorHeight

short RelativeFractionNumeratorHeight
| property

contains the relative height of the numerator of a fraction.

## ◆ RelativeIndexSubscript

short RelativeIndexSubscript
| property

contains the relative superscript of indices.

## ◆ RelativeIndexSuperscript

short RelativeIndexSuperscript
| property

contains the relative subscript of indices.

## ◆ RelativeLineSpacing

short RelativeLineSpacing
| property

contains the relative line spacing.

## ◆ RelativeLowerLimitDistance

short RelativeLowerLimitDistance
| property

contains the relative distance of lower limits.

## ◆ RelativeMatrixColumnSpacing

short RelativeMatrixColumnSpacing
| property

contains the relative column spacing of matrices.

## ◆ RelativeMatrixLineSpacing

short RelativeMatrixLineSpacing
| property

contains the relative line spacing of matrices.

## ◆ RelativeOperatorExcessSize

short RelativeOperatorExcessSize
| property

contains the relative excess of operators.

## ◆ RelativeOperatorSpacing

short RelativeOperatorSpacing
| property

contains the relative spacing of operators.

## ◆ RelativeRootSpacing

short RelativeRootSpacing
| property

contains the relative root spacing

## ◆ RelativeScaleBracketExcessSize

short RelativeScaleBracketExcessSize
| property

contains the relative scaling of the bracket excess.

## ◆ RelativeSpacing

short RelativeSpacing
| property

contains the relative spacing.

## ◆ RelativeSymbolMinimumHeight

short RelativeSymbolMinimumHeight
| property

contains the relative minimum height of the formula.

## ◆ RelativeSymbolPrimaryHeight

short RelativeSymbolPrimaryHeight
| property

contains the relative primary height of symbols.

## ◆ RelativeUpperLimitDistance

short RelativeUpperLimitDistance
| property

contains the relative distance of upper limits

## ◆ RightMargin

short RightMargin
| property

contains the metric value of the right margin of the formula.

## ◆ TopMargin

short TopMargin
| property

contains the metric value of the top margin of the formula.

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

- com/sun/star/formula/FormulaProperties.idl