PatternTemplateItemGetDisplayString Method
Return a formatted version of the pattern containing some information
about its settings, location, or function.
Namespace: ShopToolsAssembly: ShopTools (in ShopTools.exe) Version: 25.2429.4649
public static string GetDisplayString(
PatternTemplateItem pattern
)
Public Shared Function GetDisplayString (
pattern As PatternTemplateItem
) As String
No code example is currently available or this language may not be supported.
- pattern PatternTemplateItem
-
Reference to the pattern template or derived item for which a display
string is being created.
String
Well-formatted display string containing some information about its
settings, location, or function, as described in the DisplayFormat
property. If DisplayFormat is blank, the name of the pattern will be
returned.
Variable names are specified within curly braces in the format
{VariableName[:Format]}.
Following are the currently recognized formats.
- Abbreviation. Use an abbreviation of an entry
from a enumeration for the native item type.
- +-. Explicitly prefix a numerical value with '+', if
positive, and the natural '-' if negative.
When the name of an operational variable is specified, that reference
should be prefixed with a space-compressed version of the
corresponding OperationName for that operation, if one has been
defined.