All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDftDrawingFormats
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIDftDrawingFormats
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftDrawingFormats
Role: CATIDftDrawingFormats is an interface dedicated to manage formats in the drawing.
Method Index
- o
AddCustomFormat(CATUnicodeString&,CATIDftCustomFormat*&,IUnknown*)
- Creates and adds to the drawing a custom format oCustomFormat named iName.
- o
GetAvailableFormats(CATLISTV(CATISpecObject_var)&)
- Appends to ioFormats the formats available in the drawing.
- o
GetCustomFormats(CATLISTV(CATISpecObject_var)&)
- Appends to iFormats the custom formats in the drawing.
- o
GetStandardFormats(CATLISTV(CATISpecObject_var)&)
- Appends to ioFormats the standard formats in the drawing.
- o
RemoveCustomFormat(CATIDftCustomFormat*)
- Removes the custom format iCustomFormat from the drawing.
- o
SetOrientationsTypeOnCustomFormat(CATIDftCustomFormat*,CATFormatOrientationsType,CATLISTV(CATISpecObject_var)*)
- Sets the format orientations type for iCustomFormat to iOrientsType.
Methods
o AddCustomFormat
-
Creates and adds to the drawing a custom format oCustomFormat named iName.
- Parameters:
-
- const
- CATUnicodeString &
[in] The name of the new format.
- CATIDftCustomFormat*
- &oCustomFormat
[out] The created format.
- IUnknown
- * iFormat
[in] If not NULL, a format already in the drawing whose caracteristics will be used to initialize oCustomFormat.
If NULL the default format will be used to initialize oCustomFormat.
o GetAvailableFormats
-
Appends to ioFormats the formats available in the drawing.
- Parameters:
-
- CATLISTP(CATIDftFormat)
- &ioFormats
[in out] The list the formats will be appended to.
- Returns:
- HRESULT
- S_OK
- Success.
- E_FAIL
- Error.
o GetCustomFormats
-
Appends to iFormats the custom formats in the drawing.
- Parameters:
-
- CATLISTP(CATISpecObject)
- &ioCustomFormats
[in out] The list the formats will be appended to.
- Returns:
- HRESULT
- S_OK
- Success.
- E_FAIL
- Error.
o GetStandardFormats
-
Appends to ioFormats the standard formats in the drawing.
- Parameters:
-
- CATLISTP(CATISpecObject)
- &ioStdFormats
[in out] The list the formats will be appended to.
- Returns:
- HRESULT
- S_OK
- Success.
- E_FAIL
- Error.
o RemoveCustomFormat
-
Removes the custom format iCustomFormat from the drawing.
- Returns:
- HRESULT
- S_OK
- Success.
- E_FAIL
- Error or iCustomFormat can not be removed because there is at least one sheet in the drawing associated with it.
o SetOrientationsTypeOnCustomFormat
-
Sets the format orientations type for iCustomFormat to iOrientsType. Also updates the sheets in the drawing
associated with iCustomFormat if their orientation is not compliant with iOrientsType.
- Parameters:
-
- CATIDftCustomFormat
- *iCustomFormat
[in] The format whose orientations type must be changed.
- CATFormatOrientationsType
- iOrientsType
[in] The new orientations types for iCustomFormat.
- CATLISTP(CATISpecObject)
- *ioModifiedSheet= NULL
[in out] If not NULL, pointers to the sheets which were modified during the operation will be appended to ioModifiedSheet. Don't forget to release
the pointers.
Returns:
HRESULT
- S_OK
- Success.
- S_FALSE
- Some sheets were not compliant with the new orientation types. Consequently their orientation has been modified.
- E_FAIL
- Error.
This object is included in the file: CATIDftDrawingFormats.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces