Template Objects (Object Object)

ClosedDescription

The Object object represents an object that you placed on your document, such as a barcode or text object.

All properties contained within the Object object can only be used in document-level event scripts, accessed from the BarTender Document Options dialog. They cannot be used in data source scripts or transform scripts.

ClosedObject Properties

Name

Description

Supported Object Type(s)

BarCodeColor

Sets or returns the object's color. See BtColor for standard color constant values.

Barcode

Comment

Sets or returns the object's comment string. The comment is typically set using the object's property dialog.

All

CornerRadius

Sets or returns a box's corner radius.

Box

DoNotPrint

Sets or returns whether to print the object.

All

EncodedValue

Returns the encoded value in Hex of the specified RFID object. Read-only.

Encoder

FillColor

Sets or returns the object's fill color. See BtColor for standard color constant values.

Box, Ellipse

FontBold

Sets or returns whether or not the object's text is bold faced.

Barcode, Text

FontItalic

Sets or returns whether or not the object's text is italicized.

Barcode, Text

FontName

Sets or returns the object's text font name.

Barcode, Text

FontScale

Sets or returns the object's text font scale.

Barcode, Text

FontScript

Sets or returns an object's text script. See BtFontScript for standard constant values.

Barcode, Text

FontSize

Sets or returns whether the font point size of the object's text.

Barcode, Text

FontStrikeout

Sets or returns whether there is a line through the object's text.

Barcode, Text

FontUnderline

Sets or returns whether of not the object's text is underlined.

Barcode, Text

FontWeight

Sets or returns the font weight of the object's text. See BtFontWeight for standard constant values.

Barcode, Text

Height

Sets or returns an object's height. For text objects, the height applies only if the text is formatted as a paragraph; otherwise, it is ignored.

Box, Ellipse, Barcode, Picture ,Text

HumanReadableValue

Returns the human readable value of the specified barcode object. Read-only.

Barcode

Length

Sets or returns the length of a line object.

Line

LineColor

Sets or returns an object's line color. See BtColor for standard color constant values.

Box, Ellipse, Line

LineEndX

Sets or returns the X coordinate of a line object's ending point.

Line

LineEndY

Sets or returns the Y coordinate of a line object's ending point.

Line

LineStartX

Sets or returns the X coordinate of a line object's starting point.

Line

LineStartY

Sets or returns the Y coordinate of a line object's starting point.

Line

LineThickness

Sets or returns the line thickness of an object.

Box, Ellipse, Line

MirrorHorizontal

Sets or returns whether or not a picture is mirrored horizontally.

Picture

MirrorVertical

Sets or returns whether or not a picture is mirrored vertically.

Picture

Name

Returns the object name. Read-only.

All

PercentHeight

Sets or returns a picture object's percentage of original height.

Picture

PercentWidth

Sets or returns a picture's percentage of the original width.

Picture

PicturePath

Sets or returns a picture object's path.

Picture

PreserveAspectRatio

Sets or returns whether or not a picture's aspect ratio is preserved.

Picture

PrintVisibility

Sets or returns whether to print an object on the template during a print job.

All

RotationAngle

Sets or returns the rotation angle of an object in degrees from 0 to 359 or 0 to -359.

Barcode, Box, Ellipse, Line, Picture, Rich Text, Text

TextBackgroundColor

Sets or returns an object's text background color. See BtColor for standard color constant values.

Barcode, Text

TextColor

Sets or returns an object's text color. See BtColor for standard color constant values.

Barcode, Text

Type

Returns the object type. Read-only.

All

Value

Returns the value of the object. Read-only.

All

Width

Sets or returns an object's width. For text objects, the width applies only if the text is formatted as a paragraph; otherwise, it is ignored.

Box, Ellipse, Picture, Rich Text, Text

X

Sets or returns an object's X location. Use the Format.MeasurementUnits property to set the units.

All

Y

Sets or returns an object's Y location. Use the Format.MeasurementUnits property to set the units.

All

Related Topics