UIContext Members

Kentico 8.1 API Reference

The UIContext type exposes the following members.

Constructors

	Name	Description
	UIContext

Methods

	Name	Description
	Clone	Clones current UI context and creates new instance
	CloneForNewThread	Clones the object for new thread (Inherited from AbstractContext TContext .)
	CombineWith	Combines current instance with other properties (modifies current instace!). List properties are merged from all the participating typeinfos, other properties are taken as first non-null value (non-null is determined by nullValues collection). (Inherited from AbstractHierarchicalObject ObjectType .)
	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer ParentObjectType .)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject ObjectType .)
	GetPropertyType	Gets the type of the given property (Inherited from AbstractHierarchicalObject ObjectType .)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject ObjectType .)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RegisterColumn(String, Func ParentObjectType, Object )	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	RegisterColumn(String, Func ParentObjectType, Object , Func ParentObjectType, Object, Object )	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	RegisterColumns	Registers the Columns of this object (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	RegisterProperties	Registers the properties of this object (Inherited from AbstractHierarchicalObject ObjectType .)
	RegisterProperty(String, Func ObjectType, Object )	Registers the given property to the object (Inherited from AbstractHierarchicalObject ObjectType .)
	RegisterProperty(String, Object, Func ObjectType, Object, Object )	Registers the given parameterized property to the object. (Inherited from AbstractHierarchicalObject ObjectType .)
	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject ObjectType .)
	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetProperty(String, Object )	Gets value from collection (Overrides AbstractHierarchicalObject ObjectType TryGetProperty(String, Object ).)
	TryGetProperty(String, Object , Boolean)	Returns value of property. (Overrides AbstractHierarchicalObject ObjectType TryGetProperty(String, Object , Boolean).)
	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer ParentObjectType .)

Extension Methods

	Name	Description
	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
	AnchorLinks	List of anchor links for quick navigation.
	AssignedControl	Control to which UI context is assigned. If null context belongs to main page.
	ColumnNames	Available column names. (Inherited from AbstractDataContainer ParentObjectType .)
	ContextResolver	UI context resolver.
	Data	Gets context data for UI.
	DisplayBreadcrumbs	If true, the breadcrumbs should be displayed
	DisplaySplitMode	Indicates if split mode should be displayed.
	DisplayTitle	If true, the title should be displayed
	EditedObject	Object edited by the current page.
	EditedObjectParent	Parent of the object edited by the current page.
	ElementGuid	GUID for element to display
	ElementName	Gets the current UI element name.
	IsDefault	Returns true if the context is the default request context (Inherited from RequestContainer TParent .)
	IsDialog	Is dialog property
	IsRootDialog	Indicates whether page is root dialog (top dialog page with header and footer)
	Item	Override indexer, add fallback to querystring (Overrides AbstractHierarchicalObject ObjectType Item String .)
	LoadDataFromParent	Indicates whether data sould be loaded from parent context
	ObjectID	Object ID
	ParentObjectID	Parent object ID
	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject ObjectType .)
	PropertyList	Used property list (Inherited from AbstractHierarchicalObject ObjectType .)
	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	RegisteredProperties	Registered properties (Inherited from AbstractHierarchicalObject ObjectType .)
	RegisteredPropertiesObject	Registered properties object (Inherited from AbstractHierarchicalObject ObjectType .)
	ResolveMacros	Indicates whether property should be resolved with context's resolver.
	ResourceName	Gets the resource name.
	RootElementID	Root element ID
	Secure	Secure wrapper for properties in special secure mode.
	SiteID	Site ID
	SplitMode	Split mode view (vertical/horizontal).
	SplitModeCultureCode	User culture code for culture version comparison.
	SplitModeSyncScrollbars	Indicates if scrollbars should be synchronized in split mode.
	UIElement	UI element for current context
	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer ParentObjectType .)
	UseLocalProperties	If true, the object uses local properties (Inherited from AbstractHierarchicalObject ObjectType .)

Events

	Name	Description
	OnGetValue	Event fired when the UI context dynamic data is requested