Predefined tab

A predefined parameter is one of a set of parameters that are automatically available to all library objects created in the
Library Designer
. They are defined and scoped by the program. They are the same for all library objects in the hierarchy, as well as for all elements of all library objects, and are available to all substitutions, expressions, and functions. Users cannot create, modify, or delete predefined parameters.
IMPORTANT:
All predefined parameters are available to the
Expression Builder
 regardless of the scope of the current element. A predefined parameter used to supply a field value to an object or element of higher scope will return no value.
Care should be taken to scope predefined parameters correctly when they are used to populate field values.
Predefined parameters are populated during instantiation when a library object is added to an
Application Code Manager
 project.
Predefined parameters cannot be copied or pasted, since they are defined by the
Library Designer
 and are identical for all library objects.
Predefined Parameters are listed alphabetically and are grouped by scope.
  • Group names display in blue. Collapse and expand the groups using the arrow buttons on the right or by double-clicking the group name. Parameters display alphabetically within their groups. All of the columns are sortable.
  • Predefined parameters sort within their groups.
  • The items listed cannot be moved up or moved down independently of the sort order.
  • Use
    FindPartial
     or
    FindPrefix
     to limit the items listed
This table describes the predefined parameters.
Name
Data Type
Description
Global
ControllerDescription
String
Description of the controller for the current project.
ControllerName
String
Name of the controller for the current project.
MotionGroupName
String
Name of the group.
ParentName
String
Name of the Object or element that contains the current element.
ProcessorType
String
Processor type of the controller for the current project.
ProjectDescription
String
Description of the current project.
ProjectName
String
Name of the current project.
SoftwareRevision
String
Software revision number of the controller for the current project.
Local
ObjectDescription
String
Description of the current library object.
ObjectName
String
Name of the current library object.
ProgramDescription
String
Description of the program that contains the current element.
ProgramName
String
Name of the program that contains the current element.
SubObjectDescription
String
Description of the subobject that contains the current element.
SubObjectName
String
Name of the subobject that contains the current element.
TaskDescription
String
Description of the task that contains the current element.
TaskName
String
Name of the task that contains the current element.
Modules
ParentChassisName
String
For module library objects only: The chassis name of the current library object.
ParentChassisSize
Integer
For module library objects only: The chassis size of the current library object.
ParentChassisSlot
Integer
For module library objects only: The chassis slot of the current library object.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal