Edit

ITextRange2::SetDropCap method (tom.h)

  • Article

Not implemented.

Sets the drop-cap parameters for the paragraph that contains the current range.

Syntax

HRESULT SetDropCap(
  [in] long cLine,
  [in] long Position
);

Parameters

[in] cLine

Type: long

The count of lines for drop cap. Zero means no drop cap.

[in] Position

Type: long

The position of drop cap. It can be one of the following.

tomDropMargin
tomDropNone
tomDropNormal

Return value

Type: HRESULT

If the method 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.

Return code Description
E_INVALIDARG
 Invalid argument.

Remarks

The current range can be degenerate, or you can select up to the complete drop-cap paragraph. If the range contains more than one paragraph, this method returns E_FAIL.

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 (include Tom.h)
DLL Msftedit.dll

See also

ITextRange2

ITextRange2::GetDropCap