ITextPara::GetListType method (tom.h)

Retrieves the kind of numbering to use with paragraphs.

Syntax

HRESULT GetListType(
  long *pValue
);

Parameters

pValue

Type: long*

A variable that is of the following values to indicate the kind of list numbering.

tomListNone

tomListBullet

tomListNumberAsArabic

tomListNumberAsLCLetter

tomListNumberAsUCLetter

tomListNumberAsLCRoman

tomListNumberAsUCRoman

tomListNumberAsSequence

tomListNumberedCircle

tomListNumberedBlackCircleWingding

tomListNumberedWhiteCircleWingding

tomListNumberedArabicWide

tomListNumberedChS

tomListNumberedChT

tomListNumberedJpnChs

tomListNumberedJpnKor

tomListNumberedArabic1

tomListNumberedArabic2

tomListNumberedHebrew

tomListNumberedThaiAlpha

tomListNumberedThaiNum

tomListNumberedHindiAlpha

tomListNumberedHindiAlpha1

tomListNumberedHindiNum

By default, numbers are followed by a right parenthesis, for example: 1). However, pValue can include one of the following flags to indicate a different formatting.

tomListMinus

tomListParentheses

tomListPeriod

tomListPlain

Return value

Type: HRESULT

If ITextPara::GetListType succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Remarks

Values above 32 correspond to Unicode values for bullets.

The mobile Microsoft Office version of the rich edit control uses tomIgnoreNumberStyle to suppress setting the style.

The following Microsoft Visual Basic for Applications (VBA) example numbers the paragraphs in a range, starting with the number 2 and following the numbers with a period.

    range.Para.ListStart = 2
    range.Para.ListType = tomListNumberAsArabic + tomListPeriod

For an example of tomListNumberAsSequence, set ListStart to 0x2780, which gives you circled numbers. The Unicode Standard has examples of many more numbering sequences.

Requirements

See also

Conceptual

GetListStart

ITextPara

Reference

SetListStart

SetListType

Text Object Model