Export (0) Print
Expand All

IDWriteTextFormat::GetTrimming method

Gets the trimming options for text that overflows the layout box.

Syntax


virtual HRESULT GetTrimming(
  [out]  DWRITE_TRIMMING * trimmingOptions,
  [out]  IDWriteInlineObject ** trimmingSign
) = 0;

Parameters

trimmingOptions [out]

Type: DWRITE_TRIMMING*

When this method returns, it contains a pointer to a DWRITE_TRIMMING structure that holds the text trimming options for the overflowing text.

trimmingSign [out]

Type: IDWriteInlineObject**

When this method returns, contains an address of a pointer to a trimming omission sign. This parameter may be NULL.

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft