RichTextContentControl.SetPlaceholderText Method

Displays text that is in a BuildingBlock, a Range, or a string as the placeholder text in the RichTextContentControl.

Namespace:  Microsoft.Office.Tools.Word
Assembly:  Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Syntax

'Declaration
Sub SetPlaceholderText ( _
    BuildingBlock As BuildingBlock, _
    Range As Range, _
    Text As String _
)

void SetPlaceholderText(
    BuildingBlock BuildingBlock,
    Range Range,
    string Text
)

Parameters

• BuildingBlock
  Type: Microsoft.Office.Interop.Word.BuildingBlock

  A BuildingBlock that contains the placeholder text.

• Range
  Type: Microsoft.Office.Interop.Word.Range

  A Range that contains the placeholder text.

• Text
  Type: System.String

  The placeholder text.

Remarks

The placeholder text is displayed until a user edits the control, the control is populated with data from a data source, or the control's contents are deleted.

Only one of the parameters is used when you call the SetPlaceholderText method. If more than one parameter is specified, Microsoft Office Word uses the first specified parameter. If all parameters are omitted, the placeholder text is an empty string.

To get the placeholder text of a RichTextContentControl, use the PlaceholderText property. You can also use this property to set the placeholder text to a string.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

RichTextContentControl Interface

Microsoft.Office.Tools.Word Namespace