C# Class OSAE.OSAEObjectPropertyManager

Can be used to manager the properties of an object in OSA
Mostrar archivo Open project: opensourceautomation/Open-Source-Automation Class Usage Examples

Public Methods

Method Description
GetObjectProperties ( string ObjectName ) : OSAEObjectPropertyCollection

The the properties of an object

GetObjectPropertyValue ( string ObjectName, string ObjectProperty ) : OSAE.OSAEObjectProperty

Returns an OSAEObjectProperty whcih contains the value, type, ID, last updated, and name

ObjectPropertyArrayAdd ( string objectName, string propertyName, string propertyValue, string propertyLabel ) : void

propertyLabel is usually left null

ObjectPropertyArrayDelete ( string objectName, string propertyName, string propertyValue ) : void

Deletes an item from a property array

ObjectPropertyArrayDeleteAll ( string objectName, string propertyName ) : void

Deletes all items from a property array

ObjectPropertyArrayGetAll ( string objectName, string propertyName ) : DataSet

Returns a Dataset of all the item in the property array

ObjectPropertyArrayGetRandom ( string objectName, string propertyName ) : string

Get one random value from a property array

ObjectPropertyArrayUpdate ( string objectName, string propertyName, string oldPropertyValue, string newPropertyValue, string newPropertyLabel ) : void

propertyLabel is usually left null

ObjectPropertyExists ( string objectName, string propertyName ) : System.Boolean

Check if object's property exists

ObjectPropertyHistoryGet ( string objectName, string propertyName, string from, string to ) : DataSet
ObjectPropertyListGet ( string objectName ) : DataSet
ObjectPropertyScraperAdd ( string objectName, string propertyName, string URL, string Prefix, int PrefixOffset, string Suffix, string UpdateInterval ) : void

propertyLabel is usually left null

ObjectPropertyScraperDelete ( int scraperid ) : void

propertyLabel is usually left null

ObjectPropertyScraperUpdate ( int scraperid, string objectName, string propertyName, string URL, string Prefix, int PrefixOffset, string Suffix, string UpdateInterval ) : void

propertyLabel is usually left null

ObjectPropertySet ( string objectName, string propertyName, string propertyValue, string source ) : void

Set the value of a object's property

Method Details

GetObjectProperties() public static method

The the properties of an object
public static GetObjectProperties ( string ObjectName ) : OSAEObjectPropertyCollection
ObjectName string The object to get the proeprties of
return OSAEObjectPropertyCollection

GetObjectPropertyValue() public static method

Returns an OSAEObjectProperty whcih contains the value, type, ID, last updated, and name
public static GetObjectPropertyValue ( string ObjectName, string ObjectProperty ) : OSAE.OSAEObjectProperty
ObjectName string The name of the object to get the property of
ObjectProperty string
return OSAE.OSAEObjectProperty

ObjectPropertyArrayAdd() public static method

propertyLabel is usually left null
public static ObjectPropertyArrayAdd ( string objectName, string propertyName, string propertyValue, string propertyLabel ) : void
objectName string
propertyName string
propertyValue string
propertyLabel string
return void

ObjectPropertyArrayDelete() public static method

Deletes an item from a property array
public static ObjectPropertyArrayDelete ( string objectName, string propertyName, string propertyValue ) : void
objectName string
propertyName string
propertyValue string
return void

ObjectPropertyArrayDeleteAll() public static method

Deletes all items from a property array
public static ObjectPropertyArrayDeleteAll ( string objectName, string propertyName ) : void
objectName string
propertyName string
return void

ObjectPropertyArrayGetAll() public static method

Returns a Dataset of all the item in the property array
public static ObjectPropertyArrayGetAll ( string objectName, string propertyName ) : DataSet
objectName string
propertyName string
return System.Data.DataSet

ObjectPropertyArrayGetRandom() public static method

Get one random value from a property array
public static ObjectPropertyArrayGetRandom ( string objectName, string propertyName ) : string
objectName string
propertyName string
return string

ObjectPropertyArrayUpdate() public static method

propertyLabel is usually left null
public static ObjectPropertyArrayUpdate ( string objectName, string propertyName, string oldPropertyValue, string newPropertyValue, string newPropertyLabel ) : void
objectName string
propertyName string
oldPropertyValue string
newPropertyValue string
newPropertyLabel string
return void

ObjectPropertyExists() public static method

Check if object's property exists
public static ObjectPropertyExists ( string objectName, string propertyName ) : System.Boolean
objectName string The name of the object
propertyName string The name of the property
return System.Boolean

ObjectPropertyHistoryGet() public static method

public static ObjectPropertyHistoryGet ( string objectName, string propertyName, string from, string to ) : DataSet
objectName string
propertyName string
from string
to string
return System.Data.DataSet

ObjectPropertyListGet() public static method

public static ObjectPropertyListGet ( string objectName ) : DataSet
objectName string
return System.Data.DataSet

ObjectPropertyScraperAdd() public static method

propertyLabel is usually left null
public static ObjectPropertyScraperAdd ( string objectName, string propertyName, string URL, string Prefix, int PrefixOffset, string Suffix, string UpdateInterval ) : void
objectName string
propertyName string
URL string
Prefix string
PrefixOffset int
Suffix string
UpdateInterval string
return void

ObjectPropertyScraperDelete() public static method

propertyLabel is usually left null
public static ObjectPropertyScraperDelete ( int scraperid ) : void
scraperid int
return void

ObjectPropertyScraperUpdate() public static method

propertyLabel is usually left null
public static ObjectPropertyScraperUpdate ( int scraperid, string objectName, string propertyName, string URL, string Prefix, int PrefixOffset, string Suffix, string UpdateInterval ) : void
scraperid int
objectName string
propertyName string
URL string
Prefix string
PrefixOffset int
Suffix string
UpdateInterval string
return void

ObjectPropertySet() public static method

Set the value of a object's property
public static ObjectPropertySet ( string objectName, string propertyName, string propertyValue, string source ) : void
objectName string The name of the object
propertyName string The name of the property
propertyValue string The value of the property
source string
return void