All Frameworks  Object Hierarchy  This Framework  Indexes

MarkerSettingAtt (Object)

Interface to handle the Marker settings

The different settings are:

MarkerAutoUpdate
Update on product structure modifications and scenes activation.


MarkerDefaultsColor


MarkerDefaultsWeight


MarkerDefaultsDashed


Marker2DAutoNaming


Marker3DAutoNaming


MarkerTextColor2D


MarkerTextWeight2D


MarkerTextDashed2D


MarkerTextDefaultsFont2D


MarkerTextDefaultsSize2D


MarkerTextColor3D


MarkerTextWeight3D


MarkerTextDashed3D


MarkerTextDefaultsFont3D


MarkerTextDefaultsSize3D

Property Index

Marker2DAutoNaming
Returns or sets the activation state for 2D annotations automatic naming (TRUE naming is automatic, FALSE the naming is not automatic).
Marker3DAutoNaming
Returns or sets the activation state for 3D annotations automatic naming (TRUE naming is automatic, FALSE the naming is not automatic).
MarkerDefaultsDashed
Returns or sets the default dashed value of an annotation (oValue the dashed value).
MarkerDefaultsWeight
Returns or sets the default weight value of an annotation (oValue the weight value).
MarkerTextDashed2D
Returns or sets the default dashed value of a 2D text annotation (oValue the dashed value).
MarkerTextDashed3D
Returns or sets the default dashed value of a 3D text annotation (oValue the dashed value).
MarkerTextDefaultsFont2D
Returns or sets the default font of a 2D annotation (oValue the font name).
MarkerTextDefaultsFont3D
Returns or sets the default font of a 3D annotation (oValue the font name).
MarkerTextDefaultsSize2D
Returns or sets the default size value of a 2d annotation (oValue the size value).
MarkerTextDefaultsSize3D
Returns or sets the default size value of a 3d annotation (oValue the size value).
MarkerTextWeight2D
Returns or sets the default weight value of a 2D text annotation (oValue the weight value).
MarkerTextWeight3D
Returns or sets the default weight value of a 3D text annotation (oValue the weight value).

Method Index

GetMarker2DAutoNamingInfo
Retrieves environment informations for the Marker2DAutoNaming parameter.
GetMarker3DAutoNamingInfo
Retrieves environment informations for the Marker3DAutoNaming parameter.
GetMarkerDefaultsColorInfo
Retrieves environment informations for the MarkerDefaultsColor parameter.
GetMarkerDefaultsColor
Returns the default color of an annotation (oRed, oGreen, oBlue: RGB values of the color).
GetMarkerDefaultsDashedInfo
Retrieves environment informations for the MarkerDefaultsDashed parameter.
GetMarkerDefaultsWeightInfo
Retrieves environment informations for the MarkerDefaultsWeight parameter.
GetMarkerTextColor2DInfo
Retrieves environment informations for the MarkerTextColor2D parameter.
GetMarkerTextColor2D
Returns the default color of a 2D text annotation (oRed, oGreen, oBlue: RGB values of the color).
GetMarkerTextColor3DInfo
Retrieves environment informations for the MarkerTextColor3D parameter.
GetMarkerTextColor3D
Returns the default color of a 3D text annotation (oRed, oGreen, oBlue: RGB values of the color).
GetMarkerTextDashed2DInfo
Retrieves environment informations for the MarkerTextDashed2D parameter.
GetMarkerTextDashed3DInfo
Retrieves environment informations for the MarkerTextDashed3D parameter.
GetMarkerTextDefaultsFont2DInfo
Retrieves environment informations for the MarkerDefaultsFont2D parameter.
GetMarkerTextDefaultsFont3DInfo
Retrieves environment informations for the MarkerDefaultsFont3D parameter.
GetMarkerTextDefaultsSize2DInfo
Retrieves environment informations for the MarkerDefaultsSize2D parameter.
GetMarkerTextDefaultsSize3DInfo
Retrieves environment informations for the MarkerDefaultsSize3D parameter.
GetMarkerTextWeight2DInfo
Retrieves environment informations for the MarkerTextWeight2D parameter.
GetMarkerTextWeight3DInfo
Retrieves environment informations for the MarkerTextWeight3D parameter.
SetMarker2DAutoNamingLock
Locks or unlocks the Marker2DAutoNaming parameter.
SetMarker3DAutoNamingLock
Locks or unlocks the Marker3DAutoNaming parameter.
SetMarkerDefaultsColorLock
Locks or unlocks the MarkerDefaultsColor parameter.
SetMarkerDefaultsColor
Sets the default color of an annotation (iRed, iGreen, iBlue: RGB values for the desired color)
SetMarkerDefaultsDashedLock
Locks or unlocks the MarkerDefaultsDashed parameter.
SetMarkerDefaultsWeightLock
Locks or unlocks the MarkerDefaultsWeight parameter.
SetMarkerTextColor2DLock
Locks or unlocks the MarkerTextColor2D parameter.
SetMarkerTextColor2D
Sets the default color of a 2D text annotation (iRed, iGreen, iBlue: RGB values for the desired color).
SetMarkerTextColor3DLock
Locks or unlocks the MarkerTextColor3D parameter.
SetMarkerTextColor3D
Sets the default color of a 3D text annotation (iRed, iGreen, iBlue: RGB values for the desired color).
SetMarkerTextDashed2DLock
Locks or unlocks the MarkerTextDashed parameter.
SetMarkerTextDashed3DLock
Locks or unlocks the MarkerTextDashed3D parameter.
SetMarkerTextDefaultsFont2DLock
Locks or unlocks the MarkerDefaultsFont2D parameter.
SetMarkerTextDefaultsFont3DLock
Locks or unlocks the MarkerDefaultsFont3D parameter.
SetMarkerTextDefaultsSize2DLock
Locks or unlocks the MarkerDefaultsSize2D parameter.
SetMarkerTextDefaultsSize3DLock
Locks or unlocks the MarkerDefaultsSize3D parameter.
SetMarkerTextWeight2DLock
Locks or unlocks the MarkerTextWeight2D parameter.
SetMarkerTextWeight3DLock
Locks or unlocks the MarkerTextWeight3D parameter.

Properties


o Property Marker2DAutoNaming() As
Returns or sets the activation state for 2D annotations automatic naming (TRUE naming is automatic, FALSE the naming is not automatic).
o Property Marker3DAutoNaming() As
Returns or sets the activation state for 3D annotations automatic naming (TRUE naming is automatic, FALSE the naming is not automatic).
o Property MarkerDefaultsDashed() As
Returns or sets the default dashed value of an annotation (oValue the dashed value).
o Property MarkerDefaultsWeight() As
Returns or sets the default weight value of an annotation (oValue the weight value).
o Property MarkerTextDashed2D() As
Returns or sets the default dashed value of a 2D text annotation (oValue the dashed value).
o Property MarkerTextDashed3D() As
Returns or sets the default dashed value of a 3D text annotation (oValue the dashed value).
o Property MarkerTextDefaultsFont2D() As
Returns or sets the default font of a 2D annotation (oValue the font name).
o Property MarkerTextDefaultsFont3D( iValue)
Returns or sets the default font of a 3D annotation (oValue the font name).
o Property MarkerTextDefaultsSize2D() As
Returns or sets the default size value of a 2d annotation (oValue the size value)..
o Property MarkerTextDefaultsSize3D( iValue)
Returns or sets the default size value of a 3d annotation (oValue the size value)..
o Property MarkerTextWeight2D() As
Returns or sets the default weight value of a 2D text annotation (oValue the weight value).
o Property MarkerTextWeight3D( iValue)
Returns or sets the default weight value of a 3D text annotation (oValue the weight value).

Methods


o Func GetMarker2DAutoNamingInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the Marker2DAutoNaming parameter.
Role:Retrieves the state of the Marker2DAutoNaming 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 GetMarker3DAutoNamingInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the Marker3DAutoNaming parameter.
Role:Retrieves the state of the Marker3DAutoNaming 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 GetMarkerDefaultsColorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerDefaultsColor parameter.
Role:Retrieves the state of the MarkerDefaultsColor 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 GetMarkerDefaultsColor( oRed,
oGreen,
oBlue)
Returns the default color of an annotation (oRed, oGreen, oBlue: RGB values of the color).
o Func GetMarkerDefaultsDashedInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerDefaultsDashed parameter.
Role:Retrieves the state of the MarkerDefaultsDashed 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 GetMarkerDefaultsWeightInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerDefaultsWeight parameter.
Role:Retrieves the state of the MarkerDefaultsWeight 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 GetMarkerTextColor2DInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerTextColor2D parameter.
Role:Retrieves the state of the MarkerTextColor2D 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 GetMarkerTextColor2D( oRed,
oGreen,
oBlue)
Returns the default color of a 2D text annotation (oRed, oGreen, oBlue: RGB values of the color).
o Func GetMarkerTextColor3DInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerTextColor3D parameter.
Role:Retrieves the state of the MarkerTextColor3D 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 GetMarkerTextColor3D( oRed,
oGreen,
oBlue)
Returns the default color of a 3D text annotation (oRed, oGreen, oBlue: RGB values of the color).
o Func GetMarkerTextDashed2DInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerTextDashed2D parameter.
Role:Retrieves the state of the MarkerTextDashed2D 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 GetMarkerTextDashed3DInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerTextDashed3D parameter.
Role:Retrieves the state of the MarkerTextDashed3D 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 GetMarkerTextDefaultsFont2DInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerDefaultsFont2D parameter.
Role:Retrieves the state of the MarkerDefaultsFont2D 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 GetMarkerTextDefaultsFont3DInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerDefaultsFont3D parameter.
Role:Retrieves the state of the MarkerDefaultsFont3D 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 GetMarkerTextDefaultsSize2DInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerDefaultsSize2D parameter.
Role:Retrieves the state of the MarkerDefaultsSize2D 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 GetMarkerTextDefaultsSize3DInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerDefaultsSize3D parameter.
Role:Retrieves the state of the MarkerDefaultsSize3D 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 GetMarkerTextWeight2DInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerTextWeight2D parameter.
Role:Retrieves the state of the MarkerTextWeight2D 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 GetMarkerTextWeight3DInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MarkerTextWeight3D parameter.
Role:Retrieves the state of the MarkerTextWeight3D 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 SetMarker2DAutoNamingLock( iLocked)
Locks or unlocks the Marker2DAutoNaming parameter.
Role:Locks or unlocks the Marker2DAutoNaming 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 SetMarker3DAutoNamingLock( iLocked)
Locks or unlocks the Marker3DAutoNaming parameter.
Role:Locks or unlocks the Marker3DAutoNaming 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 SetMarkerDefaultsColorLock( iLocked)
Locks or unlocks the MarkerDefaultsColor parameter.
Role:Locks or unlocks the MarkerDefaultsColor 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 SetMarkerDefaultsColor( iRed,
iGreen,
iBlue)
Sets the default color of an annotation (iRed, iGreen, iBlue: RGB values for the desired color)
o Sub SetMarkerDefaultsDashedLock( iLocked)
Locks or unlocks the MarkerDefaultsDashed parameter.
Role:Locks or unlocks the MarkerDefaultsDashed 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 SetMarkerDefaultsWeightLock( iLocked)
Locks or unlocks the MarkerDefaultsWeight parameter.
Role:Locks or unlocks the MarkerDefaultsColor 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 SetMarkerTextColor2DLock( iLocked)
Locks or unlocks the MarkerTextColor2D parameter.
Role:Locks or unlocks the MarkerTextColor2D 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 SetMarkerTextColor2D( iRed,
iGreen,
iBlue)
Sets the default color of a 2D text annotation (iRed, iGreen, iBlue: RGB values for the desired color).
o Sub SetMarkerTextColor3DLock( iLocked)
Locks or unlocks the MarkerTextColor3D parameter.
Role:Locks or unlocks the MarkerTextColor3D 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 SetMarkerTextColor3D( iRed,
iGreen,
iBlue)
Sets the default color of a 3D text annotation (iRed, iGreen, iBlue: RGB values for the desired color).
o Sub SetMarkerTextDashed2DLock( iLocked)
Locks or unlocks the MarkerTextDashed parameter.
Role:Locks or unlocks the MarkerTextDashed2D 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 SetMarkerTextDashed3DLock( iLocked)
Locks or unlocks the MarkerTextDashed3D parameter.
Role:Locks or unlocks the MarkerTextDashed3D 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 SetMarkerTextDefaultsFont2DLock( iLocked)
Locks or unlocks the MarkerDefaultsFont2D parameter.
Role:Locks or unlocks the MarkerDefaultsFont2D 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 SetMarkerTextDefaultsFont3DLock( iLocked)
Locks or unlocks the MarkerDefaultsFont3D parameter.
Role:Locks or unlocks the MarkerDefaultsSize3D 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 SetMarkerTextDefaultsSize2DLock( iLocked)
Locks or unlocks the MarkerDefaultsSize2D parameter.
Role:Locks or unlocks the MarkerDefaultsSize3D 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 SetMarkerTextDefaultsSize3DLock( iLocked)
Locks or unlocks the MarkerDefaultsSize3D parameter.
Role:Locks or unlocks the MarkerDefaultsSize3D 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 SetMarkerTextWeight2DLock( iLocked)
Locks or unlocks the MarkerTextWeight2D parameter.
Role:Locks or unlocks the MarkerTextWeight2D 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 SetMarkerTextWeight3DLock( iLocked)
Locks or unlocks the MarkerTextWeight3D parameter.
Role:Locks or unlocks the MarkerTextWeight3D 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 © 2003, Dassault Systèmes. All rights reserved.