ITextRange2::GetInlineObject method (tom.h)

Gets the properties of the inline object at the range active end.

Syntax

HRESULT GetInlineObject(
  [out] long *pType,
  [out] long *pAlign,
  [out] long *pChar,
  [out] long *pChar1,
  [out] long *pChar2,
  [out] long *pCount,
  [out] long *pTeXStyle,
  [out] long *pcCol,
  [out] long *pLevel
);

Parameters

[out] pType

Type: long*

The inline object type can be one of the following:

tomSimpleText

tomRuby

tomHorzVert

tomWarichu

tomAccent

tomBox

tomBoxedFormula

tomBrackets

tomBracketsWithSeps

tomEquationArray

tomFraction

tomFunctionApply

tomLeftSubSup

tomLowerLimit

tomMatrix

tomNary

tomOpChar

tomOverbar

tomPhantom

tomRadical

tomSlashedFraction

tomStack

tomStretchStack

tomSubscript

tomSubSup

tomSuperscript

tomUnderbar

tomUpperLimit

[out] pAlign

Type: long*

The inline object alignment, which can be one of these meanings depending on the inline object type:

Inline object type	Meaning of Align Parameter
tomRuby	tomRubyBelow tomRubyAlignCenter (default) tomRubyAlign010 tomRubyAlign121 tomRubyAlignLeft tomRubyAlignRight
tomBox	tomBoxAlignCenter tomSpaceMask tomSpaceDefault tomSpaceUnary tomSpaceBinary tomSpaceRelational tomSpaceSkip tomSpaceOrd tomSpaceDifferential tomSizeText tomSizeScript tomSizeScriptScript tomNoBreak tomTransparentForPositioning tomTransparentForSpacing
tomBoxedFormula	tomBoxHideTop tomBoxHideBottom tomBoxHideLeft tomBoxHideRight tomBoxStrikeH tomBoxStrikeV tomBoxStrikeTLBR tomBoxStrikeBLTR
tomBrackets	tomAlignDefault tomAlignCenter tomAlignMatchAscentDescent tomMathVariant
tomEquationArray	tomEqArrayLayoutWidth tomEqArrayAlignMask tomEqArrayAlignCenter tomEqArrayAlignTopRow tomEqArrayAlignBottomRow
tomMatrix	tomMatrixAlignMask tomMatrixAlignCenter tomMatrixAlignTopRow tomMatrixAlignBottomRow tomShowMatPlaceHldr
tomNary	tomLimitsDefault tomLimitsUnderOver tomLimitsSubSup tomUpperLimitAsSuperScript tomLimitsOpposite tomShowLLimPlaceHldr tomShowULimPlaceHldr tomDontGrowWithContent tomGrowWithContent
tomPhantom	tomPhantomShow tomPhantomZeroWidth tomPhantomZeroAscent tomPhantomZeroDescent tomPhantomTransparent
tomRadical	tomShowDegPlaceHldr
tomSubSup	tomSubSupAlign
tomStretchStack	tomStretchCharBelow tomStretchCharAbove tomStretchBaseBelow tomStretchBaseAbove

[out] pChar

Type: long*

The inline object character.

The value for each object type is shown in the following table..

Inline object type	Meaning of align parameter
tomAccent	Accent (U+0300—U+36F, U+20D0—U+20EF)
tomBoxedFormula	U+25AD for rectangle enclosure
tomBrackets	Opening bracket. Default: U+0028.
tomBracketsWithSeps	Opening bracket with separators. Default: U+0028
tomEquationArray	U+2588
tomFraction	Normal built-up fraction: U+002F; small numeric fraction: U+2298
tomFunctionApply	U+2061
tomLeftSubSup	U+005E
tomLowerLimit	U+252C
tomMatrix	U+25A0: no enclosing brackets U+24A8: enclosing parentheses (\pmatrix) U+24B1: enclosing vertical bars (\vmatrix) U+24A9: enclosing double vertical bars (\Vmatrix)
tomNary	n-ary symbol
tomOpChar	Internal use for no-build operators
tomOverbar	U+00AF
tomPhantom	U+27E1: full or custom phantom U+2B04: horizontal phantom U+21F3: vertical phantom U+2B06: ascent smash U+2B07: descent smash U+2B0C: horizontal smash U+2B0D: full smash
tomRadical	U+221A: square or nth root U+221B: cube root U+221C: fourth root
tomSlashedFraction	U+2044: skewed fraction U+2215: built-up linear fraction
tomStack	U+00A6
tomStretchStack	Horizontal stretch character (see Unicode Technical Note 28 Appendix B for a list)
tomSubscript	U+005E
tomSubSup	U+005E
tomSuperscript	U+005F
tomUnderbar	U+2581
tomUpperLimit	U+2534

[out] pChar1

Type: long*

The closing tomBrackets character. See Unicode Technical Note 28 Appendix B. Character Keywords and Properties for a list.

[out] pChar2

Type: long*

The separator character for tomBracketsWithSep:

U+007C: vertical bar with no extra spacing

U+2223: vertical bar with extra spacing

[out] pCount

Type: long*

The inline object count of arguments.

[out] pTeXStyle

Type: long*

The inline object TeX style, which can be one of the following values.

Note  The tomStyleDefault behavior depends on the context.

 

tomStyleDefault

tomStyleScriptScriptCramped

tomStyleScriptScript

tomStyleScriptCramped

tomStyleScript

tomStyleTextCramped

tomStyleText

tomStyleDisplayCramped

tomStyleDisplay

[out] pcCol

Type: long*

The inline object count of columns (tomMatrix only).

[out] pLevel

Type: long*

The inline object 0-based nesting level.

Return value

Type: HRESULT

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Remarks

Unicode Technical Note 28 describes the alignment and character values in detail when the active end character is an inline object start delimiter.

When that character is not a start delimiter, the character and column parameters are set to 0, the count is set to the 0-based argument index, and the other parameters are set according to the active-end character properties of the innermost inline object argument.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	tom.h
DLL	Msftedit.dll

See also

ITextRange2

ITextRange2::SetInlineObject