Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Anchor
1155036
1155036
Syntax

...

format

...

variable

...

_name

...

[

...

{

...

string

...

_1

...

|

...

expression

...

_1

...

}

...

[align=

...

{

...

center

...

|

...

left

...

|

...

right

...

|

...

justify

...

}

...

]

...

[pad=

...

sequence

...

]

...

[trunc=

...

yes

...

|

...

no

...

]

...

[length=

...

length

...

]

...

]...

...

[

...

{

...

string

...

_n

...

|

...

expression

...

_n

...

}

...

[align=

...

center

...

|

...

left

...

|

...

right

...

|

...

justify

...

]

...

[pad=

...

sequence

...

]

...

[trunc=

...

yes

...

|

...

no

...

]

...

[length=

...

length

...

]

...

]









Anchor
1155042
1155042
Description

...

Anchor
1155047
1155047
Parameters

...

cellspacing0
styletext-align: left; width: 100%;
classTable_with_Header

...

stylebackground-color: #F0F0F0; border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: middle; width: 144pt;

...

Parameter

...

stylebackground-color: #F0F0F0; border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: middle; width: 360pt;

...

Description

...

styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

...

variable_name

...

styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

...

styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

...

Variable or list element in which the newly formatted string is stored

...

string_1 | expression_1

...

styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

...

First section of the string

...

...

align=center | left | right | justify

...

...

Method of how the value is aligned within the given space.

...

styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

...

Default alignment is left.

...

pad=sequence

...

styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

...

...

Character(s) used to pad out the formatted value.

...

...

Default is space character.

...

styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

...

trunc=yes | no

...

...

Truncates the value to the length given by length if it is longer than that value.

...

...

styleborder-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top;

...

Default is to not truncate.

...

length=length

...

...

Length of the formatted field.

...

...

Default is length of the value specified.

Anchor
1155085
1155085
Examples


Anchor
1155086
1155086
The following examples demonstrate the format command.

html-bobswift
Panel


<pre>
set firstname="Stonebranch"
set lastname="Incorporated"
format mystring "First Name: " "$(firstname)"  " Last Name: " +
"$(lastname)" length=3 trunc=yes*
echo "$(mystring)"*

Output:
First Name: Stonebranch Last Name: Inc

format mystring "The " "Value " "Is: " 4 length=8 align=right pad=0*
echo "$(mystring)"
The Value Is: E8E8E804
</pre>


Anchor
1154381
1154381