IDWriteTextFormat::SetTrimming method

Sets trimming options for text overflowing the layout width.

Syntax


virtual HRESULT SetTrimming(
  [inconst DWRITE_TRIMMING     * trimmingOptions,
             IDWriteInlineObject * trimmingSign
) = 0;

Parameters

trimmingOptions [in]

Type: const DWRITE_TRIMMING*

Text trimming options.

trimmingSign

Type: IDWriteInlineObject*

Application-defined omission sign. This parameter may be NULL. See IDWriteInlineObject for more information.

Return value

Type: HRESULT

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

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Header

Dwrite.h

Library

Dwrite.lib

DLL

Dwrite.dll

See also

IDWriteTextFormat

 

 

Show: