IHTMLInputTextElement

IHTMLInputTextElement


This interface specifies a form input control.

IHTMLInputTextElement Methods
get_type   put_value   get_value  
put_name   get_name   put_status  
get_status   put_disabled   get_disabled  
get_form   put_defaultValue   get_defaultValue  
put_size   get_size   put_maxLength  
get_maxLength   select   put_onchange  
get_onchange   put_onselect   get_onselect  
put_readOnly   get_readOnly   createTextRange  

IHTMLInputTextElement::get_type

HRESULT get_type(
    BSTR *p 
);

Retrieves the type of intrinsic control represented by the given element object.

p
Address of a variable that receives the type. The possible values depend on the element as listed in the following table.

Element Possible value Description
INPUT checkbox Used for simple Boolean attributes or for attributes that can take multiple values at the same time. It is represented by a number of check box fields, each of which has the same name. Each selected check box generates a separate name/value pair in the submitted data, even if this results in duplicate names. The default value for check boxes is on.
file A file upload element.
hidden No field is presented to the user, but the content of the field is sent with the submitted form. This value can be used to transmit state information about client/server interaction.
image An image field that you can click, causing the form to be immediately submitted. The coordinates of the selected point are measured in pixel units from the upper-left corner of the image, and are returned (along with the other contents of the form) in two name/value pairs. The x-coordinate is submitted under the name of the field with .x appended, and the y-coordinate is submitted under the name of the field with .y appended. Any value property is ignored. The image itself is specified by the SRC attribute, exactly as for the Image element.
password Same as the TEXT attribute, except that text is not displayed as the user enters it.
radio Used for attributes that accept a single value from a set of alternatives. Each radio-button field in the group should be given the same name. Only the selected radio button in the group generates a name/value pair in the submitted data. Radio buttons require an explicit value property.
reset reset is a button that when clicked resets the form's fields to their specified initial values. The label to be displayed on the button can be specified just as for the submit button.
submit submit is a button that when clicked submits the form. You can use the value attribute to provide a non-editable label to be displayed on the button. The default label is application-specific. If a submit button is clicked to submit the form, and that button has a name attribute specified, that button contributes a name/value pair to the submitted data. Otherwise, a submit button makes no contribution to the submitted data.
text Used for a single-line text-entry field. Use in conjunction with the size and maxLength properties.
SELECT select-multiple Specifies a multiple-select list box.
select-one Specifies a single-select list box.
TEXTAREA textarea Used for multiple-line text-entry fields. Use in conjunction with the size and maxLength properties.

IHTMLInputTextElement::put_value

HRESULT put_value(
    BSTR v 
);

Sets the default or "selected" value of the given control.

v
String specifying the value. It can be any valid string. The purpose of the string depends on the type of control, as described in the following table.
Control type Description
checkbox The "selected" value. The control submits this value only if the user has selected the control. Otherwise, the control submits no value.
file The value, a file name, typed by the user into the control. Unlike other controls, this value is read-only.
hidden The control submits this value when the form is submitted.
OPTION The "selected" value. The containing list box control submits this value only if the user has selected the option.
password The default value. The control displays this value when it is first created and when the user clicks the reset button.
radio The "selected" value. The control submits this value only if the user has selected the control. Otherwise, the control submits no value.
reset The button label. If not set, the label defaults to "Reset".
submit The button label. If not set, the label defaults to "Submit".
text The default value. The control displays this value when it is first created and when the user clicks the reset button.

See also get_value

IHTMLInputTextElement::get_value

HRESULT get_value(
    BSTR *p 
);

Retrieves the default or "selected" value of the given control.

p
Address of a variable that receives the value. It can be any valid string. The purpose of the string depends on the type of control, as described in the following table.
Control type Description
checkbox The "selected" value. The control submits this value only if the user has selected the control. Otherwise, the control submits no value.
file The value, a file name, typed by the user into the control. Unlike other controls, this value is read-only.
hidden The control submits this value when the form is submitted.
OPTION The "selected" value. The containing list box control submits this value only if the user has selected the option.
password The default value. The control displays this value when it is first created and when the user clicks the reset button.
radio The "selected" value. The control submits this value only if the user has selected the control. Otherwise, the control submits no value.
reset The button label. If not set, the label defaults to "Reset".
submit The button label. If not set, the label defaults to "Submit".
text The default value. The control displays this value when it is first created and when the user clicks the reset button.

See also put_value

IHTMLInputTextElement::put_name

HRESULT put_name(
    BSTR v 
);

Sets the name of the control, bookmark, or application.

v
String specifying the name.

The name is used to bind the value of the control when submitting a form. The NAME is not the value that is displayed for the button, reset, and submit objects. Submitting the form submits the internally stored value, not the one displayed.

JScript allows the name to be changed at run time. This does not change the name in the programming model, in the collection of elements, but does change the name used for submitting elements.

See also get_name

IHTMLInputTextElement::get_name

HRESULT get_name(
    BSTR *p 
);

Retrieves the name of the control, bookmark, or application.

p
Address of a variable that receives the name.

The name is used to bind the value of the control when submitting a form. The NAME is not the value that is displayed for the button, reset, and submit objects. Submitting the form submits the internally stored value, not the one displayed.

JScript allows the name to be changed at run time. This does not change the name in the programming model, in the collection of elements, but does change the name used for submitting elements.

See also put_name

IHTMLInputTextElement::put_status

HRESULT put_status(
    VARIANT v 
);

Sets the value of a checkbox or radio button. This property is equivalent to the value property for check boxes and radio buttons.

v
Value of the check box or radio button.

See also get_status

IHTMLInputTextElement::get_status

HRESULT get_status(
    VARIANT *p 
);

Retrieves the value of a checkbox or radio button. This property is equivalent to the value property for check boxes and radio buttons.

p
Address of a variable that receives the value.

See also put_status

IHTMLInputTextElement::put_disabled

HRESULT put_disabled(
    VARIANT_BOOL v 
);

Enables or disables the control. A disabled control appears dimmed and does not respond to user input.

v
Boolean value specifying whether to disable the control. If TRUE, the control is disabled; otherwise, it is enabled.

The default value for this property is FALSE.

See also get_disabled

IHTMLInputTextElement::get_disabled

HRESULT get_disabled(
    VARIANT_BOOL *p 
);

Determines whether the control is enabled or disabled.

p
Address of a variable that receives TRUE if the control is disabled, or FALSE otherwise.

The default value for this property is FALSE.

See also put_disabled

IHTMLInputTextElement::get_form

HRESULT get_form( 
    IHTMLFormElement **p 
);

Retrieves a reference to the form the element is embedded on.

p
Address of a variable that receives an interface pointer to the form element. This parameter receives NULL if the element is not on a form.

See also IHTMLFormElement

IHTMLInputTextElement::put_defaultValue

HRESULT put_defaultValue(
    BSTR v 
);

Sets the initial contents of a password or text control or the TEXTAREA element.

v
String specifying the initial contents.

This value can be changed programmatically but has no effect on the appearance, or on how forms are submitted.

See also get_defaultValue

IHTMLInputTextElement::get_defaultValue

HRESULT get_defaultValue(
    BSTR *p 
);

Retrieves the initial contents of a password or text control or the TEXTAREA element.

p
Address of a variable that receives the initial contents.

This value can be changed programmatically but has no effect on the appearance, or on how forms are submitted.

See also put_defaultValue

IHTMLInputTextElement::put_size

HRESULT put_size(
    long v 
);

Sets the size of the control.

v
Value specifying the size, in characters.

See also get_size

IHTMLInputTextElement::get_size

HRESULT get_size(
    long *p 
);

Retrieves the size of the control.

p
Address of a variable that receives the size, in characters.

See also put_size

IHTMLInputTextElement::put_maxLength

HRESULT put_maxLength(
    long v 
);

Sets the maximum number of characters that can be entered into a text control.

v
Value specifying the maximum number of characters.

This can be larger than the size of the text box. When this occurs, the text box should scroll accordingly as the user types. The default is there is no limit.

See also get_maxLength

IHTMLInputTextElement::get_maxLength

HRESULT get_maxLength( 
    long *p 
);

Retrieves the maximum number of characters that can be entered into a text control.

p
Address of a variable that receives the maximum number of characters.

This can be larger than the size of the text box. When this occurs, the text box should scroll accordingly as the user types. The default is there is no limit.

See also put_maxLength

IHTMLInputTextElement::select

HRESULT select(
    void 
);

Highlights the input area of a form element.

You can use the select method with the focus method to highlight a field and position the cursor for a user response.

IHTMLInputTextElement::put_onchange

HRESULT put_onchange(
    VARIANT v 
);

Sets the inline script associated with the onchange event on the INPUT text element. This occurs when the contents of the object have changed.

v
VARIANT structure that contains the script to be set.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also get_onchange

IHTMLInputTextElement::get_onchange

HRESULT get_onchange(
    VARIANT *p 
);

Retrieves the inline script associated with the onchange event on the INPUT text element. This occurs when the contents of the object have changed.

p
Address of a VARIANT structure that contains the script.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also put_onchange

IHTMLInputTextElement::put_onselect

HRESULT put_onselect(
    VARIANT v 
);

Sets the inline script associated with the onselect event on the INPUT text element. This event fires at the beginning of a user-initiated select. This event can be canceled, and it participates in the bubbling model.

v
VARIANT structure that contains the script to be set.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also get_onselect

IHTMLInputTextElement::get_onselect

HRESULT get_onselect(
    VARIANT * 
);

Retrieves the inline script associated with the onselect event on the INPUT text element. This event fires at the beginning of a user-initiated select. This event can be canceled, and it participates in the bubbling model.

p
Address of a VARIANT structure that contains the script.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also put_onselect

IHTMLInputTextElement::put_readOnly

HRESULT put_readOnly(
    VARIANT_BOOL v 
);

Specifies whether the element's contents are read-only, meaning that the user cannot enter or edit text in the control.

v
Read-only flag. TRUE sets the element to read-only; FALSE does not.

This is different than disabled. Read-only still allows the element to receive the focus, while disabled does not allow the element to receive the focus.

The default value for this property is FALSE.

See also get_readOnly

IHTMLInputTextElement::get_readOnly

HRESULT get_readOnly(
    VARIANT_BOOL *p 
);

Determines whether the element's contents are read-only, meaning that the user cannot enter or edit text in the control.

p
Address of a variable that receives TRUE if the element is read-only, or FALSE if not.

This is different than disabled. Read-only still allows the element to receive the focus, while disabled does not allow the element to receive the focus.

The default value for this property is FALSE.

See also put_readOnly

IHTMLInputTextElement::createTextRange

HRESULT createTextRange(
    IHTMLTxtRange **range 
);

Creates a text range object for the element. You use a text range to examine and modify the text within the element.

range
Address of a variable that receives an interface pointer to the text range.

See also IHTMLTxtRange

© 1997 Microsoft Corporation. All rights reserved. Terms of Use.