Formatting Object Model Reference > Application > System Objects > fInsertMarkupItem interface
  
fInsertMarkupItem interface
This item represents an Insert Markup Item, specifying
MarkupTypes enumeration
The different types of insert markup items.
The MarkupTypes enumeration has the following constants of type DOMString.
TYPE_NONE = "none"
No dialog will be created.
TYPE_TAG = "tag"
A valid tag name. The default dialog will list text and XML streams. The values property can contain the letter codes for the list of valid tag types.
TYPE_COLOR = "colour"
A valid color. The default dialog will show the color picker. The values property will be ignored.
TYPE_FONT = "font"
A valid font. The default dialog will show the font picker. The values property will be ignored.
TYPE_LENGTH = "length"
A valid length. The default dialog will show a list of possible lengths. The values property can contain a comma-separated list of lengths.
TYPE_STRING = "string"
An arbitrary string. The values property will be ignored.
TYPE_PATH = "path"
A valid filename with path. The default dialog will show the file picker. The values property will be ignored.
TYPE_BOOLEAN = "boolean"
Either "on" or "off. The values property will be ignored.
TYPE_NUMBER = "number"
A number. The values property will be ignored.
TYPE_NAME = "name"
A valid name. The values property will be ignored.
TYPE_LIST = "list"
A list of strings. The values property can contain a comma-separated list of items.
default attribute
The default item to show in the dialog.
default
Access
read-write
Returns
String
function attribute
The JS function to run. This function will be called before any text in markupStart or markupEnd is processed. The first argument will be the provided value. The second argument will be the fInsertMarkupItem object that was used.
function
Access
read-write
Returns
Object
markupEnd attribute
The text to write into the current cursor position or end of selection. If the text contains '$1', this will be replaced by the provided value. To output a '$' into the markup, this must be represented as '$$'.
markupEnd
Access
read-write
Returns
String
markupStart attribute
The text to write into the current cursor position or start of selection. If the text contains '$1', this will be replaced by the provided value. To output a '$' into the markup, this must be represented as '$$'.
markupStart
Access
read-write
Returns
String
title attribute
The title for the dialog.
title
Access
read-write
Returns
String
type attribute
The type of item. Possible values are in fInsertMarkupItem-MarkupTypes.
type
Access
read-write
Returns
String
values attribute
A list of possible values to show in the dialog, if valid for the type of item.
values
Access
read-write
Returns
String
verify attribute
An optional dialogue box verification string, not including the "V(...)" wrapper.
verify
Access
read-write
Returns
String
fInsertMarkupItem method
Create a new fInsertMarkupItem.
fInsertMarkupItem
Parameters
None
Returns
fInsertMarkupItem. The newly created insert markup item object.