Click or drag to resize

cursorZoneCollectionAdd Method

imbSCI | imbACE | imbNLP | imbWEM | imbWBI
Adds a zone into collection. Null zone will be ignored.

Namespace:  imbSCI.Core.reporting.zone
Assembly:  imbSCI.Core (in imbSCI.Core.dll) Version: 0.3.58.
Syntax
C#
Copy
public string Add(
	cursorZoneRole role,
	cursorZone zone
)
Request Example View Source

Parameters

role
Type: imbSCI.Core.reporting.zonecursorZoneRole
The role for the zone
zone
Type: imbSCI.Core.reporting.zonecursorZone
The zone to add into collection

Return Value

Type: String
Key that was finally used for the zone. Possibly important in case of roles supporting multiple entries
Remarks

If role is supports multiple items (column, section) on existing zone for the role it will create indexed key.

If its a singular (footer, header, master) role it will replace any existing.

If master zone is set, all zones will have the master zone set as parent.

You may set the master zone with constructor or any time later with Add() call - it will automatically set parent for existing zones

See Also