Indexes

ReportGenerationSheetSettingAtt (Object)

The interface to access a CATIAReportGenerationSheetSettingAtt.

Property Index

AllChecksReport
Returns or sets the AllChecksReport parameter.
CheckReportHtml
Returns or sets the CheckReportHtml parameter.
DirectoryForInputXsl
Returns or sets the DirectoryForInputXsl parameter.
ReportCheckAdvisor
Returns or sets the ReportCheckAdvisor parameter.
ReportCheckExpert
Returns or sets the ReportCheckExpert parameter.
ReportHtmlInCatiaSession
Returns or sets the ReportHtmlInCatiaSession parameter.
ReportObjectsInformation
Returns or sets the ReportObjectsInformation parameter.
ReportOutputDirectory
Returns or sets the ReportOutputDirectory parameter.
ReportParametersInformation
Returns or sets the ReportParametersInformation parameter.
ReportPassedObjects
Returns or sets the ReportPassedObjects parameter.

Method Index

GetAllChecksReportInfo
Retrieves environment informations for the AllChecksReport parameter.
GetCheckReportHtmlInfo
Retrieves environment informations for the CheckReportHtml parameter.
GetDirectoryForInputXslInfo
Retrieves environment informations for the DirectoryForInputXsl parameter.
GetReportCheckAdvisorInfo
Retrieves environment informations for the ReportCheckAdvisor parameter.
GetReportCheckExpertInfo
Retrieves environment informations for the ReportCheckExpert parameter.
GetReportHtmlInCatiaSessionInfo
Retrieves environment informations for the ReportHtmlInCatiaSession parameter.
GetReportObjectsInformationInfo
Retrieves environment informations for the ReportObjectsInformation parameter.
GetReportOutputDirectoryInfo
Retrieves environment informations for the ReportOutputDirectory parameter.
GetReportParametersInformationInfo
Retrieves environment informations for the ReportParametersInformation parameter.
GetReportPassedObjectsInfo
Retrieves environment informations for the ReportPassedObjects parameter.
SetAllChecksReportLock
Locks or unlocks the AllChecksReport parameter.
SetCheckReportHtmlLock
Locks or unlocks the CheckReportHtml parameter.
SetDirectoryForInputXslLock
Locks or unlocks the DirectoryForInputXsl parameter.
SetReportCheckAdvisorLock
Locks or unlocks the ReportCheckAdvisor parameter.
SetReportCheckExpertLock
Locks or unlocks the ReportCheckExpert parameter.
SetReportHtmlInCatiaSessionLock
Locks or unlocks the ReportHtmlInCatiaSession parameter.
SetReportObjectsInformationLock
Locks or unlocks the ReportObjectsInformation parameter.
SetReportOutputDirectoryLock
Locks or unlocks the ReportOutputDirectory parameter.
SetReportParametersInformationLock
Locks or unlocks the ReportParametersInformation parameter.
SetReportPassedObjectsLock
Locks or unlocks the ReportPassedObjects parameter.

Properties


o Property AllChecksReport() As
Returns or sets the AllChecksReport parameter.
Role:Return or Set the AllChecksReport parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oAllChecksReport
Legal values:
0 : report of only failed checks
1 : report of all checks.
o Property CheckReportHtml() As
Returns or sets the CheckReportHtml parameter.
Role:Return or Set the CheckReportHtml parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oCheckReportHtml
Legal values:
0 : to have check report in Xml
1 : to have check report in Html.
o Property DirectoryForInputXsl() As
Returns or sets the DirectoryForInputXsl parameter.
Role:Return or Set the DirectoryForInputXsl parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oDirectoryForInputXsl
Directory for the report file with Xml extension.
o Property ReportCheckAdvisor() As
Returns or sets the ReportCheckAdvisor parameter.
Role:Return or Set the ReportCheckAdvisor parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oReportCheckAdvisor
Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
o Property ReportCheckExpert() As
Returns or sets the ReportCheckExpert parameter.
Role:Return or Set the ReportCheckExpert parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oReportCheckExpert
Legal values:
0 : not report of check Advisor
1 : report of check Advisor.
o Property ReportHtmlInCatiaSession() As
Returns or sets the ReportHtmlInCatiaSession parameter.
Role:Return or Set the ReportHtmlInCatiaSession parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oReportHtmlInCatiaSession
Legal values:
0 : report Html outside CATIA session
1 : report Html in CATIA session.
o Property ReportObjectsInformation() As
Returns or sets the ReportObjectsInformation parameter.
Role:Return or Set the ReportObjectsInformation parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oReportObjectsInformation
Legal values:
0 : not report objects information
1 : report objects information.
o Property ReportOutputDirectory() As
Returns or sets the ReportOutputDirectory parameter.
Role:Return or Set the ReportOutputDirectory parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oReportOutputDirectory
The output directory for report of checks expert and checks advisor.
o Property ReportParametersInformation() As
Returns or sets the ReportParametersInformation parameter.
Role:Return or Set the ReportParametersInformation parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oReportParametersInformation
Legal values:
0 : not check Advisor parameter information
1 : check Advisor parameter information.
o Property ReportPassedObjects() As
Returns or sets the ReportPassedObjects parameter.
Role:Return or Set the ReportPassedObjects parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oReportPassedObjects
Legal values:
0 : not report passed objects
1 : report passed objects.

Methods


o Func GetAllChecksReportInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the AllChecksReport parameter.
Role:Retrieves the state of the AllChecksReport 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 GetCheckReportHtmlInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the CheckReportHtml parameter.
Role:Retrieves the state of the CheckReportHtml 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 GetDirectoryForInputXslInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the DirectoryForInputXsl parameter.
Role:Retrieves the state of the DirectoryForInputXsl 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 GetReportCheckAdvisorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ReportCheckAdvisor parameter.
Role:Retrieves the state of the ReportCheckAdvisor 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 GetReportCheckExpertInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ReportCheckExpert parameter.
Role:Retrieves the state of the ReportCheckExpert 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 GetReportHtmlInCatiaSessionInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ReportHtmlInCatiaSession parameter.
Role:Retrieves the state of the ReportHtmlInCatiaSession 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 GetReportObjectsInformationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ReportObjectsInformation parameter.
Role:Retrieves the state of the ReportObjectsInformation 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 GetReportOutputDirectoryInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ReportOutputDirectory parameter.
Role:Retrieves the state of the ReportOutputDirectory 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 GetReportParametersInformationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ReportParametersInformation parameter.
Role:Retrieves the state of the ReportParametersInformation 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 GetReportPassedObjectsInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ReportPassedObjects parameter.
Role:Retrieves the state of the ReportPassedObjects 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 SetAllChecksReportLock( iLocked)
Locks or unlocks the AllChecksReport parameter.
Role:Locks or unlocks the AllChecksReport 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 SetCheckReportHtmlLock( iLocked)
Locks or unlocks the CheckReportHtml parameter.
Role:Locks or unlocks the CheckReportHtml 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 SetDirectoryForInputXslLock( iLocked)
Locks or unlocks the DirectoryForInputXsl parameter.
Role:Locks or unlocks the DirectoryForInputXsl 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 SetReportCheckAdvisorLock( iLocked)
Locks or unlocks the ReportCheckAdvisor parameter.
Role:Locks or unlocks the ReportCheckAdvisor 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 SetReportCheckExpertLock( iLocked)
Locks or unlocks the ReportCheckExpert parameter.
Role:Locks or unlocks the ReportCheckExpert 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 SetReportHtmlInCatiaSessionLock( iLocked)
Locks or unlocks the ReportHtmlInCatiaSession parameter.
Role:Locks or unlocks the ReportHtmlInCatiaSession 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 SetReportObjectsInformationLock( iLocked)
Locks or unlocks the ReportObjectsInformation parameter.
Role:Locks or unlocks the ReportObjectsInformation 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 SetReportOutputDirectoryLock( iLocked)
Locks or unlocks the ReportOutputDirectory parameter.
Role:Locks or unlocks the ReportOutputDirectory 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 SetReportParametersInformationLock( iLocked)
Locks or unlocks the ReportParametersInformation parameter.
Role:Locks or unlocks the ReportParametersInformation 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 SetReportPassedObjectsLock( iLocked)
Locks or unlocks the ReportPassedObjects parameter.
Role:Locks or unlocks the ReportPassedObjects 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.