IXRTextBlock::SetLineHeight (Compact 2013)

3/28/2014

This method sets the height of each line of text in this text block.

Syntax

virtual HRESULT STDMETHODCALLTYPE SetLineHeight(
    float LineHeight
) = 0; 

Parameters

• LineHeight
  [in] A float value that indicates the new height, in pixels, of each line of text in this text block.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

If you set this value by calling IXRTextBlock::SetLineHeight, it does not change the height of the associated text. It changes the height of the line that contains the text. To change the size of the text, call IXRTextBlock::SetFontSize.

The layout of lines in an IXRTextBlock is affected by both the line height and by the line-stacking strategy. The value of LineHeight affects the layout of a text block control only when you pass the value XRLineStackingStrategy_BlockLineHeight into IXRTextBlock::SetLineStackingStrategy.

.NET Framework Equivalent

System.Windows.Controls.TextBlock.LineHeight

Requirements

See Also

Reference

IXRTextBlock
IXRTextBlock::GetLineHeight