Class PropertySetClass

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("588E5A11-D09B-11D1-AA7C-00C04FA33A15")]
public class PropertySetClass : PropertySet, IPropertySet2, IPropertySet, IXMLSerialize, IPersistStream, IPersist, IClone
Inheritance
PropertySetClass
Implements
Inherited Members

Constructors

PropertySetClass()

public PropertySetClass()

Explicit Interface Implementations

Assign(IClone)

Assigns the properties of src to the receiver.

virtual void Assign(IClone src)

Parameters

src IClone

Clone()

Clones the receiver and assigns the result to *clone.

virtual IClone Clone()

Returns

IClone

Count

The number of properties contained in the property set.

virtual int Count { get; }

Returns

int

Remarks

The Count value will always be one when used with the esriGeodatabase.XmlPropertySet coclass. For more information, see the remarks for the XmlPropertySet coclass.

Deserialize(IXMLSerializeData)

Deserializes an object from XML.

virtual void Deserialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

GetAllProperties(out object, out object)

The name and value of all the properties in the property set.

virtual void GetAllProperties(out object names, out object values)

Parameters

names object
values object

Remarks

The GetAllProperties retrieves all names and values in the property set.

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetProperties(object, out object)

The values of the specified properties.

virtual void GetProperties(object names, out object values)

Parameters

names object
values object

Remarks

The GetProperties method returns values from a PropertySet CoClass.

[C#]

public Object GetServerProperty(IServerEnvironment3 server, string propertyName="ExtensionName")

{

  Object propertyValue = null;

  IPropertySet serverProps = server.Properties;

  propertyValue = serverProps.GetProperty(propertyName);

  return propertyValue;

}

GetProperty(string)

The value of the specified property.

virtual object GetProperty(string Name)

Parameters

Name string

Returns

object

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

IPersistStream_GetClassID(out Guid)

virtual void IPersistStream_GetClassID(out Guid pClassID)

Parameters

pClassID Guid

IPropertySet2_Count

virtual int IPropertySet2_Count { get; }

Returns

int

IPropertySet2_GetAllProperties(out object, out object)

virtual void IPropertySet2_GetAllProperties(out object names, out object values)

Parameters

names object
values object

IPropertySet2_GetProperties(object, out object)

virtual void IPropertySet2_GetProperties(object names, out object values)

Parameters

names object
values object

IPropertySet2_GetProperty(string)

virtual object IPropertySet2_GetProperty(string Name)

Parameters

Name string

Returns

object

IPropertySet2_IsEqual(IPropertySet)

virtual bool IPropertySet2_IsEqual(IPropertySet PropertySet)

Parameters

PropertySet IPropertySet

Returns

bool

IPropertySet2_RemoveProperty(string)

virtual void IPropertySet2_RemoveProperty(string Name)

Parameters

Name string

IPropertySet2_SetProperties(object, object)

virtual void IPropertySet2_SetProperties(object names, object values)

Parameters

names object
values object

IPropertySet2_SetProperty(string, object)

virtual void IPropertySet2_SetProperty(string Name, object Value)

Parameters

Name string
Value object

IsDirty()

virtual void IsDirty()

IsEqual(IClone)

Indicates if the receiver and other have the same properties.

virtual bool IsEqual(IClone other)

Parameters

other IClone

Returns

bool

IsEqual(IPropertySet)

True if the property set is the same as the input property set.

virtual bool IsEqual(IPropertySet PropertySet)

Parameters

PropertySet IPropertySet

Returns

bool

Remarks

This method indicates whether two property sets are equal.

Note that it will always return false if the property set is an esriGeodatabase.XmlPropertySet (for metadata). See the XmlPropertySet coclass' documentation for more information.

IsEqualNoCase(IPropertySet)

True if the property set is the same as the input property set.

virtual bool IsEqualNoCase(IPropertySet PropertySet)

Parameters

PropertySet IPropertySet

Returns

bool

IsIdentical(IClone)

Indicates if the receiver and other are the same object.

virtual bool IsIdentical(IClone other)

Parameters

other IClone

Returns

bool

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

RemoveProperty(string)

Removes a property from the set.

virtual void RemoveProperty(string Name)

Parameters

Name string

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

Serialize(IXMLSerializeData)

Serializes an object to XML.

virtual void Serialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

SetProperties(object, object)

The values of the specified properties.

virtual void SetProperties(object names, object values)

Parameters

names object
values object

Remarks

Using the Name parameter to locate the specified element, the SetProperties method populates the elements, or adds an new element if it already exists, and sets the value to the coorseponding Values parameter.

The Name parameter uses XSL Patterns to specify metadata elements.  Additional information on XSL can be found in the the IXmlPropertySet documentation.

esriXmlSetPropertyAction constants are NOT available to handle situations where an element value already exists. Upon encountering elements that already have values, the new values will replace or add values to existing elements. For more control dealing with elements the IXmlPropertySet::SetPropertyX should be used.

In order to populated nodes further along in the Xml tree, nodes necessary to navigate must first be established. For instance in order to populate the "idinfo/ptcontact/cntinfo/cntperp/cntorg" node each subsequent nodes, "idinfo", "idinfo/ptcontact", "idinfo/ptcontact/cntinfo" and "idinfo/ptcontact/cntinfo/cntperp" must already be in place.

SetProperty(string, object)

The value of the specified property.

virtual void SetProperty(string Name, object Value)

Parameters

Name string
Value object

Remarks

The Name parameter uses XSL Patterns to specify metadata elements.  Additional information on XSL can be found in the the IXmlPropertySet documentation.