ASPxClientDockManager.GetZones Method

Returns an array of zones that are contained in a page and meet a specified criteria.

Declaration

GetZones(
    filterPredicate?: ASPxClientDockingFilterPredicate
): ASPxClientDockZone[]

Parameters

Name	Type	Description
filterPredicate	ASPxClientDockingFilterPredicate	An ASPxClientDockingFilterPredicate delegate that defines a set of criteria and determines whether a zone meets those criteria.

Returns

Type	Description
ASPxClientDockZone[]	An array of ASPxClientDockZone objects.

Remarks

The ASPxDockManager component allows you to manage all panels and zones within a page. Use the GetZones method to access an array of zones on the page that meet the criteria defined in the filterPredicate delegate. You can get an array of all zones on the page using the ASPxClientDockManager.GetZones method without any parameter.

Example

The code sample below demonstrates how you can get a list of empty zones contained within a page.

JS

function IsEmptyPredicate(zone) {
     return (zone.GetPanelCount() == 0);
}

function GetEmptyZones() {
     var EmptyZones = manager.GetZones(IsEmptyPredicate);
     var ZoneList = '';
     for (i = 0; i < EmptyZones.length; i++) {
          ZoneList = ZoneList + ' ' + EmptyZones[i].zoneUID;
     }
     label.SetText('Empty zones:' + ZoneList);
}

ASPX

<dx:ASPxDockManager ID="MyASPxDockManager" runat="server" ClientInstanceName="manager">
</dx:ASPxDockManager>

<dx:ASPxLabel ID="MyASPxLabel" runat="server" Text="Docked panels:" ClientInstanceName="label">
</dx:ASPxLabel>