CATDibModelerUseItf Interface CATIDibCustomFormat

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


interface CATIDibCustomFormat

Role: CATIDibCustomFormat 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:


Method Index


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.

Methods


o SetFormatName
public virtual SetFormatName( const iName)
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 SetFormatSize( iWidth,
iHeight)
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.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.