All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerBase Class CATOmbDocPropertyServices

CATOmbDocPropertyServices
 

Usage: you must use this class as is. You should never derive it.


public class CATOmbDocPropertyServices

Services to create, remove and modify properties embedded in documents.
Role: Properties are persistent data attached to documents. It is possible to read the properties of a document without loading it using its DocId. However modifications of properties requires to load the embedding document.

There is one method for creating or modify a property of a given document:

There is one method for reading a property value: There are two methods for removing properties a document: There is one method for reading all property names of a given document:


Method Index


o GetAllNames(CATIDocId*,CATLISTV(CATUnicodeString)&)
Retrieves all the property names of a given document.
o GetValue(CATIDocId*,CATUnicodeString,CATUnicodeString&)
Retrieves the value of a given property in a document.
o Remove(CATDocument*,CATUnicodeString)
Removes a given property in a document.
o RemoveAll(CATDocument*)
Removes all the properties of a given document.
o SetValue(CATDocument*,CATUnicodeString,CATUnicodeString)
Set the value of a given property in a given document.

Methods


o GetAllNames
public static HRESULT GetAllNames(CATIDocId* iDocId,
CATLISTV(CATUnicodeString)& oListOfPropertiesNames)
Retrieves all the property names of a given document.
Parameters:
iDocId
The document.
oListOfPropertiesNames
The list of all property names of the document.
Returns:
S_OK : The operation suceeded.
E_FAIL : The operation failed.
o GetValue
public static HRESULT GetValue(CATIDocId* iDocId,
const CATUnicodeString iPropertyName,
CATUnicodeString& oValue)
Retrieves the value of a given property in a document.
Parameters:
iDocId
The document identification of the document containing the property.
iPropertyName
The property name.
oValue
The property value.
Returns:
S_OK : The operation suceeded.
E_FAIL : The operation failed.
o Remove
public static HRESULT Remove(CATDocument* iDoc,
const CATUnicodeString iPropertyName)
Removes a given property in a document.
Parameters:
iDoc
The document identification of the document in which the property will be deleted.
iPropertyName
The name of the property to delet.
Returns:
S_OK : The operation suceeded.
E_FAIL : The operation failed.
o RemoveAll
public static HRESULT RemoveAll(CATDocument* iDoc)
Removes all the properties of a given document.
Parameters:
iDoc
The document in which the properties will be deleted.
Returns:
S_OK : The operation suceeded.
E_FAIL : The operation failed.
o SetValue
public static HRESULT SetValue(CATDocument* iDoc,
const CATUnicodeString iPropertyName,
const CATUnicodeString iValue)
Set the value of a given property in a given document.
Role: used to assign a value to a property, specified by its name in a given document. This method can also be used to modify a property with the same name by changing its value.
Parameters:
iDoc
The document in which the property will be added.
iPropertyName
The name of the property to set.
iValue
The property value.
Returns:
S_OK : The operation suceeded.
E_FAIL : The operation failed.

This object is included in the file: CATOmbDocPropertyServices.h
If needed, your Imakefile.mk should include the module: CATObjectModelerBase

Copyright © 2003, Dassault Systèmes. All rights reserved.