DatePickerContentControl.PlaceholderText Property
Gets or sets the text that is displayed in the DatePickerContentControl until the text is changed by a user action or some other operation.
Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)
Syntax
'Declaration
Property PlaceholderText As String
string PlaceholderText { get; set; }
Property Value
Type: System.String
The text that is displayed in the control until the text is changed by a user action or some other operation.
Remarks
The placeholder text is displayed until a user selects a date or types a new value in the control, or the control is populated with data from a data source.
To set the placeholder text to text that is in a BuildingBlock or a Range, use the SetPlaceholderText method.
Examples
The following code example adds a new DatePickerContentControl to the beginning of the document. The example sets the PlaceholderText property to a string that prompts the user to choose a date.
This version is for a document-level customization. To use this code, paste it into the ThisDocument class in your project, and call the AddDatePickerControlAtSelection method from the ThisDocument_Startup method.
Dim datePickerControl1 As Microsoft.Office.Tools.Word.DatePickerContentControl
Private Sub AddDatePickerControlAtSelection()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Me.Paragraphs(1).Range.Select()
datePickerControl1 = Me.Controls.AddDatePickerContentControl("datePickerControl1")
datePickerControl1.DateDisplayFormat = "MMMM d, yyyy"
datePickerControl1.PlaceholderText = "Choose a date"
End Sub
private Microsoft.Office.Tools.Word.DatePickerContentControl datePickerControl1;
private void AddDatePickerControlAtSelection()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
this.Paragraphs[1].Range.Select();
datePickerControl1 = this.Controls.AddDatePickerContentControl("datePickerControl1");
datePickerControl1.DateDisplayFormat = "MMMM d, yyyy";
datePickerControl1.PlaceholderText = "Choose a date";
}
This version is for an application-level add-in. To use this code, paste it into the ThisAddIn class in your project, and call the AddDatePickerControlAtSelection method from the ThisAddIn_Startup method.
Dim datePickerControl1 As Microsoft.Office.Tools.Word.DatePickerContentControl
Private Sub AddDatePickerControlAtSelection()
If Me.Application.ActiveDocument Is Nothing Then
Return
End If
Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
vstoDoc.Paragraphs(1).Range.InsertParagraphBefore()
vstoDoc.Paragraphs(1).Range.Select()
datePickerControl1 = vstoDoc.Controls.AddDatePickerContentControl("datePickerControl1")
datePickerControl1.DateDisplayFormat = "MMMM d, yyyy"
datePickerControl1.PlaceholderText = "Choose a date"
End Sub
private Microsoft.Office.Tools.Word.DatePickerContentControl datePickerControl1;
private void AddDatePickerControlAtSelection()
{
if (this.Application.ActiveDocument == null)
return;
Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
vstoDoc.Paragraphs[1].Range.InsertParagraphBefore();
vstoDoc.Paragraphs[1].Range.Select();
datePickerControl1 = vstoDoc.Controls.AddDatePickerContentControl("datePickerControl1");
datePickerControl1.DateDisplayFormat = "MMMM d, yyyy";
datePickerControl1.PlaceholderText = "Choose a date";
}
.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.