All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATDibModelerUseItf Interface CATIDibFormat

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

interface CATIDibFormat

Role: CATIDibFormat is an interface dedicated to get the generic informations carried by a format that are consequently shared among sheets associated with this format.

Method Index

o GetFormatName(CATUnicodeString&): Retrieves the name of the format.
o GetFormatOrientationsType(CATFormatOrientationsType&): Retrieves the format orientations type.
o GetFormatSize(double&,double&): Retrieves the size (width and height) of the format.

Methods

o GetFormatName

public virtual GetFormatName( oName)

Retrieves the name of the format.

Parameters:

CATUnicodeString: &oName [out] The name of the format as an unicode string.

Returns:

HRESULT

S_OK: Success.
E_FAIL: Error.

o GetFormatOrientationsType

public virtual GetFormatOrientationsType( oOrientsType)

Retrieves the format orientations type. Note: To set the orientations type on a custom format, see CATIDftFormatsManager#SetOrientationsTypeOnCustomFormat

Parameters:

CATFormatOrientationsType: &oOrientsType [out] The orientations type of the format.

Returns:

HRESULT

S_OK: Success.
E_FAIL: Error.

See also:

o GetFormatSize

public virtual GetFormatSize(		`oWidth`,
		`oHeight`)

Retrieves the size (width and height) of the format. Note: the height of a format is same as the height of a sheet having a landscape orientation and associated with this format.

Parameters:

double: &oWidth [out] The width of the format.
double: &oHeight [out] The height of the format.

Returns:

HRESULT

S_OK: Success.
E_FAIL: Error.

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