LayoutManager Class

Responsible for maintaining a collection (cache) of reusable layouts.

Inheritance Hierarchy

SystemObject
OBCOM.NetClientLayoutManager

Namespace: OBCOM.NetClient
Assembly: OBCOM.NetClient (in OBCOM.NetClient.dll) Version: 40.82.5945.17884 (40.82.5945.17884)

Syntax

Copy

public sealed class LayoutManager : IEnumerable

Public NotInheritable Class LayoutManager
	Implements IEnumerable

The LayoutManager type exposes the following members.

Constructors

	Name	Description
	LayoutManager	Creates a new LayoutManager with specified Uniform Resource Identifier (uri).

Top

Properties

	Name	Description
	URI	Returns the Uniform Resource Identifier (URI) of this LayoutManager.

Top

Methods

	Name	Description
	Clear	Clears (removes) all layouts from the cache.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetEnumerator	Returns a read-only enumerator over the collection of fields in the Layout.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLayout	Returns the Layout with the specified layoutName.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	PutLayout	Adds a layout to the collection of layouts of the LayoutManager.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

If a requiered Layout is not in the collection, the LayoutManager downloads it's specification, compiles, verifies and addes it to the collection.

Layouts are downloaded using the URI (Uniform Resource Identifier) supplied to the LayoutManager constructor. This URI must contain at least one occurrence of the special placeholder character "*". Before each download, all occurrences of this placeholder are replaced with the name of the requiered Layout. In this way the resulting URI gets targeted specifically to the required Layout. Examples of valid URIs:

Copy

http://www.obcom.cl/desktop/recs/*.asp
file:/C:/websphere/dsn/web/recs/*.jsp
ecuser://JSERVER?FormName=**/

The last example shows an URI defined with the protocol ecuser. This non-standard protocol is used to download layout specifications from a server called ECUSER. This server is reached by sending transactions via a ClientChannel whose name matches the name of the host of the URI. In the previous example, the required ClientChannel is called JSERVER. This ClientChannel must be created before this LayoutManager can use it.

Reference

OBCOM.NetClient Namespace