All Frameworks Class Hierarchy This Framework Previous Next Indexes
ComponentsCatalogsInterfaces Interface CATICatalogKeyword
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICatalogKeyword
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICatalogKeyword
Interface for the catalog keywords.
Role: This interface is used to handle catalog keywords.
A keyword is an object which is used by chapter for describing descriptions.
A keyword can be see like a property (dimensions, customers,...).
About the keyword:
This interface enables methods to retrieve informations on a keyword (its name, its type,
its unit and if it is hidden or not inside a Catalog Browser Dialog box)
- See also:
- CATICatalogChapter, CATICatalogDescription, CATICatalogBrowser
Method Index
- o
GetHidden()
- Returns the "hidden" property.
- o
GetKeywordAlias()
- Retrieves the alias of the keyword.
- o
GetKeywordName()
- Returns the name of the keyword.
- o
GetKeywordType()
- Returns the type of the keyword.
- o
GetKeywordUnit()
- Returns the unit of the keyword.
- o
SetHidden(CATBoolean)
- Sets the "hidden" property.
Methods
o GetHidden
-
Returns the "hidden" property.
Role:
When a keyword is hidden, it's not displayed in the catalog browser.
The keyword is only displayed and used in the catalog editor.
- Returns:
- TRUE is the keyword is hidden, else FALSE.
o GetKeywordAlias
-
Retrieves the alias of the keyword.
The alias is the name displayed in the catalog browser.
- Returns:
- The alias of the keyword.
o GetKeywordName
-
Returns the name of the keyword.
The returned name is the name of the feature.
- Returns:
- The name of the keyword.
o GetKeywordType
-
Returns the type of the keyword.
- Returns:
- CATBaseUnknown#Release The type of the keyword or NULL, if an error has occured.
o GetKeywordUnit
-
Returns the unit of the keyword.
- Returns:
- CATBaseUnknown#Release The unit of the keyword or NULL, if an error has occured.
o SetHidden
public virtual void SetHidden( | CATBoolean | iBoolean) = 0 |
-
Sets the "hidden" property.
Role:
When a keyword is hidden, it's not displayed in the catalog browser.
The keyword is only displayed and used in the catalog editor.
- Parameters:
-
- iBoolean
- TRUE if the keyword is hidden,
FALSE if the keyword is visible.
This object is included in the file: CATICatalogKeyword.h
If needed, your Imakefile.mk should include the module: CATCclInterfaces