IHTMLTextAreaElement

IHTMLTextAreaElement


This interface specifies a multiline text input control.

The default font is fixed pitch.

IHTMLTextAreaElement 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  
select   put_onchange   get_onchange  
put_onselect   get_onselect   put_readOnly  
get_readOnly   put_rows   get_rows  
put_cols   get_cols   put_wrap  
get_wrap   createTextRange  

IHTMLTextAreaElement::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

IHTMLTextAreaElement::get_cols

HRESULT get_cols(
    long *p 
);

Retrieves the width, in columns (characters), of a TEXTAREA control.

p
Address of a variable that receives the number of columns.

See also put_cols

IHTMLTextAreaElement::get_defaultValue

HRESULT get_defaultValue(
    BSTR *p 
);

Retrieves the default value of the TEXTAREA element.

p
Address of a variable that receives the default value.

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

See also put_defaultValue

IHTMLTextAreaElement::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

IHTMLTextAreaElement::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

IHTMLTextAreaElement::get_name

HRESULT get_name(
    BSTR *p 
);

Retrieves the name of the TEXTAREA element.

p
Address of a string 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 in the entry field of the element. 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

IHTMLTextAreaElement::get_onchange

HRESULT get_onchange(
    VARIANT *p 
);

Retrieves the inline script associated with the onchange event for the TEXTAREA element. The onchange event occurs when the contents of the object have changed.

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

p
Address of a VARIANT structure that contains the script.

See also put_onchange

IHTMLTextAreaElement::get_onselect

HRESULT get_onselect(
    VARIANT *p 
);

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

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

p
Address of a VARIANT structure that contains the script.

See also put_onselect

IHTMLTextAreaElement::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

IHTMLTextAreaElement::get_rows

HRESULT get_rows(
    long *p 
);

Retrieves the height, in rows, of the TEXTAREA control.

p
Address of a variable that receives the number of rows.

See also put_rows

IHTMLTextAreaElement::get_status

HRESULT get_status(
    VARIANT *p 
);

Retrieves the status of the TEXTAREA element.

p
Address of a variable that receives the status. It can be TRUE, FALSE, or NULL.

See also put_status

IHTMLTextAreaElement::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.

IHTMLTextAreaElement::get_value

HRESULT get_value(
    BSTR *p 
);

Retrieves the current text from the entry field of the TEXTAREA element.

p
Address of a string variable that receives the text.

See also put_value

IHTMLTextAreaElement::get_wrap

HRESULT get_wrap(
    BSTR *p 
);

Retrieves how word-wrapping is handled in the element.

p
Address of a string variable that receives one of these strings:
off Word-wrapping is disabled. The lines appear exactly as the user types them. This is the default value for this property.
physical The text is displayed and submitted word-wrapped.
virtual The text is displayed word-wrapped but is submitted as typed.

See also put_wrap

IHTMLTextAreaElement::put_cols

HRESULT put_cols(
    long v 
);

Sets the width, in columns (characters), of the TEXTAREA control.

v
Long integer that receives the number of columns.

See also get_cols

IHTMLTextAreaElement::put_defaultValue

HRESULT put_defaultValue(
    BSTR v 
);

Sets the default value of the TEXTAREA element.

v
String specifying the default value.

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

See also get_defaultValue

IHTMLTextAreaElement::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

IHTMLTextAreaElement::put_name

HRESULT put_name(
    BSTR v 
);

Sets the name of the TEXTAREA element.

v
String specifying the name.

The name is used to bind the value of the element when submitting a form. The name is not the value that is displayed in the entry field of the element. 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

IHTMLTextAreaElement::put_onchange

HRESULT put_onchange(
    VARIANT v 
);

Sets the inline script associated with the onchange event for the TEXTAREA element. The onchange event occurs when the contents of the object have changed.

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

v
VARIANT structure that contains the script to be set.

See also get_onchange

IHTMLTextAreaElement::put_onselect

HRESULT put_onselect(
    VARIANT v 
);

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

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

v
VARIANT structure that contains the script to be set.

See also get_onselect

IHTMLTextAreaElement::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

IHTMLTextAreaElement::put_rows

HRESULT put_rows(
    long v 
);

Sets the height, in rows, of the TEXTAREA control.

v
Value specifying the number of rows.

See also get_rows

IHTMLTextAreaElement::put_status

HRESULT put_status(
    VARIANT v 
);

Sets the status of the TEXTAREA element.

v
Value specifying the status. Can be TRUE, FALSE, or NULL.

See also get_status

IHTMLTextAreaElement::put_value

HRESULT put_value(
    BSTR v 
);

Sets the text entry field of the TEXTAREA element, replacing any existing text.

v
String to place in the entry field of the element.

See also get_value

IHTMLTextAreaElement::put_wrap

HRESULT put_wrap(
    BSTR v 
);

Specifies how to handle word-wrapping in the element.

v
String specifying one of these values:
off Word-wrapping is disabled. The lines appear exactly as the user types them. This is the default value for this property.
physical The text is displayed and submitted word-wrapped.
virtual The text is displayed word-wrapped but is submitted as typed.

See also get_wrap

IHTMLTextAreaElement::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.

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