text Element

Article
07/02/2012

Applies To: Windows Server 2008

The text element sets the specified registry value to a specified text input value when a policy setting is enabled through the Local Group Policy Editor or Group Policy Management Console.

Syntax

<text id="<placeholderID>"
         clientExtension="<placeholderGUID>"
         key="<placeholderRegKey>"
         valuename="<placeholderName>"
         required="true|false" 
         maxLength="<placeholderMaxLength>"
         expandable="true|false" 
         soft="true\false" />

Attributes

Attributes	Required	Description
id Attribute	Yes	A mapping to the text element.
clientExtension Attribute	No	The client-side extension will process, on the client computer, the particular settings represented by the text element.
key Attribute	No	The registry key location under which the registry value will be created.
valueName Attribute	Yes	The registry value that will be configured for this specific policy element.
required Attribute	No	Requirement to enter a value in the parameter box.
maxLength Attribute	No	The maximum number of text characters.
expandable Attribute	No	The registry subkey value will be created as an expandable string type (REG_EXPAND_SZ) instead of a string type (REG_SZ).
soft Attribute	No	This attribute flags whether to overwrite an existing subkey.

Child elements

There are no child elements associated with this element.

Remarks

The text element will allow for string values up to 1023 characters long. The text element is generally associated with either a text box or a combo box parameter in the Local Group Policy Editor or GPMC.

The text element will require a matching text box or combo box presentation element in the corresponding .adml file with id that matches as declared in the text element.

Examples

This XML fragment is an example of a text element that is associated with a text box. The value will be stored as a text string, REG_SZ.

        <text id="Sample_TextboxPrompt" valueName="Example2textbox" />

This XML fragment is an example of a text element that will create a string value stored as an expandable string (REG_EXPAND_SZ). The text box in this case will require a value to be input before the policy setting change can be applied in the enabled state.

        <text id="Sample_textboxExpandszPrompt" 
                 valueName="Example2TextboxExpandsz" 
                  required="true" expand="true" />

Additional references

elements Element

textBox Element

comboBox Element

Share via