All Frameworks  Object Hierarchy  This Framework  Indexes  Previous Next

TreeTabSettingAtt (Object)

System.SettingController

TreeTabSettingAtt

ApplicativeDataFilter: Returns of sets the value to signify Whether "Applicative Data" created by an application is visible in the PPR tree
Role: Returns or sets the value of "Applicative Data" option to signify whether the applicative containers are visualized in the PPR tree
AssignedViewer: Returns or sets the value to signify whether the 3D Assigned Viewer is default viewer or not
Role: Returns or sets the value to signify whether 3D Assigned Viewer is default viewer or not
AttributesFilter: Returns or sets the value for "Attributes" option
Role: Returns or sets the value of "Attributes" option to signify whether the 'User Attributes' of an Activity is visualized in the PPR tree
CollapseExpandFilter: Returns or sets the value to signify Whether the double clicking on an activity expands/collapses a given activity in the PPR tree
Role: Returns or sets the value to signify Whether the double clicking on an activity expands/collapses a given activity in the PPR tree
DisplayNameMode: Returns or sets the value to signify whether the E5 Configured Name is to be displayed
Role: Returns or sets the value to signify whether the E5 Configured Name is to be displayed
DisplayOrder: Returns or sets the value for 'Display Order'
Role: Returns or sets the value of 'Display Order' to signify which order the product/resource list are in the PPR tree
DisplayProcessOrder: Returns or sets the value for 'Display Order for Processes'
Role: Returns or sets the value of 'Display Order for Processes' to signify which order the processes under ProcessList and ResourcesList are listed in the PPR tree.
ItemsFilter: Returns or sets the value for 'Items Folder'
Role: Returns or sets the value of 'Items Folder' to signify whether the 'Assigned Items' are visualized in the PPR tree
ItemsPerRelationFilter: Returns or sets the value for 'Items Folder (Per Relation Type)'
Role: Returns or sets the value of 'Items Folder(Per Relation Type)' to signify whether the 'Assigned Items'with proper relations ( like First Processes Product) are visualized in the PPR tree
LogicalActFilter: Returns or sets the value to signify Whether the logical activites are visible in the PPR tree
Role: Returns or sets the value of "Logical Activities" option to signify whether the logical activites are visible in the PPR tree
OutputProductFilter: Returns of sets the value to signify Whether "Output Products" assigned to a given activity is visible in the PPR tree
Role: Returns or sets the value of "Output Products Folder" option to signify whether the output products associated with an activity are visualized in the PPR tree
PasteSameInstance: Returns or sets the value for 'Paste Same Instance'
Role: Returns or sets the value of 'Paste Same Instance' to signify whether a same product instance in the target process document should be reused or not.
RenderStyle: Returns or sets the value to signify whether the 3D Render Style is Parallel or Perspective
Role: Returns or sets the value to signify whether the 3D Render Style is Parallel or Perspective
ResourceFilter: Returns or sets the value for 'Resources Folder'
Role: Returns or sets the value of 'Resources Folder' to signify whether the 'Assigned Resources' are visualized in the PPR tree

GetApplicativeDataFilterInfo: Retrieves environment informations for the "Applicative Data" parameter.
GetAssignedViewerInfo: Retrieves environment informations for the "Assigned Viewer" parameter.
GetAttributesFilterInfo: Retrieves environment informations for the "Attributes" parameter.
GetCollapseExpandFilterInfo: Retrieves environment informations for the "Disable Collapse/Expand" parameter.
GetDisplayNameModeInfo: Retrieves environment informations for the "Display Name Mode" parameter.
GetDisplayOrderInfo: Retrieves environment informations for the 'Display Order' parameter.
GetDisplayProcessOrderInfo: Retrieves environment informations for the 'Display Order for Processes' parameter.
GetItemsFilterInfo: Retrieves environment informations for the 'Items Folder' parameter.
GetItemsPerRelationFilterInfo: Retrieves environment informations for the 'Items Folder(Per Relation Type)' parameter.
GetLogicalActFilterInfo: Retrieves environment informations for the "Logical Activities" parameter.
GetOutputProductFilterInfo: Retrieves environment informations for the "Output Products Folder" parameter.
GetPasteSameInstanceInfo: Retrieves environment information for the 'Paste Same Instance' parameter.
GetRenderStyleInfo: Retrieves environment informations for the "Render Style" parameter.
GetResourceFilterInfo: Retrieves environment informations for the 'Resource Folder' parameter.
SetApplicativeDataFilterLock: Locks or unlocks the "Applicative Data" parameter.
SetAssignedViewerLock: Locks or unlocks the "Assigned Viewer" parameter.
SetAttributesFilterLock: Locks or unlocks the "Attributes" parameter.
SetCollapseExpandFilterLock: Locks or unlocks the "Disable Collapse/Expand" parameter.
SetDisplayNameModeLock: Locks or unlocks the "Display Name Mode" parameter.
SetDisplayOrderLock: Locks or unlocks the 'Display Order' parameter.
SetDisplayProcessOrderLock: Locks or unlocks the 'Display Order for Processes' parameter.
SetItemsFilterLock: Locks or unlocks the 'Items Folder' parameter.
SetItemsPerRelationFilterLock: Locks or unlocks the 'Items Folde(Per Relation Type)r' parameter.
SetLogicalActFilterLock: Locks or unlocks the "Logical Activities" parameter.
SetOutputProductFilterLock: Locks or unlocks the "Output Products Folder" parameter.
SetPasteSameInstanceLock: Locks or unlocks the 'Paste Same Instance' parameter.
SetRenderStyleLock: Locks or unlocks the "Render Style" parameter.
SetResourceFilterLock: Locks or unlocks the 'Resource Folder' parameter.

Properties

o Property ApplicativeDataFilter(

) As long

Returns of sets the value to signify Whether "Applicative Data" created by an application is visible in the PPR tree
Role: Returns or sets the value of "Applicative Data" option to signify whether the applicative containers are visualized in the PPR tree

o Property AssignedViewer(

) As long

Returns or sets the value to signify whether the 3D Assigned Viewer is default viewer or not
Role: Returns or sets the value to signify whether 3D Assigned Viewer is default viewer or not

o Property AttributesFilter(

) As long

Returns or sets the value for "Attributes" option
Role: Returns or sets the value of "Attributes" option to signify whether the 'User Attributes' of an Activity is visualized in the PPR tree

o Property CollapseExpandFilter(

) As long

Returns or sets the value to signify Whether the double clicking on an activity expands/collapses a given activity in the PPR tree
Role: Returns or sets the value to signify Whether the double clicking on an activity expands/collapses a given activity in the PPR tree

o Property DisplayNameMode(

) As long

Returns or sets the value to signify whether the E5 Configured Name is to be displayed
Role: Returns or sets the value to signify whether the E5 Configured Name is to be displayed

o Property DisplayOrder(

) As long

Returns or sets the value for 'Display Order'
Role: Returns or sets the value of 'Display Order' to signify which order the product/resource list are in the PPR tree

o Property DisplayProcessOrder(

) As long

Returns or sets the value for 'Display Order for Processes'
Role: Returns or sets the value of 'Display Order for Processes' to signify which order the processes under ProcessList and ResourcesList are listed in the PPR tree. Legal values:
1 : manufacturing hub order
0 : loaded order

o Property ItemsFilter(

) As long

Returns or sets the value for 'Items Folder'
Role: Returns or sets the value of 'Items Folder' to signify whether the 'Assigned Items' are visualized in the PPR tree

o Property ItemsPerRelationFilter(

) As long

Returns or sets the value for 'Items Folder (Per Relation Type)'
Role: Returns or sets the value of 'Items Folder(Per Relation Type)' to signify whether the 'Assigned Items'with proper relations ( like First Processes Product) are visualized in the PPR tree

o Property LogicalActFilter(

) As long

Returns or sets the value to signify Whether the logical activites are visible in the PPR tree
Role: Returns or sets the value of "Logical Activities" option to signify whether the logical activites are visible in the PPR tree

o Property OutputProductFilter(

) As long

Returns of sets the value to signify Whether "Output Products" assigned to a given activity is visible in the PPR tree
Role: Returns or sets the value of "Output Products Folder" option to signify whether the output products associated with an activity are visualized in the PPR tree

o Property PasteSameInstance(

) As long

Returns or sets the value for 'Paste Same Instance'
Role: Returns or sets the value of 'Paste Same Instance' to signify whether a same product instance in the target process document should be reused or not. Legal values:
1 : Always paste an instance and do not reuse existing one
0 : Reuse existing instance wherever possible

o Property RenderStyle(

) As long

Returns or sets the value to signify whether the 3D Render Style is Parallel or Perspective
Role: Returns or sets the value to signify whether the 3D Render Style is Parallel or Perspective

o Property ResourceFilter(

) As long

Returns or sets the value for 'Resources Folder'
Role: Returns or sets the value of 'Resources Folder' to signify whether the 'Assigned Resources' are visualized in the PPR tree

Methods

o Func GetApplicativeDataFilterInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the "Applicative Data" parameter.
Role:Retrieves the state of the "Applicative Data" 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 GetAssignedViewerInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the "Assigned Viewer" parameter.
Role:Retrieves the state of the "Assigned Viewer" 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 GetAttributesFilterInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the "Attributes" parameter.
Role:Retrieves the state of the "Attributes" 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 GetCollapseExpandFilterInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the "Disable Collapse/Expand" parameter.
Role:Retrieves the state of the "Disable Collapse/Expand" 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 GetDisplayNameModeInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the "Display Name Mode" parameter.
Role:Retrieves the state of the "Display Name Mode" 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 GetDisplayOrderInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the 'Display Order' parameter.
Role:Retrieves the state of the 'Display Order' 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 GetDisplayProcessOrderInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the 'Display Order for Processes' parameter.
Role:Retrieves the state of the 'Display Order for Processes' 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 GetItemsFilterInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the 'Items Folder' parameter.
Role:Retrieves the state of the 'Items Folder' 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 GetItemsPerRelationFilterInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the 'Items Folder(Per Relation Type)' parameter.
Role:Retrieves the state of the 'Items Folder(Per Relation Type)' 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 GetLogicalActFilterInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the "Logical Activities" parameter.
Role:Retrieves the state of the "Logical Activities" 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 GetOutputProductFilterInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the "Output Products Folder" parameter.
Role:Retrieves the state of the "Output Products Folder" 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 GetPasteSameInstanceInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment information for the 'Paste Same Instance' parameter.
Role:Retrieves the state of the 'Paste Same Instance' 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 GetRenderStyleInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the "Render Style" parameter.
Role:Retrieves the state of the "Render Style" 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 GetResourceFilterInfo(	CATBSTR	`ioAdminLevel`,
	CATBSTR	`ioLocked`) As boolean

Retrieves environment informations for the 'Resource Folder' parameter.
Role:Retrieves the state of the 'Resource Folder' 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 SetApplicativeDataFilterLock( boolean iLocked)

Locks or unlocks the "Applicative Data" parameter.
Role:Locks or unlocks the "Attributes" 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 SetAssignedViewerLock( boolean iLocked)

Locks or unlocks the "Assigned Viewer" parameter.
Role:Locks or unlocks the "Assigned Viewer" 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 SetAttributesFilterLock( boolean iLocked)

Locks or unlocks the "Attributes" parameter.
Role:Locks or unlocks the "Attributes" 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 SetCollapseExpandFilterLock( boolean iLocked)

Locks or unlocks the "Disable Collapse/Expand" parameter.
Role:Locks or unlocks the "Disable Collapse/Expand" 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 SetDisplayNameModeLock( boolean iLocked)

Locks or unlocks the "Display Name Mode" parameter.
Role:Locks or unlocks the "Display Name Mode" 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 SetDisplayOrderLock( boolean iLocked)

Locks or unlocks the 'Display Order' parameter.
Role:Locks or unlocks the 'Display Order' 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 SetDisplayProcessOrderLock( boolean iLocked)

Locks or unlocks the 'Display Order for Processes' parameter.
Role:Locks or unlocks the 'Display Order for Processes' 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 SetItemsFilterLock( boolean iLocked)

Locks or unlocks the 'Items Folder' parameter.
Role:Locks or unlocks the 'Items Folder' 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 SetItemsPerRelationFilterLock( boolean iLocked)

Locks or unlocks the 'Items Folde(Per Relation Type)r' parameter.
Role:Locks or unlocks the 'Items Folder(Per Relation Type)' 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 SetLogicalActFilterLock( boolean iLocked)

Locks or unlocks the "Logical Activities" parameter.
Role:Locks or unlocks the "Logical Activities" 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 SetOutputProductFilterLock( boolean iLocked)

Locks or unlocks the "Output Products Folder" parameter.
Role:Locks or unlocks the "Output Products Folder" 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 SetPasteSameInstanceLock( boolean iLocked)

Locks or unlocks the 'Paste Same Instance' parameter.
Role:Locks or unlocks the 'Paste Same Instance' 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 SetRenderStyleLock( boolean iLocked)

Locks or unlocks the "Render Style" parameter.
Role:Locks or unlocks the "Render Style" 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 SetResourceFilterLock( boolean iLocked)

Locks or unlocks the 'Resource Folder' parameter.
Role:Locks or unlocks the 'Resource Folder' 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.

TreeTabSettingAtt (Object)

Property Index

Method Index

Properties

Methods