All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDftColoringPattern

System.IUnknown
  |
  +---CATIDftColoringPattern
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIDftColoringPattern

Manage a Coloring pattern.


Method Index


o GetColor(int*)
Gets the RGB color number of the Coloring element.
o SetColor(int)
Set the RGB color number of the Coloring element.

Methods


o GetColor
public virtual HRESULT GetColor(int* oColor) = 0
Gets the RGB color number of the Coloring element.
Parameters:
oColor
The RGB value of the color
Returns:
S_OK : Method correctly executed.
No restriction.
S_READONLY : Method correctly executed.
Returned value cannot be modified, it's read-only.
Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED : Method correctly executed.
Returned value is undefined.
Case of an object having several subparts supporting the same property with a different value.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.
See also:
CATGraphicAttributeSet
o SetColor
public virtual HRESULT SetColor( const int iColor) = 0
Set the RGB color number of the Coloring element.
Parameters:
iColor
The RGB value of the color
Returns:
S_OK : Method correctly executed.
No restriction.
S_READONLY : Method correctly executed.
Returned value cannot be modified, it's read-only.
Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED : Method correctly executed.
Returned value is undefined.
Case of an object having several subparts supporting the same property with a different value.
E_FAIL : Method execution failed.
Reasons of the failure are not given.
E_NOTIMPL : No implementation available for this method.
See also:
CATGraphicAttributeSet

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

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