Keyboard functions | Developing Extensions for Macromedia Dreamweaver 8

< Day Day Up >

Keyboard functions mimic document navigation tasks that are accomplished by pressing the arrow, Backspace, Delete, Page Up, and Page Down keys. In addition to such general arrow and key functions as arrowLeft() and backspaceKey(), Dreamweaver also provides methods for moving to the next or previous word or paragraph as well as moving to the start of the line or document or the end of the line or document.

dom.arrowDown()

Availability

Dreamweaver 3.

Description

Moves the insertion point down the specified number of times.

Arguments

 {nTimes}, {bShiftIsDown}

The nTimes argument is the number of times that the insertion point must move down. If this argument is omitted, the default is 1.
The bShiftIsDown argument is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false.

Returns

Nothing.

dom.arrowLeft()

Availability

Dreamweaver 3.

Description

Moves the insertion point to the left the specified number of times.

Arguments

 {nTimes}, {bShiftIsDown}

The nTimes argument, which is optional, is the number of times that the insertion point must move left. If this argument is omitted, the default is 1.
The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false.

Returns

Nothing.

dom.arrowRight()

Availability

Dreamweaver 3.

Description

Moves the insertion point to the right the specified number of times.

Arguments

 {nTimes}, {bShiftIsDown}

The nTimes argument, which is optional, is the number of times that the insertion point must move right. If this argument is omitted, the default is 1.
The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false.

Returns

Nothing.

dom.arrowUp()

Availability

Dreamweaver 3.

Description

This function moves the insertion point up the specified number of times.

Arguments

 {nTimes}, {bShiftIsDown}

The nTimes argument, which is optional, is the number of times that the insertion point must move up. If this argument is omitted, the default is 1.
The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false.

Returns

Nothing.

dom.backspaceKey()

Availability

Dreamweaver 3.

Description

This function is equivalent to pressing the Backspace key a specified number of times. The exact behavior depends on whether there is a current selection or only an insertion point.

Arguments

 {nTimes}

The nTimes argument, which is optional, is the number of times that a Backspace operation must occur. If the argument is omitted, the default is 1.

Returns

Nothing.

dom.deleteKey()

Availability

Dreamweaver 3.

Description

This function is equivalent to pressing the Delete key the specified number of times. The exact behavior depends on whether there is a current selection or only an insertion point.

Arguments

 {nTimes}

The nTimes argument, which is optional, is the number of times that a Delete operation must occur. If the argument is omitted, the default is 1.

Returns

Nothing.

dom.endOfDocument()

Availability

Dreamweaver 3.

Description

Moves the insertion point to the end of the document (that is, after the last visible content in the Document window or after the closing HTML tag in the Code inspector, depending on which window has focus).

Arguments

 {bShiftIsDown}

The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If the argument is omitted, the default is false.

Returns

Nothing.

dom.endOfLine()

Availability

Dreamweaver 3.

Description

Moves the insertion point to the end of the line.

Arguments

 {bShiftIsDown}

The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If the argument is omitted, the default is false.

Returns

Nothing.

dom.nextParagraph()

Availability

Dreamweaver 3.

Description

Moves the insertion point to the beginning of the next paragraph or skips multiple paragraphs if nTimes is greater than 1.

Arguments

 {nTimes}, {bShiftIsDown}

The nTimes argument, which is optional, is the number of paragraphs that the insertion point must move ahead. If this argument is omitted, the default is 1.
The bShiftIsDown argument is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false.

Returns

Nothing.

dom.nextWord()

Availability

Dreamweaver 3.

Description

Moves the insertion point to the beginning of the next word or skips multiple words if nTimes is greater than 1.

Arguments

 {nTimes}, {bShiftIsDown}

The nTimes argument, which is optional, is the number of words that the insertion point must move ahead. If this argument is omitted, the default is 1.
The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false.

Returns

Nothing.

dom.pageDown()

Availability

Dreamweaver 3.

Description

Moves the insertion point down one page (equivalent to pressing the Page Down key).

Arguments

 {nTimes}, {bShiftIsDown}

The nTimes argument, which is optional, is the number of pages that the insertion point must move down. If this argument is omitted, the default is 1.
The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false.

Returns

Nothing.

dom.pageUp()

Availability

Dreamweaver 3.

Description

Moves the insertion point up one page (equivalent to pressing the Page Up key).

Arguments

 {nTimes}, {bShiftIsDown}

The nTimes argument, which is optional, is the number of pages that the insertion point must move up. If this argument is omitted, the default is 1.
The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false.

Returns

Nothing.

dom.previousParagraph()

Availability

Dreamweaver 3.

Description

Moves the insertion point to the beginning of the previous paragraph or skips multiple paragraphs if nTimes is greater than 1.

Arguments

 {nTimes}, {bShiftIsDown}

The nTimes argument, which is optional, is the number of paragraphs that the insertion point must move back. If this argument is omitted, the default is 1.
The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false.

Returns

Nothing.

dom.previousWord()

Availability

Dreamweaver 3.

Description

Moves the insertion point to the beginning of the previous word or skips multiple words if nTimes is greater than 1.

Arguments

 {nTimes}, {bShiftIsDown}

The nTimes argument, which is optional, is the number of words that the insertion point must move back. If this argument is omitted, the default is 1.
The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If this argument is omitted, the default is false.

Returns

Nothing.

dom.startOfDocument()

Availability

Dreamweaver 3.

Description

Moves the insertion point to the beginning of the document (that is, before the first visible content in the Document window, or before the opening HTML tag in the Code inspector, depending on which window has focus).

Arguments

 {bShiftIsDown}

The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If the argument is omitted, the default is false.

Returns

Nothing.

dom.startOfLine()

Availability

Dreamweaver 3.

Description

Moves the insertion point to the beginning of the line.

Arguments

 {bShiftIsDown}

The bShiftIsDown argument, which is optional, is a Boolean value that indicates whether to extend the selection. If the argument is omitted, the default is false.

Returns

Nothing.

dreamweaver.mapKeyCodeToChar()

Availability

Dreamweaver 4.

Description

Takes a key code as retrieved from the event object's keyCode field and translates it to a character. You should check whether the key code is a special key, such as HOME, PGUP, and so on. If the key code is not a special key, this method can be used to translate it to a character code that is suitable for display to the user.

Arguments

 keyCode

The keyCode argument is the key code to translate to a character.

Returns

Nothing.

< Day Day Up >