Custom Scope Properties
The Custom Scope Properties are custom properties used to store matrix data in documents. The matrix data is assigned to the document similarly to how you assign revision data.
To assign values to Custom Scope Properties, you need to create a Model Property that has the GetUserScopeData button function with the source scope. See the related topic about the Property Wizard Functions page for more information about how to set up the desired function(s) for the custom property.
You can also export the matrix data stored in custom scope properties using the Export command. Select the desired custom property scopes to be exported in your Export profiles settings.
The Custom Scope Properties options are located in the ATR CustomTools Profile Options.
Select the desired ATR CustomTools product from the table below to display further and product-specific instructions to find the Custom Scope Properties options.
| CT product | Instructions |
|---|---|
| SOLIDWORKS Add-in |
Click Tools, ATR CustomTools, Options. The ATR CustomTools Options dialog box appear with the Profile Options tab active. Select the Custom Scope Properties node to see the options. |
| ATR CustomTools Viewer |
Click the Options command located in the ribbon. The ATR CustomTools Options dialog box appear with the Profile Options tab active. Select the Custom Scope Properties node to see the options. |
| ATR CustomTools Administration |
Login to your ATR CustomTools database, select the ATR CustomTools profile node from the Database View and then click the Profile Options command located in the Profile Settings group in the ribbon. The ATR CustomTools Options dialog box appear with the Profile Options tab active. Select the Custom Scope Properties to see the options. |
| Scopes | Available user-defined scopes. Select the desired custom scope from this box. ATR CustomTools supports four custom scopes. |
| Label | Determines the name for the custom scope. |
| Quantity Property | Choose one of the properties in the currently selected scope to be used as Quantity. This is utilized in Export in Material Quantity fields. |
Quantity Property also supports multiple decimal and fractional number formats; all the following are the same number:
- 123.75
- 123,75
- 123 3/4
- 123 ¾
| Add Group | Create a new group for custom properties. Assigning custom properties into groups eases management of the existing properties. |
| Add | Starts the Property Wizard for creating a new custom property. |
| Edit | Starts the Property Wizard for editing the selected custom property. |
| Delete | Deletes the selected property. When you have selected a Property group and then click Delete, the whole group and all the custom properties inside it are deleted. |
All Property Groups must have at least one Property. If the Property Group is empty when you exit the CustomOptions, you are prompted to create at least one Property under the empty group.
You can select the properties information shown in the properties list. Most of the following items are hidden by default. Right-click any of the properties list headers and select the desired item from the context menu to show it in the list. Right-click any of the properties list headers and clear selection of the desired item from the context menu to hide it from the list.
| Attribute Name | The attribute name used to direct the reference data into the correct place in the database. |
| Label | The caption used in the Properties pane to recognize the different properties. |
| Type | Type of the custom property. The type determines what kind of input is used to set the value for the property. |
| Scope | Shows the document type which the Property is scoped for. The Properties with scope Model are assignable for parts and assemblies. |
| Read-only | Shows whether the property is set as read-only. Read-only properties are usually linked to an external data source so their value cannot be modified by the user. |
| Hidden | Shows whether the property is visible in the Properties pane. |
| Visibility Property | Name of the property selected to control visibility of the selected property. |
| Visibility Value | Value of the property selected as the Visibility Property to make the selected property visible in the Properties pane. While the value of the property selected as the Visibility Property is anything else than the one defined as the Visibility Value, the property stays hidden in the Properties pane. |
| Required | Shows whether the selected property is mandatory. Mandatory properties must have a value assigned if they are visible in the Properties pane in order to save changes. |
| Tooltip | Tooltip text of the property. The tooltip appears when you hover the mouse pointer over the property field in the Properties pane. |
| Before Function | Shows the Before Function selected for the property. |
| After Function | Shows the After Function selected for the property. |
| Button Function | Shows the Button Function selected for the property. |
| Data Function | Shows the Data Function selected for the property. |
| Dictionary | Name of the dictionary used for selecting value for the selected property. Using a dictionary allows you to make multilingual properties for translating SOLIDWORKS drawings into other languages defined in the ATR CustomTools Translation Options. |
| Target Language | Shows the language in which the property's value is translated. |
| Source Property | The source property which the selected property's value is generated based on. |
| Combination | Name of the Combination used to generate the value of the selected property. |
| Database Search Group | Name of the Database Search Group the selected property is linked to. |
| Database Column | A column in the Database Search Group to retrieve value to the selected property from. |
| Enable in Search | Shows whether the property is enabled in the ATR CustomTools Search feature. Properties enabled in Search appear in the ATR CustomTools Search pane for using them as search conditions while looking for specific files from the ATR CustomTools database. |
| Exclude from Item Search | Shows whether the property could be used as a search condition while linking value to the property from an external data source defined as the Database Search Group. |
| Format | A format string of the property. By the format string, you can determine how, for example, the Date value appears in the associated property in the Properties pane. If the property Type is Checkbox, the Format value determines the value written to the property. |
| Format for Unchecked | If the property's Type is Checkbox, the Format for Unchecked determines the value written to the property while the checkbox associated to the property is not selected in the Properties pane. |
| Max Length | Shows the maximum length allowed to write to the property. |
| Copy as Model Prop | Shows whether the property value from another than the Model scope is copied to the Model scope. |
| Copy as Drawing Prop | Shows whether the property value from another than the Drawing scope is copied to the Drawing scope. |
| Clear on Save As | Shows whether the property value is cleared on the Save and Save As operations. |
| Uppercase | Shows whether the value of the property is written using uppercase letters. |
| Track History | Shows whether value history tracking is enabled for the property. |
| Display in Print/Convert | Shows whether the property and its value appear in the document list in the Batch Operation dialog box. |
| Display in Design Tree | Shows whether the property and its value appear in the document's Design Tree view in the ATR CustomTools Viewer. |
| Display in Copy | Shows whether the property and its value appear in the document list in the Copy feature. |
| Enable Changing in Print | Shows whether the property's value could be overwritten in ATR CustomTools Batch Operations like batch printing or batch file conversion. |
| Allow Scripting | Shows whether the property could be managed by the ATR CustomTools script add-ins. The script add-ins could be used to provide extended functionality for the Properties feature. Please note that the script add-ins have to be ordered separately and the price of the script add-in you need depends on the requirements of your project. For more information about the script add-ins, please contact ATR CustomTools Sales by email. |
| Lookup List | Name of the ATR CustomTools Lookup List used for selecting value for the property from. |