Open topic with navigation

# APOGrid

## SAPGUI. APOGrid

## new APOGrid(propsopt) → {APOGrid}

The description of an APO Grid test object.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`props` | Object | <optional> | Initializes an APO Grid test object using the supplied property bag.

##### Returns:

the description object that was initialized.

Type
  APOGrid

# Methods

## absoluteLocation(locationopt) → {Point|Description}

The object's coordinates relative to the screen in pixels. 0,0 is the top-left corner of the primary monitor.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`location` | Point | <optional> | When provided, this method acts as a setter and sets the absoluteLocation value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the absoluteLocation value; otherwise it returns 'this' for use with the builder pattern.

Type
  Point | Description

## id(idopt) → {string|Description}

The element's unique identifier in text format.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`id` | string | <optional> | When provided, this method acts as a setter and sets the id value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored id value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## isEnabled(isEnabledopt) → {boolean|Description}

Indicates whether the object can accept user input.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`isEnabled` | boolean | <optional> | When provided, this method acts as a setter and sets the isEnabled value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored isEnabled value; otherwise it returns 'this' for use with the builder pattern.

Type
  boolean | Description

## location(locationopt) → {Point|Description}

The object's coordinates relative to the parent's location in pixels.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`location` | Point | <optional> | When provided, this method acts as a setter and sets the location value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored location value; otherwise it returns 'this' for use with the builder pattern.

Type
  Point | Description

## name(nameopt) → {string|Description}

The name of the element.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`name` | string | <optional> | When provided, this method acts as a setter and sets the name value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored name value; otherwise it returns 'this' for use with the builder pattern.

Type
  string | Description

## size(sizeopt) → {Size|Description}

The object's size in pixels.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`size` | Size | <optional> | When provided, this method acts as a setter and sets the size value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.

Type
  Size | Description

## title(titleopt) → {boolean|Description}

The title of the object.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`title` | string | <optional> | When provided, this method acts as a setter and sets the title value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored title value; otherwise it returns 'this' for use with the builder pattern.

Type
  boolean | Description

## type(typeopt) → {SAPGUI.ComponentType|Description}

The numeric identification of the GUI component type.

##### Parameters:

Name | Type | Attributes | Description
--- | --- | --- | ---
`type` | SAPGUI.ComponentType | <optional> | When provided, this method acts as a setter and sets the type value.

##### Returns:

If no parameter is provided, the method acts as a getter and returns the current stored type value; otherwise it returns 'this' for use with the builder pattern.

Type
  SAPGUI.ComponentType | Description