Skip to content

Latest commit

 

History

History
690 lines (519 loc) · 18.6 KB

nf-tom-itextrange2-getinlineobject.md

File metadata and controls

690 lines (519 loc) · 18.6 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:tom.ITextRange2.GetInlineObject
ITextRange2::GetInlineObject (tom.h)
Gets the properties of the inline object at the range active end.
GetInlineObject
GetInlineObject method [Windows Controls]
GetInlineObject method [Windows Controls]
ITextRange2 interface
ITextRange2 interface [Windows Controls]
GetInlineObject method
ITextRange2.GetInlineObject
ITextRange2::GetInlineObject
controls.itextrange2_getinlineobject
tom/ITextRange2::GetInlineObject
tomAccent
tomBox
tomBoxedFormula
tomBrackets
tomBracketsWithSeps
tomEquationArray
tomFraction
tomFunctionApply
tomHorzVert
tomLeftSubSup
tomLowerLimit
tomMatrix
tomNary
tomOpChar
tomOverbar
tomPhantom
tomRadical
tomRuby
tomSimpleText
tomSlashedFraction
tomStack
tomStretchStack
tomStyleDefault
tomStyleDisplay
tomStyleDisplayCramped
tomStyleScript
tomStyleScriptCramped
tomStyleScriptScript
tomStyleScriptScriptCramped
tomStyleText
tomStyleTextCramped
tomSubSup
tomSubscript
tomSuperscript
tomUnderbar
tomUpperLimit
tomWarichu
controls\itextrange2_getinlineobject.htm
Controls
0ed4a595-c3e8-4bfa-805f-4c5dfd5e3a56
12/05/2018
GetInlineObject, GetInlineObject method [Windows Controls], GetInlineObject method [Windows Controls],ITextRange2 interface, ITextRange2 interface [Windows Controls],GetInlineObject method, ITextRange2.GetInlineObject, ITextRange2::GetInlineObject, controls.itextrange2_getinlineobject, tom/ITextRange2::GetInlineObject, tomAccent, tomBox, tomBoxedFormula, tomBrackets, tomBracketsWithSeps, tomEquationArray, tomFraction, tomFunctionApply, tomHorzVert, tomLeftSubSup, tomLowerLimit, tomMatrix, tomNary, tomOpChar, tomOverbar, tomPhantom, tomRadical, tomRuby, tomSimpleText, tomSlashedFraction, tomStack, tomStretchStack, tomStyleDefault, tomStyleDisplay, tomStyleDisplayCramped, tomStyleScript, tomStyleScriptCramped, tomStyleScriptScript, tomStyleScriptScriptCramped, tomStyleText, tomStyleTextCramped, tomSubSup, tomSubscript, tomSuperscript, tomUnderbar, tomUpperLimit, tomWarichu
tom.h
Windows
Windows 8 [desktop apps only]
Windows Server 2012 [desktop apps only]
Msftedit.dll
Windows
19H1
ITextRange2::GetInlineObject
tom/ITextRange2::GetInlineObject
c++
APIRef
kbSyntax
COM
Msftedit.dll
ITextRange2.GetInlineObject

ITextRange2::GetInlineObject

-description

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

-parameters

-param pType [out]

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

-param pAlign [out]

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

-param pChar [out]

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

-param pChar1 [out]

Type: long*

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

-param pChar2 [out]

Type: long*

The separator character for tomBracketsWithSep:

U+007C: vertical bar with no extra spacing

U+2223: vertical bar with extra spacing

-param pCount [out]

Type: long*

The inline object count of arguments.

-param pTeXStyle [out]

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

-param pcCol [out]

Type: long*

The inline object count of columns (tomMatrix only).

-param pLevel [out]

Type: long*

The inline object 0-based nesting level.

-returns

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.

-see-also

ITextRange2

ITextRange2::SetInlineObject