Textbox capability in Topology updated by AC E-R

Format

TYPE=AC | CLASS=Topology Textbox ... object-class
        | INSTANCE=[textbox-object-name] ... object-name
        | attribute-name=attribute-value ...

Textbox can be added with default attribute values using the command:

TYPE=AC | CLASS=Topology Textbox| INSTANCE=[textbox-object-name]

Textbox attribute values can be modified using the command:

TYPE=AC | CLASS=Topology Textbox| INSTANCE=[textbox-object-name]|
        attribute-name=attribute-value

Multiple attributes can be modified in a single command.

Textbox can be deleted using the Delete Object Event Reports:

TYPE=DE | CLASS=Topology Textbox| INSTANCE=[textbox-object-name]

Examples

The following example creates a textbox named "Demo-Textbox:"

"TYPE=AC  | CLASS=Topology Textbox
          | INSTANCE=Demo-Textbox
          | String=Topology Textbox demo
          | font Size=15
          | Border Color=green">

The following example modifies the font size and border color of the "Demo Textbox" textbox:

TYPE=AC   | CLASS=Topology Textbox
          | INSTANCE=Demo-Textbox
          | String=Topology Textbox demo
          | font Size=18
          | Border Color=red
          | Background Color=green">

The following example adds background color to the textbox:

TYPE=AC   | CLASS=Topology Textbox
          | INSTANCE=Demo-Textbox
          | String=Topology Textbox demo
          | Background Color=green">

The following example creates a textbox with the default string "Textbox:"

"TYPE=AC   | CLASS=Topology Textbox
           | INSTANCE=Textbox-1
           | Font Style=1">

The following example modifies the "Textbox-1" textbox with the string attribute:

"TYPE=AC   | CLASS=Topology Textbox
           | INSTANCE=Textbox-1
           | Font Style=1
           | String=Welcome to Textbox demo">

The following example aligns the text to the center of the textbox:

"TYPE=AC   | CLASS=Topology Textbox
           | INSTANCE=Demo-Textbox
           | String=Topology Textbox demo
           | font Size=10|Border Color=green
           | Auto Size=False|Size=250,60
           | Text Style= VerticalCenter, HorizontalCenter ">

The following example displays the string in bold, underlined, and italics: 

"TYPE=AC   | CLASS=Topology Textbox
           | INSTANCE=Demo-Textbox
           | String=Topology Textbox demo
           | font Size=10
           | Border Color=green
           | Auto Size=False
           | Size=250,60
           | Text Style= VerticalCenter, HorizontalCenter
           | Font style=Bold+Underline+italic">

Attribute-Name List

The following table lists the attributes available for Topology Textbox.

Table 9. Attribute-Name List

Serial Number

Attribute Name

Attribute Value Type

Description

Default value

Example

1

Auto Size

Bool

Automatically resizes the text box when set to True.

While setting Auto Size attribute as False, Size attribute should also be set for the desired results.

While setting Auto Size attribute as True, Size attribute values are not applicable and should be ignored.

True

TYPE=AC| ... Auto Size=False

2

Size

Size

Size of the Topology Textbox excluding the border.

Values are in pixels.

Notes:

  • Size of the Textbox grows horizontally (Single line) when Auto Size=True. However when Auto Size=False, text can be displayed in multiple lines by setting the attribute Text Style = WordBreak.

  • Textbox with larger values (for example, height: 200 and width: 300) affects the performance of the Operations Sentinel Console.

Size of the Textbox as per the String attribute value.

TYPE=AC| ... Size=200,30

3

Visible

Bool

Controls whether the Topology Textbox is visible or hidden.

True

TYPE=AC| ... Visible=False

4

Border Color

Color

Color of the border.

The value can either be the RGB numeric (nnn,nnn,nnn), where nnn is the number between 0-255, or the actual color. Refer to Table 9-5 for more information on valid color names.

255,0,0

TYPE=AC| ... Border Color=Red or TYPE=AC| ... Border Color=255,0,0

5

Border Style

DashStyle

Style of the border. Refer to Table 9–4 for more information on border styles.

Solid

TYPE=AC| ... Border Style=Solid or TYPE=AC| ... Border Style=DashDot Dot

6

Border Width

Integer

Width of the border in pixels.

2

TYPE=AC| ... Border Width=6

7

Background Color

Color

Background color of the Topology Textbox.

The value can either be the RGB numeric (nnn,nnn,nnn), where nnn is the number between 0-255, or the actual color. Refer to Table 9-5 for more information on valid color names.

White or

255,255,255

TYPE=AC| ... Background Color=White or TYPE=AC| ... Background Color=255,255, 255

8

Font Size

Single

Font size set for the text contents of Topology Textbox.

Minimum Font Size: 0

Maximum Font Size: 30

Note: The font size will be considered as 30 if it crosses the maximum value.

8.5

TYPE=AC| ... Font Size=16

9

Font Family

String

Name of the Font family set for Topology Textbox.

The font family must be present on the server where Operations Sentinel Console (OSC) is installed.

GenericSans Serif

TYPE=AC| ... Font Name=Verdana

10

Font Style

FontStyle

Font style for the Topology Textbox.

Refer to Table 9–2 for more information on different font styles.

Regular

TYPE=AC| ... Font Style=bold or TYPE=AC| ... Font Style=bold+italic

11

Foreground Color

Color

Foreground color of the Topology Textbox.

The value can either be the RGB numeric (nnn,nnn,nnn), where nnn is the number between 0-255, or the actual color. Refer to Table 9-5 for more information on valid color names

Black or 0,0,0

TYPE=AC| ... Foreground Color=Black

TYPE=AC| ... Foreground Color=0,0,0

12

String

String

Topology text in String format. By default, the String attribute has a value of Textbox.

Minimum String Length: 0 Characters

Maximum String Length: 255 Characters

Note: If the length of the string crosses the maximum value, it will be truncated to 255 characters.

Textbox

TYPE=AC| ... String=This is the new label for textbox-1

13

Text Style

TextFormat Flags

Style of the text

Refer to Table 9–3 for more information on text formats.

GlyphOverhangPadding

TYPE=AC| ... Text Style=Default or TYPE=AC| ... Text Style=Bottom


Notes:

  • There are no mandatory Attribute pairs for the Topology Textbox class.

  • Multiple Attribute pairs can be used in a single command.

  • Textbox properties can be viewed by clicking on the Textbox Properties icon in Topology under the Operations Mode of OSC (Operations Sentinel Console).

  • Dynamic resizing of the Topology Textbox using AC event report causes overlapping of the textbox with other managed objects in Operations Sentinel Console. Change the view in Operations Sentinel Console to realign the overlapped managed objects.

Styles Available for Attribute Font Style

The following table lists the font styles available for attribute Font Style.

Table 10. Font-Styles

Font Style Name

Example

regular

Regular style

bold

Bold style

italic

Italic style

italic+bold

Italic + Bold style

underline

Underline style

underline+bold

Underline + Bold style

underline+italic

Underline + Italic style

strikeout

strikeout style

strikeout +bold

strikeout + Bold style

strikeout +italic

strikeout + Italic style

strikeout +underline

strikeout+ Underline style


Formats Available for Attribute Text Style

The following table lists the formats available for text style.

Table 11. Text Style

Text Style Name

Details

Default

Applies the default formatting, which is left aligned.

Top

Aligns the text on top of the bounding rectangle.

Left

Aligns the text on the left side of the clipping area.

GlyphOverhangPadding

Adds padding to the bounding rectangle to accommodate overhanging glyphs.

HorizontalCenter

Centers the text horizontally within the bounding rectangle.

Right

Aligns the text on the right side of the clipping area.

VerticalCenter

Centers the text vertically, within the bounding rectangle.

Bottom

Aligns the text on the bottom of the bounding rectangle. Applied only when the text is a single line.

WordBreak

Breaks the text at the end of a word.

SingleLine

Displays the text in a single line.

NoClipping

Allows the overhanging parts of glyphs and unwrapped text reaching outside the formatting rectangle to show.

NoPrefix

Turns off processing of prefix characters. Typically, the ampersand (&) mnemonic-prefix character is interpreted as a directive to underscore the character that follows, and the double ampersand (&&) mnemonic-prefix characters as a directive to print a single ampersand. By specifying NoPrefix, this processing is turned off. For example, an input string of "A&bc&&d" with NoPrefix applied would result in output of "A&bc&&d".

WordEllipsis

Trims the line to the nearest word and an ellipsis is placed at the end of a trimmed line.

NoPadding

Does not add padding to the bounding rectangle.

LeftAndRightPadding

Adds padding to both sides of the bounding rectangle.

VerticalCenter, HorizontalCenter

Aligns the text to the center of the Textbox.


Styles Available for Attribute Border Style

The following table lists the styles available for attribute Border Style.

Table 12. Border Styles

Border Style Name

Details

Examples

Dash

Specifies a line consisting of dashes.

------

DashDot

Specifies a line consisting of repeating pattern of dash-dot.

-•-•-

DashDotDot

Specifies a line consisting of a repeating pattern of dash-dot-dot.

-••-•

Dot

Specifies a line consisting of dots.

•••••

Solid

Specifies a solid line.

------


Colors Available for Border Color, Foreground Color, and Background Color attributes

The following table lists the available Colors.

Table 13. Color Names

Alice Blue

Cyan

DimGray

Lavender Blush

Antique White

Dark Blue

Dodger Blue

Lawn Green

Aqua

Dark Cyan

Firebrick

Lemon Chiffon

Aquamarine

Dark Goldenrod

Floral White

Light Blue

Azure

Dark Gray

Forest Green

Light Coral

Beige

Dark Green

Fuchsia

Light Cyan

Bisque

Dark Khaki

Gainsboro

Light Goldenrod Yellow

Black

Dark Magenta

Ghost White

Light Gray

Blanched Almond

Dark Olive Green

Gold

Light Green

Blue

Dark Orange

Goldenrod

Light Pink

Blue Violet

Dark Orchid

Gray

Light Salmon

Brown

Dark Red

Green

Light Sea Green

Burlywood

Dark Salmon

Green Yellow

Light Sky Blue

Cadet Blue

Dark Sea Green

Honeydew

Light Slate Gray

Chartreuse

Dark Slate Blue

Hot Pink

Light Steel Blue

Chocolate

Dark Slate Gray

Indian Red

Light Yellow

Coral

Dark Turquoise

Indigo

Lime

Cornflower Blue

Dark Violet

Ivory

Lime Green

Cornsilk

Deep Pink

Khaki

Linen

Crimson

Deep Sky Blue

Powder Blue

Spring Green

Magenta

Navy

Purple

Steel Blue

Maroon

Old Lace

Red

Tan

Medium Aquamarine

Olive

Rosy Brown

Teal

Medium Blue

Olive Drab

Royal Blue

Thistle

Medium Orchid

Orange

Saddle Brown

Tomato

Medium Purple

Orange Red

Salmon

Transparent

Medium Sea Green

Orchid

Sandy Brown

Turquoise

Medium Slate Blue

Pale Goldenrod

Sea Green

Violet

Medium Spring Green

Pale Green

SeaShell

Wheat

Medium Turquoise

Pale Turquoise

Sienna

White

Medium VioletRed

Pale Violet Red

Silver

White Smoke

Midnight Blue

Papaya Whip

Sky Blue

Yellow

Mint Cream

Peach Puff

Slate Blue

Yellow Green

Misty Rose

Peru

Slate Gray

 

Moccasin

Pink

Snow

 

Navajo White

Plum

Lavender