All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDftCustomFormat
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIDftCustomFormat
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftCustomFormat
Role: CATIDftCustomFormat is an interface dedicated to change the generic informations carried by a format that are
consequently shared among sheets associated with this format.
- See also:
- CATIDftFormat
Method Index
- o
SetFormatHeight(double)
-
- o
SetFormatName(CATUnicodeString&)
- Sets the format name to iName.
- o
SetFormatSize(double,double)
- Set the custom format's width and height to the given values.
- o
SetFormatWidth(double)
-
Methods
o SetFormatHeight
public virtual HRESULT SetFormatHeight( | double | iHeight)= 0 |
-
- Deprecated:
- V5R17 Use
CATIDftCustomFormat.SetFormatSize WARNING: the following method does not enforce data model integrity.
Sets the format heigth to iHeight.
- Parameters:
-
- double
- iHeight
[in] the new format height.
- Returns:
- HRESULT
- S_OK
- Success.
- E_FAIL
- Error.
o SetFormatName
-
Sets the format name to iName.
- Parameters:
-
- const
- CATUnicodeString &iName
[in] the new format name.
- Returns:
- HRESULT
- S_OK
- Success.
- E_FAIL
- Error.
o SetFormatSize
public virtual HRESULT SetFormatSize( | double | iWidth, |
| double | iHeight) = 0 |
-
Set the custom format's width and height to the given values.
- Parameters:
-
- iWidth
- The new width.
- iHeight
- The new height.
precondition: for custom formats in a postR14-embeded-standard context
iWidth must be greater or equal to iHeight (set the orientation adequately in
order to have the sheet with the desired caracteristics).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Success.
- E_FAIL
- Internal error or preconditions not met.
o SetFormatWidth
public virtual HRESULT SetFormatWidth( | double | iWidth)= 0 |
-
- Deprecated:
- V5R17 Use
CATIDftCustomFormat.SetFormatSize WARNING: the following method does not enforce data model integrity.
Sets the format width to iWidth.
- Parameters:
-
- double
- iWidth
[in] the new format width.
- Returns:
- HRESULT
- S_OK
- Success.
- E_FAIL
- Error.
This object is included in the file: CATIDftCustomFormat.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces