An overloaded class of the Item class.
Can be subclassed when you want new MIP Items and modifications to existing MIP Items reflect into the mother environments settings. Used by the Smart Client when creating and modifying Views, layouts and view groups in the smart client.
Used by the Administrators to create, modify and delete generic events. Only supported for e-code family! For c-code use Configuration API instead. More...

Inheritance diagram for VideoOS.Platform.ConfigItem:

Public Member Functions
virtual ConfigItem	AddChild (ConfigItem item)
	Add a new child to this Item. The child's Kind must be correct, and the parentId set to this item's ObjectId.

virtual ConfigItem	AddChild (FQID fqid, String name)
	Add a new child to this Item. The child's Kind must be correct, and the parentId set to this item's ObjectId.

virtual Item	AddChild (Item item)
	Add a new child to this Item. The child's Kind must be correct, and the parentId set to this item's ObjectId.

virtual ConfigItem	AddChild (String name, Guid kind, FolderType folderType)
	Add a new child to this Item. The child's Kind must be correct, and the parentId set to this item's ObjectId.

virtual void	AddRangeChild (ICollection< ConfigItem > items)
	Add a list of children to this Item. The children's Kind must be correct, and the parentId set to this item's ObjectId.

virtual void	AddRangeChild (ICollection< Item > items)
	Add a list of children to this Item. The children's Kind must be correct, and the parentId set to this item's ObjectId.

	ConfigItem ()
	Used internally in the Smart Client.

	ConfigItem (FQID fqid, String name)
	Used internally in the Smart Client.

	ConfigItem (ServerId serverId, String name)
	Used internally in the Smart Client.

	ConfigItem (ServerId serverId, String name, FolderType folderType, Guid kind)
	Used internally in the Smart Client.

override List< Item >	GetChildren ()
	Get the children of this item. The Kind of item returned may be of different Kind.

virtual void	PropertiesModified ()
	This method is used in the Smart Client to notify to the Smart Client that ViewLayouts and Views have changed and should be saved on the server. In standalone MIP environment, this is called when a preset name or position needs to change. (Current position of the camera is stored in the preset).

virtual void	RemoveChild (Item childItem)
	Remove a child from this item.

Public Member Functions inherited from VideoOS.Platform.Item
virtual bool	Contains (String searchString)
	Looks through all fields for a match.

virtual void	GetChildrenAsync (AsyncItemsHandler asyncItemsHandler, Control control, object callerReference)
	Initiates a call to retrieve all Children for the item. The AsyncItemHandler will be called with the result.

virtual List< Item >	GetChildrenSorted ()
	Same as GetChildren, just sorted by name.

virtual DataSource	GetDataSource ()
	Get the DataSource relevant for this Item type. If no DataSource is available for this Item, a null value is returned. This can for instance be used for retrieving Sequence information for a Camera Item.

virtual Item	GetParent ()
	Get the parent Item to this Item This implementation will build the FQID from the current ServerId and set objectId = ParentId, and assume other fields are the same (FolderType, Kind). If not found it will try with Kind = Kind.Server.

virtual List< Item >	GetRelated ()
	Return a list of Related Items for this Item. Could e.g. be Audio devices to a Camera.

virtual void	GetRelatedAsync (AsyncItemsHandler asyncItemsHandler, Control control, object callerReference)
	Initiates a call to retrieve all Related items for the item. The AsyncItemHandler will be called with the result.

virtual Image	IconWithOverlay ()
	Take item's icon (if available) and place a 'disable' red cross over - if item is disabled.

virtual Image	IconWithOverlay (bool attention, bool active)
	Construct an icon with overlay.

	Item ()
	Create a new Item. The FQID needs to be set afterwards.

	Item (FQID fqid, String name)
	Create a new Item including FQID and the items Name. Other properties can be set afterwards.

	Item (MIPItem mipItem)
	Construct an Item from the MIPItem retrieved via the Configuration API.

	Item (ServerId serverId, Guid parentId, Guid objectId, String name, FolderType folderType, Guid kind)
	Create a new Item. A FQID is created from the provided fields. No further fields needs to be filled to have a valid Item and FQID.

	Item (ServerId serverId, Guid parentId, String objectIdString, String name, FolderType folderType, Guid kind)
	Create a new Item. A FQID is created from the provided fields. No further fields needs to be filled to have a valid Item and FQID.

	Item (ServerId serverId, String name)
	Create a new Item, a FQID containing the ServerId is created. Important: You will need to fill the FQIDs parentId, ObjectId or ObjectString and Kind afterwards.

	Item (ServerId serverId, String name, FolderType folderType, Guid kind)
	Create a new Item. A FQID is created from the provided fields. Important: You will need to fill the FQIDs ObjectId or ObjectIdString afterwards to have a valid FQID.

String	Serialize ()
	Serialize the content of the Item, that is independent of Environment and User. Note: Overloaded properties, UserContext and Authentication will not be saved.

void	Serialize (XmlWriter xmlWriter)
	Serialize the content of the Item, that is independent of Environment and User. Note: Overloaded properties, UserContext and Authentication will not be saved.

virtual void	SetChildren (List< Item > children)
	This method can be used when the base Item class is used, and it contains children. This method will NOT add the children to any servers or configuration, but is merely to simplify instantiation. The children set in this method could be retrieved by the GetChildren method. You should only use this way of implementing an Item, if the number of children is limited.

override String	ToString ()
	Returns the name of the item. Can be used for adding the Item directly on ListBox's and other user controls.

Additional Inherited Members
Static Public Member Functions inherited from VideoOS.Platform.Item
static Item	Deserialize (String serializedItem)
	De-serializes a string as generated by the Serialize method. Note: UserContext and Authorization properties are not filled.

Protected Attributes inherited from VideoOS.Platform.Item
HasChildren	_anyChildren = HasChildren.Maybe

List< Item >	_children = new List<Item>()

HasRelated	_hasRelated = HasRelated.Maybe

List< Item >	_related = new List<Item>()

Package Attributes inherited from VideoOS.Platform.Item
Properties inherited from VideoOS.Platform.Item
virtual Dictionary< String, String >	Authorization `[get]`
	Returns a set of strings identifying what the current user is authorized to do.

virtual Collection< MapAlarmContextMenu >	ContextMenu `[get, set]`
	Defines a list of ContextMenu items relevant for this item. It is displayed when a user right click on a Map containing this item.

virtual bool	Enabled `[get, set]`
	Interpret the properties dictionary for "Enabled" and "Disabled" keys. If no entry is found, default is enabled. Otherwise values of "Yes"/"No" and "True" / "False" are checked for each.

virtual bool	Encrypt `[get, set]`
	Identify if the properties of the item should be stored encrypted on the server.

virtual FQID	FQID `[get, set]`
	The Fully Qualified ID of this Item.

virtual HasChildren	HasChildren `[get, set]`
	Inform if this Item contains children. If the property is no, then no children should be available. If the property is yes, there will normally be children, but it is not a requirement. This property is used to improve the UI when displaying TreeView controls to avoid the (+) plus sing for expanding items, that does not have any children.

virtual HasRelated	HasRelated `[get, set]`
	Inform if this Item contains children. If the property is no, then no children should be available. If the property is yes, there will normally be children, but it is not a requirement. This property is used to improve the UI when displaying TreeView controls to avoid the (+) plus sing for expanding items, that does not have any children.

virtual Image	Icon `[get, set]`
	Icon used for ViewAndLayout items in the Smart Client. The Icon represent a given layout.

virtual Guid	MapIconKey `[get, set]`
	Identified what Icon to display on the Map. A value of Guid.Empty or this Items Kind will use the default MapIcon on the ItemNode. Otherwise the value is the key into the MapIconDictionary on the ItemNode class. Please note that MIP items on Map supports dynamic change but MIP Items on Smart Map do not.

virtual String	Name `[get, set]`
	The Display Name of this Item.

virtual PositioningInformation	PositioningInformation `[get, set]`
	Will retrieve the gis location and other positioning information for this Item.

virtual Dictionary< String, String >	Properties `[get]`
	Returns a set of selected properties for the Item. Can also return null, if implementation has no relevant properties for this type of Item. For built-in items, the available properties depends on the Kind of item, where it is accessed (e.g. Management Client/Application or Smart Client/Standalone). A item containing a Camera, Recorder or a Server contains the most properties.

Detailed Description

An overloaded class of the Item class.
Can be subclassed when you want new MIP Items and modifications to existing MIP Items reflect into the mother environments settings. Used by the Smart Client when creating and modifying Views, layouts and view groups in the smart client.
Used by the Administrators to create, modify and delete generic events. Only supported for e-code family! For c-code use Configuration API instead.

Constructor & Destructor Documentation

◆ ConfigItem() [1/4]

VideoOS.Platform.ConfigItem.ConfigItem ( )

inline

Used internally in the Smart Client.

◆ ConfigItem() [2/4]

VideoOS.Platform.ConfigItem.ConfigItem	(	FQID	fqid,
		String	name )

inline

Used internally in the Smart Client.

◆ ConfigItem() [3/4]

VideoOS.Platform.ConfigItem.ConfigItem	(	ServerId	serverId,
		String	name )

inline

Used internally in the Smart Client.

◆ ConfigItem() [4/4]

VideoOS.Platform.ConfigItem.ConfigItem	(	ServerId	serverId,
		String	name,
		FolderType	folderType,
		Guid	kind )

inline

Used internally in the Smart Client.

Member Function Documentation

◆ AddChild() [1/4]

virtual ConfigItem VideoOS.Platform.ConfigItem.AddChild ( ConfigItem item )

inlinevirtual

Add a new child to this Item. The child's Kind must be correct, and the parentId set to this item's ObjectId.

Parameters

item

Returns

◆ AddChild() [2/4]

virtual ConfigItem VideoOS.Platform.ConfigItem.AddChild	(	FQID	fqid,
		String	name )

inlinevirtual

Add a new child to this Item. The child's Kind must be correct, and the parentId set to this item's ObjectId.

Parameters

fqid
name

Returns

◆ AddChild() [3/4]

virtual Item VideoOS.Platform.ConfigItem.AddChild ( Item item )

inlinevirtual

Add a new child to this Item. The child's Kind must be correct, and the parentId set to this item's ObjectId.

Parameters

item

Returns

◆ AddChild() [4/4]

virtual ConfigItem VideoOS.Platform.ConfigItem.AddChild	(	String	name,
		Guid	kind,
		FolderType	folderType )

inlinevirtual

Add a new child to this Item. The child's Kind must be correct, and the parentId set to this item's ObjectId.

Parameters

name
kind
folderType

Returns

◆ AddRangeChild() [1/2]

virtual void VideoOS.Platform.ConfigItem.AddRangeChild ( ICollection< ConfigItem > items )

inlinevirtual

Add a list of children to this Item. The children's Kind must be correct, and the parentId set to this item's ObjectId.

Parameters

items

Returns

◆ AddRangeChild() [2/2]

virtual void VideoOS.Platform.ConfigItem.AddRangeChild ( ICollection< Item > items )

inlinevirtual

Add a list of children to this Item. The children's Kind must be correct, and the parentId set to this item's ObjectId.

Parameters

items

Returns

◆ GetChildren()

override List< Item > VideoOS.Platform.ConfigItem.GetChildren ( )

inlinevirtual

Get the children of this item. The Kind of item returned may be of different Kind.

Returns

Reimplemented from VideoOS.Platform.Item.

◆ PropertiesModified()

virtual void VideoOS.Platform.ConfigItem.PropertiesModified ( )

inlinevirtual

This method is used in the Smart Client to notify to the Smart Client that ViewLayouts and Views have changed and should be saved on the server.
In standalone MIP environment, this is called when a preset name or position needs to change. (Current position of the camera is stored in the preset).

◆ RemoveChild()

virtual void VideoOS.Platform.ConfigItem.RemoveChild ( Item childItem )

inlinevirtual

Remove a child from this item.

Parameters

childItem

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConfigItem() [1/4]

◆ ConfigItem() [2/4]

◆ ConfigItem() [3/4]

◆ ConfigItem() [4/4]

Member Function Documentation

◆ AddChild() [1/4]

◆ AddChild() [2/4]

◆ AddChild() [3/4]

◆ AddChild() [4/4]

◆ AddRangeChild() [1/2]

◆ AddRangeChild() [2/2]

◆ GetChildren()

◆ PropertiesModified()

◆ RemoveChild()