|
Text - Pad |
Declaration
<AMTEXT ACTIVITY="pad_text" TEXT="text" RESULTVARIABLE="text" ACTION="text (options)" PADTYPE="text (options)" PADDINGCHAR="text" AMOUNT="number" /> |
Description
Adds a single character to the beginning and/or end of an existing text value and populates a variable with the new value.
Practical Usage
Used as a text manipulation tool to insert new text into the beginning or end of an existing text value. For example, you can pad the end of the target text with a single space so newly added text does not butt against them.
Parameters
General
Property |
Type |
Required |
Default |
Markup |
Description |
Text to pad |
Text |
Yes |
(Empty) |
TEXT="My Name is Joe" |
The target text to be padded. As with every text parameter, if the data you wish to enter is contained in a variable, simply enter the variable name surrounded by percentage signs to resolve it to it's contents at runtime (i.e. %VarName%). |
Action |
Text (options) |
No |
pad_beginning |
|
The location that the padding should be applied. The available options are:
|
Character to pad with |
Text |
Yes |
(Empty) |
PADDINGCHAR="a" |
The character to use as the padding item. |
Padding type |
Text (options) |
No |
length |
PADTYPE="insert_position" |
The padding type that should be applied. The available options are:
|
Length of text |
Number |
Yes if Padding type set to Length |
(Empty) |
LENGTH="10" |
The total length of the text in which padding should end. This parameter is available only if the Padding type parameter is set to Until text is specific length. |
Number of times to add |
Number |
Yes if Padding type set to Amount |
(Empty) |
AMOUNT="5" |
The total amount of times that the padding should be repeated. This parameter is available only if the Padding type parameter is set to A specified number of times. |
Populate variable with result |
Text |
Yes |
(Empty) |
RESULTVARIABLE="varname" |
The name of an existing variable to receive the new value after character insertion is performed. |
Example
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
Description
This task displays a message box showing text before and after a Text - Pad activity is used.
<AMVARIABLE NAME="varname" VALUE="hello" /> <AMSHOWDIALOG WINDOWTITLE="Text before Pad activity">%varname%</AMSHOWDIALOG> <AMTEXT ACTIVITY="pad_text" TEXT="%varname%" RESULTVARIABLE="varname" ACTION="pad_end" LENGTH="" PADDINGCHAR="_" /> <AMSHOWDIALOG WINDOWTITLE="Text after Pad activity inserts a "_" character at the end of the original text.">%varname%</AMSHOWDIALOG> |