Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: formula ::

service FormulaProperties
Description
The formula properties provide access to the properties of a formula in a formula generator

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

All properties containing relative values are related to this value.

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

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.