CTextPara2 Class

Members (69)

Documentation

CTextPara2 Class

Class that wraps all the methods of the ITextPara and ITextPara2 interfaces.

---

ITextPara Interface

Text Object Model (TOM) rich text-range attributes are accessed through a pair of dual interfaces, ITextFont and ITextPara.

The ITextPara interface inherits from the IDispatch interface. ITextPara also has these types of members:

---

ITextPara2 Interface

The ITextPara2 interface extends ITextPara, providing the equivalent of the Microsoft Word format-paragraph dialog.

The ITextPara2 interface has these methods.

---

Methods inherited from CTextObjectBase Class

---

CONSTRUCTOR

Called when a CTextPara2 class variable is created.

CONSTRUCTOR (BYVAL pTextPara2 AS ITextPara2 PTR, BYVAL fAddRef AS BOOLEAN = FALSE)

Return value

A pointer to the new instance of the class.

---

DESTRUCTOR

Called automatically when a class variable goes out of scope or is destroyed.

DESTRUCTOR

---

GetLastResult

Returns the last result code

FUNCTION GetLastResult () AS HRESULT
   RETURN m_Result
END FUNCTION

---

SetResult

Sets the last result code.

FUNCTION SetResult (BYVAL Result AS HRESULT) AS HRESULT

---

GetErrorInfo

Returns a description of the last result code.

FUNCTION GetErrorInfo () AS DWSTRING

---

GetDuplicate

Gets a duplicate of this range object. In this implementation of the class, GetDuplicate and GetDuplicate2 are the same method.

FUNCTION GetDuplicate () AS ITextPara2 PTR

Return value

The duplicate of the range.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns one of the following COM error codes.

---

SetDuplicate

Sets the properties of this object by copying the properties of another text paragraph object. In this implementation of the class, SetDuplicate and SetDuplicate2 are the same method.

FUNCTION SetDuplicate (BYVAL pPara AS ITextPara2 PTR) AS HRESULT

Return value

If SetDuplicate2 succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

CanChange

Determines whether the paragraph formatting can be changed.

FUNCTION CanChange (BYVAL pPara AS ITextPara2 PTR) AS LONG

Return value

tomTrue if the paragraph formatting can be changed or tomFalse if it cannot be changed.

Result code

If paragraph formatting can change, CanChange succeeds and GetLastResult returns S_OK. If paragraph formatting cannot change, the method fails and returns S_FALSE.

---

IsEqual

Determines if the current range has the same properties as a specified range. In this implementation of the class, IsEqual and IsEqual2 are the same method.

FUNCTION IsEqual (BYVAL pPara AS ITextPara2 PTR) AS LONG

Return value

A tomBool value that is tomTrue if the text paragraph objects have the same properties, or tomFalse if they don't.

Result code

If paragraph formatting can change, IsEqual succeeds and GetLastResult returns S_OK. If paragraph formatting cannot change, the method fails and returns S_FALSE.

---

Reset

Determines whether the paragraph formatting can be changed.

FUNCTION Reset (BYVAL Value AS LONG) AS HRESULT

Return value

If Reset succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetStyle

Retrieves the style handle to the paragraphs in the specified range.

FUNCTION GetStyle () AS LONG

Return value

The paragraph style handle.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns one of the following COM error codes.

Remarks The Text Object Model (TOM) version 1.0 has no way to specify the meanings of user-defined style handles. They depend on other facilities of the text system implementing TOM. Negative style handles are reserved for built-in character and paragraph styles. Currently defined values are listed in the following table. For a description of the following styles, see the Microsoft Word documentation.

---

SetStyle

Sets the paragraph style for the paragraphs in a range.

FUNCTION SetStyle (BYVAL Value AS LONG) AS HRESULT

Return value

If SetStyle succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetAlignment

Retrieves the current paragraph alignment value.

FUNCTION GetAlignment () AS LONG

Return value

The paragraph alignment, which can be one of the following values.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns one of the following COM error codes.

---

SetAlignment

Sets the paragraph alignment.

FUNCTION SetAlignment (BYVAL Value AS LONG) AS HRESULT

Return value

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

GetHyphenation

Determines whether automatic hyphenation is enabled for the range.

FUNCTION GetHyphenation () AS LONG

Return value

One of the following values:

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns one of the following COM error codes.

Remarks

This property corresponds to the PFE_DONOTHYPHEN effect described in the PARAFORMAT2 structure.

---

SetHyphenation

Controls hyphenation for the paragraphs in the range.

FUNCTION SetHyphenation (BYVAL Value AS LONG) AS HRESULT

Return value

If SetHyphenation succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetFirstLineIndent

Retrieves the amount used to indent the first line of a paragraph relative to the left indent. The left indent is the indent for all lines of the paragraph except the first line.

FUNCTION GetFirstLineIndent () AS SINGLE

Return value

The first-line indentation amount in floating-point points.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns one of the following COM error codes.

Remarks

To set the first line indentation amount, call the SetIndents method.

To get and set the indent for all other lines of the paragraph (that is, the left indent), use GetLeftIndent and SetIndents.

---

GetKeepTogether

Determines whether page breaks are allowed within paragraphs.

FUNCTION GetKeepTogether () AS LONG

Return value

One of the following values.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns one of the following COM error codes.

Remarks

This property corresponds to the PFE_KEEP effect described in the PARAFORMAT2 structure.

---

SetKeepTogether

Controls whether page breaks are allowed within a paragraph in a range.

FUNCTION SetKeepTogether (BYVAL Value AS LONG) AS HRESULT

Return value

If SetKeepTogether succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetKeepWithNext

Determines whether page breaks are allowed between paragraphs in the range.

FUNCTION GetKeepWithNext () AS LONG

Return value

One of the following values.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns one of the following COM error codes.

Remarks

This property corresponds to the PFE_KEEPNEXT effect described in the PARAFORMAT2 structure.

---

SetKeepWithNext

Controls whether page breaks are allowed between the paragraphs in a range.

FUNCTION SetKeepWithNext (BYVAL Value AS LONG) AS HRESULT
   this.SetResult(m_pTextPara2->lpvtbl->SetKeepWithNext(m_pTextPara2, Value))
   RETURN m_Result
END FUNCTION

Return value

If SetKeepWithNext succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

Remarks

This property corresponds to the PFE_KEEPNEXT effect described in the PARAFORMAT2 structure.

---

GetLeftIndent

Retrieves the distance used to indent all lines except the first line of a paragraph. The distance is relative to the left margin.

FUNCTION GetLeftIndent () AS SINGLE

Return value

The left indentation, in floating-point points.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

GetLineSpacing

Retrieves the line-spacing value for the text range.

FUNCTION GetLineSpacing () AS SINGLE

Return value

The line-spacing value. The following table shows how this value is interpreted for the different line-spacing rules.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

GetLineSpacingRule

Retrieves the line-spacing rule for the text range.

FUNCTION GetLineSpacingRule () AS LONG

Return value

One of the following values that indicates the line-spacing rule.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

GetListAlignment

Retrieves the kind of alignment to use for bulleted and numbered lists.

FUNCTION GetListAlignment () AS LONG

Return value

One of the following values that indicates the kind of bullet and numbering alignment.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

SetListAlignment

Sets the alignment of bulleted or numbered text used for paragraphs.

FUNCTION SetListAlignment (BYVAL Value AS LONG) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetListLevelIndex

Retrieves the list level index used with paragraphs.

FUNCTION GetListLevelIndex () AS LONG

Return value

The list level index.

Up to three levels are common in HTML documents.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

SetListLevelIndex

Sets the list level index used for paragraphs.

FUNCTION SetListLevelIndex (BYVAL Value AS LONG) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetListStart

Retrieves the starting value or code of a list numbering sequence.

FUNCTION GetListStart () AS LONG

Return value

The starting value or code of a list numbering sequence.

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

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

Remarks

For a discussion on which sequence to use, see the GetListType method.

---

SetListStart

Sets the starting number or Unicode value for a numbered list.

FUNCTION SetListStart (BYVAL Value AS LONG) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

Remarks

Other characteristics of a list are specified by SetListType.

---

GetListTab

Retrieves the list tab setting, which is the distance between the first-line indent and the text on the first line. The numbered or bulleted text is left-justified, centered, or right-justified at the first-line indent value.

FUNCTION GetListTab () AS SINGLE

Return value

The list tab setting. The list tab value is in floating-point points.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

SetListTab

Sets the list tab setting, which is the distance between the first indent and the start of the text on the first line.

FUNCTION SetListTab (BYVAL Value AS SINGLE) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetListType

Retrieves the kind of numbering to use with paragraphs.

FUNCTION GetListType () AS LONG

Return value

One of the following values to indicate the kind of list numbering.

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

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

Remarks

Values above 32 correspond to Unicode values for bullets.

---

SetListType

Sets the type of list to be used for paragraphs.

FUNCTION SetListType (BYVAL Value AS LONG) AS HRESULT

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

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetNoLineNumber

Determines whether paragraph numbering is enabled.

FUNCTION GetNoLineNumber () AS LONG

Return value

One of the following values to indicate the kind of list numbering.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

Remarks

Paragraph numbering is when the paragraphs of a range are numbered. The number appears on the first line of a paragraph.

---

SetNoLineNumber

Determines whether to suppress line numbering of paragraphs in a range.

FUNCTION SetNoLineNumber (BYVAL Value AS LONG) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetPageBreakBefore

Determines whether each paragraph in the range must begin on a new page.

FUNCTION GetPageBreakBefore () AS LONG

Return value

One of the following values:

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

SetPageBreakBefore

Controls whether there is a page break before each paragraph in a range.

FUNCTION SetPageBreakBefore (BYVAL Value AS LONG) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

Remarks

This method is included for compatibility with Microsoft Word; it does not affect how the rich edit control displays text.

---

GetRightIndent

Retrieves the size of the right margin indent of a paragraph.

FUNCTION GetRightIndent () AS SINGLE

Return value

The right indentation, in floating-point points.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

SetRightIndent

Sets the right margin of paragraph.

FUNCTION SetRightIndent (BYVAL Value AS SINGLE) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

SetIndents

Sets the first-line indent, the left indent, and the right indent for a paragraph.

FUNCTION SetIndents (BYVAL First AS SINGLE, BYVAL Left AS SINGLE, BYVAL Right AS SINGLE) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

Remarks

Line indents are not allowed to position text in the margins. If the first-line indent is set to a negative value (for an outdented paragraph) while the left indent is zero, the first-line indent is reset to zero. To avoid this problem while retaining property sets, set the first-line indent value equal to zero either explicitly or by calling the Reset method. Then, call SetIndents to set a nonnegative, left-indent value and set the desired first-line indent.

---

SetLineSpacing

Sets the paragraph line-spacing rule and the line spacing for a paragraph.

FUNCTION SetLineSpacing (BYVAL Rule AS LONG, BYVAL Spacing AS SINGLE) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

Remarks

The line-spacing rule and line spacing work together, and as a result, they must be set together, much as the first and left indents need to be set together.

---

GetSpaceAfter

Retrieves the amount of vertical space below a paragraph.

FUNCTION GetSpaceAfter () AS SINGLE

Return value

The space-after value, in floating-point points.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

SetSpaceAfter

Sets the amount of space that follows a paragraph.

FUNCTION SetSpaceAfter (BYVAL Value AS SINGLE) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetSpaceBefore

Retrieves the amount of vertical space above a paragraph.

FUNCTION GetSpaceBefore () AS SINGLE

Return value

The space-before value, in floating-point points.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

SetSpaceBefore

Sets the amount of space preceding a paragraph.

FUNCTION SetSpaceBefore (BYVAL Value AS SINGLE) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetWidowControl

Retrieves the widow and orphan control state for the paragraphs in a range.

FUNCTION GetWidowControl () AS LONG

Return value

A tomBool value that indicates the state of widow and orphan control. It can be one of the following values.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

---

SetWidowControl

Controls the suppression of widows and orphans.

FUNCTION SetWidowControl (BYVAL Value AS LONG) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetTabCount

Retrieves the tab count.

FUNCTION GetTabCount () AS LONG

Return value

The tab count.

Result code

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

Remarks

The tab count of a new instance can be nonzero, depending on the underlying text engine. For example, Microsoft Word stories begin with no explicit tabs defined, while rich edit instances start with a single explicit tab. To be sure there are no explicit tabs (that is, to set the tab count to zero), call ClearAllTabs.

---

AddTab

Adds a tab at the displacement tbPos, with type tbAlign, and leader style, tbLeader.

FUNCTION AddTab (BYVAL tbPos AS SINGLE, BYVAL tbAlign AS LONG, BYVAL tbLeader AS LONG) AS HRESULT

Return value

If the method succeeds, GetLastResult returns S_OK. If the method fails, it returns the following COM error code.

Remarks

It is assumed that there is never a tab at position zero. If multiple paragraphs are described, the common subset of tabs will be returned with &h8000 in the upper word of the tab type.

---

ClearAllTabs

Clears all tabs, reverting to equally spaced tabs with the default tab spacing.

FUNCTION ClearAllTabs () AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

DeleteTab

Deletes a tab at a specified displacement.

FUNCTION DeleteTab (BYVAL tbPos AS SINGLE) AS HRESULT

Return value

If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetTab

Retrieves tab parameters (displacement, alignment, and leader style) for a specified tab.

FUNCTION GetTab (BYVAL iTab AS LONG, BYVAL ptbPos AS SINGLE PTR, BYVAL ptbAlign AS LONG PTR, _
   BYVAL ptbLeader AS LONG PTR) AS HRESULT

Return value

If GetTab succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes.

---

GetBorders

Not implemented. Gets the borders collection.

FUNCTION GetBorders () AS IUnknown PTR

Return value

The borders collection.

Result code

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

---

GetFontAlignment

Gets the paragraph font alignment state.

FUNCTION GetFontAlignment () AS LONG

Return value

The paragraph font alignment state. It can be one of the following values.

Result code

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

---

SetFontAlignment

Sets the paragraph font alignment for Chinese, Japanese, Korean text.

FUNCTION SetFontAlignment (BYVAL Value AS LONG) AS HRESULT

Return value

The paragraph font alignment state. It can be one of the following values.

Return value

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

---

GetHangingPunctuation

Gets whether to hang punctuation symbols on the right margin when the paragraph is justified.

FUNCTION GetHangingPunctuation () AS LONG

Return value

A tomBool value that can be one of the following.

Result code

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

---

SetHangingPunctuation

Sets whether to hang punctuation symbols on the right margin when the paragraph is justified.

FUNCTION SetHangingPunctuation (BYVAL Value AS LONG) AS HRESULT

Return value

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

---

GetSnapToGrid

Gets whether paragraph lines snap to a vertical grid that could be defined for the whole document.

FUNCTION GetSnapToGrid () AS LONG

Return value

A tomBool value that can be one of the following.

Result code

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

---

SetSnapToGrid

Sets whether paragraph lines snap to a vertical grid that could be defined for the whole document.

FUNCTION SetSnapToGrid (BYVAL Value AS LONG) AS HRESULT

Return value

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

---

GetTrimPunctuationAtStart

Gets whether to trim the leading space of a punctuation symbol at the start of a line.

FUNCTION GetTrimPunctuationAtStart () AS LONG

Return value

A tomBool value that can be one of the following.

Result code

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

---

SetTrimPunctuationAtStart

Sets whether to trim the leading space of a punctuation symbol at the start of a line.

FUNCTION SetTrimPunctuationAtStart (BYVAL Value AS LONG) AS HRESULT

Return value

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

---

GetEffects

Gets the paragraph format effects.

FUNCTION GetEffects (BYVAL pValue AS LONG PTR, BYVAL pMask AS LONG PTR) AS HRESULT

Return value

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

Remarks

If the tomTable flag is set, you can use the GetTable method to get more table properties.

---

SetEffects

Sets the paragraph format effects.

FUNCTION SetEffects (BYVAL Value AS LONG, BYVAL Mask AS LONG) AS HRESULT

Return value

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

---

GetProperty

Gets the value of the specified property.

FUNCTION GetProperty (BYVAL nType AS LONG) AS LONG

Return value

The property value.

Result code

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

Remarks

The tomParaPropMathAlign property sets the math alignment for math paragraphs in a text paragraph. It can have one of the following values.

---

SetProperty

Sets the value of the specified property.

FUNCTION SetProperty (BYVAL nType AS LONG, BYVAL Value AS LONG) AS HRESULT

Return value

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

Remarks

The tomParaPropMathAlign property sets the math alignment for math paragraphs in a text paragraph. It can have one of the following values.

---