Edit

Share via

IDWriteFactory::CreateEllipsisTrimmingSign method (dwrite.h)

  • Article

Creates an inline object for trimming, using an ellipsis as the omission sign.

Syntax

HRESULT CreateEllipsisTrimmingSign(
        IDWriteTextFormat   *textFormat,
  [out] IDWriteInlineObject **trimmingSign
);

Parameters

textFormat

Type: IDWriteTextFormat*

A text format object, created with CreateTextFormat, used for text layout.

[out] trimmingSign

Type: IDWriteInlineObject**

When this method returns, contains an address of a pointer to the omission (that is, ellipsis trimming) sign created by this method.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The ellipsis will be created using the current settings of the format, including base font, style, and any effects. Alternate omission signs can be created by the application by implementing IDWriteInlineObject.

Requirements

Requirement Value
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header dwrite.h
Library Dwrite.lib
DLL Dwrite.dll

See also

IDWriteFactory