Skip to main content

ASPxClientLayoutItem.GetItemByName(name) Method

Returns the current layout item’s subitem specified by its name.

Declaration

GetItemByName(
    name: string
): ASPxClientLayoutItem

Parameters

Name Type Description
name string

A string value specifying the name of the layout item.

Returns

Type Description
ASPxClientLayoutItem

An ASPxClientLayoutItem object that represents the current layout item’s subitem with the specified name.

Remarks

An ASPxFormLayout control’s client-side functionality allows individual layout items to be accessed programmatically. The GetItemByName method gets a specific client layout item which is a child item of the current layout item. The obtained child layout item is specified by its name, which is defined by the LayoutItemBase.Name property.

This method searches the specified layout item amongst all subitems of the current item. Note that if an invalid name is passed via the parameter, this method returns null.

To access a particular layout item specified by its name from the ASPxFormLayout control level, the control’s ASPxClientFormLayout.GetItemByName method can be used.

See Also