IGHARemoteObject Interface |
[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:RemoteLib.IGHARemoteObject"]
Namespace: RemoteLib
Assembly: RemoteLib (in RemoteLib.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public interface IGHARemoteObject
The IGHARemoteObject type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Class |
.NET Class of the object
|
| Description |
Free-form description of the object
|
| DisplayName |
Display name of the object
|
| IsSortable |
This object is subject to sorting
|
| Name |
Name of the object
|
| Navigation |
Defines how UI's should treat this object
|
| ObjectID |
Unique ID of the object
|
| Parent |
Path of the object's parent object
|
| Path |
Path of the object
|
Methods| Name | Description | |
|---|---|---|
 | AddToGroup |
Adds this instance to the specified group. Creates the group if it does not exist
|
| Bind(IGHARemoteObject) |
Bind the remote object to the specified object
|
| Bind(IGHARemoteObject, IGHARemoteObject) |
Bind the two specified remote objects to each other
|
| Bind(IGHARemoteObject, String, IGHARemoteObject, String) |
Bind the two specified remote objects and properties to each other
|
| CreateObject |
Create a chld object with the given class name
|
| DeleteObject |
Delete the child object of the given namne
|
| GetAllIcons |
Retrieve all Icon file names on the remote GHA server
|
| GetBindableObjects |
Searches active Device hierarchy for objects that can be bound to the current object
|
| GetCapabilities |
Returns all capabilities currently defined by GHA
|
| GetChildCount |
Returns the number of children. Used to avoid the overhead if the collection is not needed
|
| GetChildren |
Returns children of the object, recursively if required, with optional start index and count
|
| GetClasses |
Returns all GHA Classes
|
| GetCompatibleGroups |
Returns groups that have members that are compatible with the calling objects
|
| GetContainedTypes |
Returns Contained Types of the object
|
| GetGroupingCompatibleObjects |
Returns objects that are groupable and of the same type as the calling object
|
| GetGroupMemberships |
Returns the groups of which the remote object is a member
|
| GetIconFile |
Retrieve an Icon image in Byte arra format
|
| GetIconUpdated |
Get last icon update date/time
|
| GetIconUpdates |
Retrieve icon file names that have changed since the last Icon update date/time
|
| GetInheritedClasses |
Get classes that inherit from the specified class name
|
| GetObject(Guid) |
Returns the object with the specified object ID
|
| GetObject(String) |
Returns the object at the specified path if it exists
|
| GetObjectsByCapability |
Returns child objects, recursively if required, with the specified capability
|
| GetObjectsByPropertyName |
Get child objects, recursively if required, with the specified property name.
|
| GetObjectsByPropertySearch |
Internal use only
|
| GetObjectsByPropertyValue |
Internal use only
|
| GetObjectsByType |
Returns child objects, recurisvely if required, of the specified type
|
| GetObjectsByTypeAndPropertyValue |
Returns child objects, recursively if required, of the specified type, property name and value
|
| GetProperties |
Returns the list of the objects full property descriptor
|
| GetProperty |
Returns a single property's property descriptor
|
| GetPropertyNames |
Returns the names of the objects properties
|
| GetRemoteEnumerations |
Returns all enumeration types defined in GHA
|
| GetTypesWithCategory |
Return type names with the specified category
|
| GetValue |
Returns the value of the specified property
|
| HasChildren |
Determines if the object has children. Used to avoid the overhead of downloading children
|
| Invoke |
Invoke a remote object's method with parameters
|
| IsBindable |
Determines if the remote object implements the IBindable capability
|
| IsChildOf |
Determines if the specified object is one of the calling object's children
|
| IsOfExplicitType |
Determines if the calling object inherits from the specified class
|
| IsWebViewable |
Determine if the remote object presents a web page
|
| Move |
Move the object to someplace else in the hierarchy
|
| RemoveFromGroup |
Removes the object from the specified group
|
| Rename |
Rename the object
|
| RunCommand |
Invokes a parameterless method of the remote object
|
| SetValue(String, Object) |
Set the value of the specified property
|
| SetValue(String, Object, Int32) |
Internal use only
|
| SetValueForced |
Sets the value of the specified property forcing the property change logic to execute. The logic does not normally execute
if the property value has not changed. This method ensures the property change logic is invoked.
|
| SubscribeToCreate |
Subscribes to child object creation
|
| SubscribeToDelete |
Subscribe to child object deletion
|
| SubscribeToProperty |
Subscribes to changes of the specified property name
|
| UnBind |
Unbind the object
|
| UnBind(IGHARemoteObject) |
Unbind the specified object from any bindings
|
| UnBind(IGHARemoteObject, IGHARemoteObject) |
Unbind the two specified objects from each other
|
| UnBind(IGHARemoteObject, String, IGHARemoteObject, String) |
Unbind the specified object/properties from each other
|
| UnSubscribe |
Remove subscription (property, create, or delete) with the specified subscription ID
|
See Also