Macro Language Reference > Macros > Tag > ttaginfo
  
ttaginfo
Description
Allows you to view information about tags, e.g. the number of characters in a text stream or the dimensions of a graphic. The ttaginfo macro retrieves the tag information and passes it to variables for the user to access.
 
Example 277. Display the number of characters used in the tag "body"
This will display the number of characters used in the tag body. ttaginfo_tx_nc is the set variable for the number of characters.
ttaginfo "body"
boxit ^ttaginfo_tx_nc^
Syntax
ttaginfo tagname:s
tagname
The name of the tag whose contents are to be shown to a variable
Additional Information
Set variables and getvars that can receive particular types of information are detailed below.
Text Streams
Variable Name
Type
Meaning
ttaginfo_tx_nc
number
number of characters
ttaginfo_tx_ue
boolean
undo enabled
ttaginfo_tx_be
boolean
blacklining enabled
ttaginfo_tx_tge
boolean
text greeking enabled
ttaginfo_tx_at
boolean
article threading enabled
ttaginfo_tx_fs
boolean
stream frozen at start
ttaginfo_tx_fe
boolean
stream frozen at end
ttaginfo_tx_cs
boolean
stream cut at start
ttaginfo_tx_ce
boolean
stream cut at end
ttaginfo_tx_iret
boolean
on formatting ignore return
ttaginfo_tx_imsp
boolean
on formatting ignore multiple spaces
ttaginfo_tx_issp
boolean
on formatting ignore start spaces
ttaginfo_tx_iesp
boolean
on formatting ignore end spaces
ttaginfo_tx_isp
boolean
on formatting ignore all spaces
Object Graphics
Variable Name
Type
Meaning
ttaginfo_og_width
number
width of graphic
ttaginfo_og_height
number
height of graphic
ttaginfo_og_top
number
bounding box dimensions
ttaginfo_og_bottom
number
bounding box dimensions
ttaginfo_og_left
number
bounding box dimensions
ttaginfo_og_right
number
bounding box dimensions
Raster graphics
Variable Name
Type
Meaning
ttaginfo_rg_type
number
graphic type- see below
ttaginfo_rg_ftype
number
file type- see below
ttaginfo_rg_bpp
number
bits per pixel
ttaginfo_rg_width
number
width
ttaginfo_rg_height
number
height
ttaginfo_rg_pixelw
number
width in pixels
ttaginfo_rg_pixelh
number
height in pixels
ttaginfo_rg_fname
string
filename and path
ttaginfo_rg_eps
number
size of EPS
ttaginfo_rg_eps_res
number
size of EPS resource
ttaginfo_rg_pict
string
name of picture object
ttaginfo_rg_mirror
boolean
mirrored
ttaginfo_rg_flop
boolean
flopped
ttaginfo_rg_rotation
boolean
0, 90, 180, 270
ttaginfo_rg_cp
boolean
clipping path
ttaginfo_rg_cm
boolean
clipping mask
ttaginfo_rg_lrw
number
low resolution width
ttaginfo_rg_lrh
number
low resolution height
ttaginfo_rg_comment
number
comment
Values for graphic type
Code
Meaning
100
bitmap
101
monochrome
102
RGB
103
Mac PICT
104
Palette
105
CMYK
106
OLE
Values for raster graphic file type
Code
Meaning
0
unknown
1
GEM
2
TIFF
3
PCX
4
Mac PICT
5
GIF
6
EPS
7
Windows BMP
8
JPEG
9
OLE
10
PNG
Page
Variable Name
Type
Meaning
ttaginfo_po_width
number
page width
ttaginfo_po_height
number
page height
ttaginfo_po_nf
number
number of frames
Color
Variable Name
Type
Meaning
ttaginfo_cl_col
string
color description
ttaginfo_cl_ps
string
PostScript name
Font
Variable Name
Type
Meaning
ttaginfo_fn_lname
string
long name
ttaginfo_fn_sname
string
short name
ttaginfo_fn_oname
string
old short name
ttaginfo_fn_cpy
number
copyright
ttaginfo_fn_sz
number
size
ttaginfo_fn_lic
boolean
licensed
ttaginfo_fn_ro
boolean
read-only
ttaginfo_fn_wf
boolean
whole font embedded
ttaginfo_fn_pf
boolean
partial font embedded
Bookmark
Variable Name
Type
Meaning
ttaginfo_mk_type
number
type- see below
ttaginfo_mk_tp
number
target page
ttaginfo_mk_td
number
target document
ttaginfo_mk_tt
number
target tag
ttaginfo_mk_top
number
top
ttaginfo_mk_bottom
number
bottom
ttaginfo_mk_left
number
left
ttaginfo_mk_right
number
right
ttaginfo_mk_acro
boolean
Outline in Acrobat
ttaginfo_mk_fit
number
fit- see below
ttaginfo_mk_desc
string
description
ttaginfo_mk_pg
number
Page for outline
Values for Bookmark Type
Code
Meaning
0,1
internal
2,3
external
4
URI
Values for Bookmark Fit
Code
Meaning
0
all
1
width-top
2
width-centre
3
width-bottom
4
height-left
5
height-centre
6
height-right
7
none
Namespaces
Variable Name
Type
Meaning
ttaginfo_ns_ct
number
number of child tags
 
Boolean values are 1(yes) or 0 (no). Number fields are unformatted numeric values. Strings are text, for example: c:\download\picture.bmp