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 | |
| tomBox | |
| tomBoxedFormula | |
| tomBrackets | |
| tomEquationArray | |
| tomMatrix | |
| tomNary | |
| tomPhantom | |
| tomRadical | tomShowDegPlaceHldr |
| tomSubSup | tomSubSupAlign |
| tomStretchStack |
[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 |
|
| tomNary | n-ary symbol |
| tomOpChar | Internal use for no-build operators |
| tomOverbar | U+00AF |
| tomPhantom |
|
| tomRadical |
|
| tomSlashedFraction |
|
| 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.
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 |