ASP.NET Futures (July 2007): AJAX Client Script Reference
This section provides reference documentation for client classes introduced for ASP.NET
AJAX Extensions. Not all classes are currently covered. There are modifications that have occurred in the Futures (July 2007) release,
as documented in the Change List.
Sys.Component.createMultiple Method |
Top |
|
Creates multiple components of a specified type for a number of DOM elements.
|
Sys.Component.createMultiple(elements, type, properties, events, references)
|
| Parameter | Type | Description |
| elements |
Array |
An array of DOM elements to associate components with. |
| type |
Type |
The type of the component to create. |
| properties |
Object |
A JSON object that represents the component's properties and their values. This
parameter can be null. |
| events |
Object |
A JSON object that represents the component's events and corresponding handlers.
This parameter can be null. |
| references |
Object |
A JSON object contains name/ID pairs that represent properties that are references
to other components. This parameter can be null. |
Return Value: None.
Sys.UI.DomElement.getElementsByClassName Method |
Top |
|
Returns an array of DOM elements that have a specified CSS class name.
|
Sys.UI.DomElement.getElementsByClassName(className, element)
|
|
Parameter |
Type |
Description |
|
className |
String |
The CSS class name to match. |
|
element |
DOM element |
The parent DOM element to search. This parameter can be null; in that
case, the search begins at the top-most element in the page. |
Return Value: An Array object containing DOM elements.
Sys.UI.DomElement.selectAllElements Method
|
Top |
|
Returns an array of DOM elements that have a specified CSS selector.
|
Sys.UI.DomElement.selectAllElements(selector, element)
|
|
Parameter |
Type |
Description |
|
selector |
String |
The CSS selector name to match. |
|
element |
DOM element |
The parent DOM element to search. This parameter can be null; in that
case, the search begins at the top-most element in the page. |
Return Value: An Array object containing DOM elements.
Sys.UI.DomElement.selectElement Method
|
Top |
|
Returns an array of DOM elements that have a specified CSS selector.
|
Sys.UI.DomElement.selectElement(selector, element)
|
|
Parameter |
Type |
Description |
|
selector |
String |
The CSS selector name to match. |
|
element |
Object |
The parent DOM element to search. This parameter can be null; in that
case, the search begins at the top-most element in the page. |
Return Value: A DOM element that matches the specific selector. The first element is returned, or
null if no match is found.
The Sys.Preview._History object is private. You access the object through the
Sys.Application.get_history() function.
Sys.Application history Property
|
Top |
|
Returns the history object, which you can use to manage history in the application.
You should access the history object only through this property.
|
Sys.Application.get_History()
|
Return Value: The Sys.Preview._History object.
Sys.Application.get_history(). stateString Property
|
Top |
|
Gets the unencoded state string from the URL.
|
Sys.Application.get_stateString()
|
Return Value: A string that represents the current history state of the page.
Sys.Application.get_history().addHistoryPoint() Method
|
Top |
|
Adds an entry with the specified state to the browser's history stack.
|
Sys.Application.get_history().addHistoryPoint(state)
|
|
Parameter |
Type |
Description |
|
state |
Object |
A JSON object of name/value pairs. These pairs are defined by the user. |
Return Value: None.
Sys.Application.get_history() navigate Event
|
Top |
|
Adds or removes a handler for the navigate event, which is raised after
the Sys.Application.load event.
|
Sys.Application.get_history().add_navigate(handler)
Sys.Application.get_history().remove_navigate(handler)
|
|
Parameter |
Type |
Description |
|
handler |
Function |
A function that represents the event handler. |
Return Value: None.
Sys.Application.get_history().initialize() Method
|
Top |
|
Initializes the history object. This member supports the client-script infrastructure
and is not intended to be used directly from your code. The history object is initialized
the first time it is accessed.
|
Sys.Application.get_history().initialize()
|
Return Value: None.
Sys.Application.get_history(). setServerId Method
|
Top |
Sets the unique ID and the client ID for the History server control.
This member supports the client-script infrastructure and is not intended to be
used directly from your code.
|
Sys.Application.get_history().setServerId(uniqueId, clientId)
|
|
Parameter |
Type |
Description |
|
uniqueId |
String |
The History control's unique server ID. |
|
clientId |
String |
The History control's unique client ID. |
Return Value: None.
Sys.Application.get_history(). setServerState Method
|
Top |
|
Sets server state to the specified value. This member supports the client-script infrastructure and is not intended to be
used directly from your code.
|
Sys.Application.get_history().setServerState(value)
|
|
Parameter |
Type |
Description |
|
value |
String |
The server state value. |
Return Value: None.
Sys.Application.get_history().dispose() Method
|
Top |
|
Destroys any resources used by the history object and removes all event handlers.
This member supports the client-script infrastructure and is not intended to be used
directly from your code.
|
Sys.Application.get_history().dispose()
|
Return Value: None.
|