Indexes

AnalysisReportingSettingAtt (Object)

Interface to handle the Analysis & Simulation "ReportingSetting".

Property Index

BackgroundImageMode
Returns or sets the BackgroundImageMode parameter.
CustomBackgroundImage
Returns or sets the CustomBackgroundImage parameter.
CustomImageFormat
Returns or sets the CustomImageFormat parameter.
CustomImageHeight
Returns or sets the CustomImageHeight parameter.
CustomImageWidth
Returns or sets the CustomImageWidth parameter.
ImageQualityMode
Returns or sets the ImageQualityMode parameter.
TempOutputDirectory
Returns or sets the TempOutputDirectory parameter.

Method Index

GetBackgroundImageModeInfo
Retrieves environment informations for the BackgroundImageMode parameter.
GetCustomBackgroundImageInfo
Retrieves environment informations for the CustomBackgroundImage parameter.
GetCustomImageFormatInfo
Retrieves environment informations for the CustomImageFormat parameter.
GetCustomImageHeightInfo
Retrieves environment informations for the CustomImageHeight parameter.
GetCustomImageWidthInfo
Retrieves environment informations for the CustomImageWidth parameter.
GetImageQualityModeInfo
Retrieves environment informations for the ImageQualityMode parameter.
GetTempOutputDirectoryInfo
Retrieves environment informations for the TempOutputDirectory parameter.
SetBackgroundImageModeLock
Locks or unlocks the BackgroundImageMode parameter.
SetCustomBackgroundImageLock
Locks or unlocks the CustomBackgroundImage parameter.
SetCustomImageFormatLock
Locks or unlocks the CustomImageFormat parameter.
SetCustomImageHeightLock
Locks or unlocks the CustomImageHeight parameter.
SetCustomImageWidthLock
Locks or unlocks the ImageWidth parameter.
SetImageQualityModeLock
Locks or unlocks the ImageQualityMode parameter.
SetTempOutputDirectoryLock
Locks or unlocks the TempOutputDirectory parameter.

Properties


o Property BackgroundImageMode() As
Returns or sets the BackgroundImageMode parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property CustomBackgroundImage() As
Returns or sets the CustomBackgroundImage parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property CustomImageFormat() As
Returns or sets the CustomImageFormat parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property CustomImageHeight() As
Returns or sets the CustomImageHeight parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property CustomImageWidth() As
Returns or sets the CustomImageWidth parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property ImageQualityMode() As
Returns or sets the ImageQualityMode parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property TempOutputDirectory() As
Returns or sets the TempOutputDirectory parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Methods


o Func GetBackgroundImageModeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the BackgroundImageMode parameter.
Role:Retrieves the state of the BackgroundImageMode parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetCustomBackgroundImageInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the CustomBackgroundImage parameter.
Role:Retrieves the state of the CustomBackgroundImage parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetCustomImageFormatInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the CustomImageFormat parameter.
Role:Retrieves the state of the CustomImageFormat parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetCustomImageHeightInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the CustomImageHeight parameter.
Role:Retrieves the state of the CustomImageHeight parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetCustomImageWidthInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the CustomImageWidth parameter.
Role:Retrieves the state of the CustomImageWidth parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetImageQualityModeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ImageQualityMode parameter.
Role:Retrieves the state of the ImageQualityMode parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetTempOutputDirectoryInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TempOutputDirectory parameter.
Role:Retrieves the state of the TempOutputDirectory parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Sub SetBackgroundImageModeLock( iLocked)
Locks or unlocks the BackgroundImageMode parameter.
Role:Locks or unlocks the BackgroundImageMode parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetCustomBackgroundImageLock( iLocked)
Locks or unlocks the CustomBackgroundImage parameter.
Role:Locks or unlocks the CustomBackgroundImage parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetCustomImageFormatLock( iLocked)
Locks or unlocks the CustomImageFormat parameter.
Role:Locks or unlocks the CustomImageFormat parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetCustomImageHeightLock( iLocked)
Locks or unlocks the CustomImageHeight parameter.
Role:Locks or unlocks the ImageHeight parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetCustomImageWidthLock( iLocked)
Locks or unlocks the ImageWidth parameter.
Role:Locks or unlocks the ImageWidth parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetImageQualityModeLock( iLocked)
Locks or unlocks the ImageQualityMode parameter.
Role:Locks or unlocks the DefaultImageQuality parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTempOutputDirectoryLock( iLocked)
Locks or unlocks the TempOutputDirectory parameter.
Role:Locks or unlocks the TempOutputDirectory parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

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