Home » Adobe Manuals » Computer Software » Adobe 38040334 » Manual Viewer

Adobe 38040334 API Reference - Page 395

The value defaults to, argument are the Boolean values

UPC - 883919090467

Add to My Manuals
Save this manual to your list of manuals

Page 395 highlights

DREAMWEAVER CS3 390 API Reference Returns Nothing. Example If the user creates a record set called "myRs", the following code would create a menu for myRS: dw.codeHints.addMenu( "CodeHints_object_methods", "myRS.", new Array("firstName", "lastName"), new Array("firstName", "lastName"), null, "ASP_VB, ASP_JS"); // menu is enabled if object methods are enabled // pop up menu if user types "myRS." // items in drop-down menu for myRS // text to actually insert in document // no icons for this menu // specific to the ASP doc types dreamweaver.codeHints.addFunction() Availability Dreamweaver MX. Description Dynamically defines a new function tag. If there is an existing function tag with the same pattern and document type, this function replaces the existing function tag. Arguments menuGroupId, pattern, {doctypes}, {casesensitive} • The menuGroupId argument is the ID string attribute of a menugroup tag. • The pattern argument is a string that specifies the pattern attribute for the new function tag. • The doctypes argument, which is optional, specifies that this function is active for only certain document types. You can specify the doctypes argument as a comma-separated list of document type IDs. For a list of Dreamweaver document types, see the Dreamweaver Configuration/Documenttypes/MMDocumentTypes.xml file. • The casesensitive argument, which is optional, specifies whether the pattern is case-sensitive. The possible values for the casesensitive argument are the Boolean values true or false. The value defaults to false if you omit this argument. If the casesensitive argument is a true value, the Code Hints menu appears only if the text that the user types exactly matches the pattern that the pattern attribute specifies. If casesensitive is a false value, the menu appears even if the pattern is lowercase and the text is uppercase. Returns Nothing. Example The following example of the dw.codeHints.addFunction() function adds the function name pattern out.newLine() to the Code Hints menu group CodeHints_Object_Methods and makes it active only for JSP document types: dw.codeHints.addFunction( "CodeHints_Object_Methods", "out.newLine()", "JSP")

Section	Page
Contents	3
Chapter 1: Introduction	6
Background	7
Extending Dreamweaver	7
Additional resources for extension writers	7
New functions in Dreamweaver CS3	7
Removed functions	9
Errata	10
Conventions used in this guide	10
Chapter 2: The file I/O API	11
Accessing configuration folders	11
The file I/O API	11
Chapter 3: The HTTP API	20
How the HTTP API works	20
The HTTP API	21
Chapter 4: The Design Notes API	27
How Design Notes work	27
The Design Notes JavaScript API	28
The Design Notes C API	32
Chapter 5: Fireworks integration	39
The FWLaunch API	39
Chapter 6: Flash integration	46
How Flash elements work	46
Inserting Flash elements	46
The Flash Objects API	47
Chapter 7: The database API	51
How database API functions work	51
Database connection functions	52
Database access functions	64
Chapter 8: The database connectivity API	76
How to develop a new connection type	76
The Connection API	78
The generated include file	80
The definition file for your connection type	82
Chapter 9: The JavaBeans API	84
The JavaBeans API	84
Chapter 10: The source control integration API	89
How source control integration with Dreamweaver works	90
Adding source control system functionality	90
The source control integration API required functions	90
The source control integration API optional functions	96
Enablers	104
Chapter 11: Application	109
External application functions	109
Global application functions	117
Bridge communication functions	122
Chapter 12: Workspace	124
History functions	124
Insert object functions	132
Keyboard functions	135
Menu functions	141
Results window functions	143
Toggle functions	154
Toolbar functions	173
Window functions	178
Code collapse functions	188
Code view toolbar functions	194
Chapter 13: Site	198
Report functions	198
Site functions	199
Chapter 14: Document	232
Conversion functions	232
Command functions	233
File manipulation functions	235
Global document functions	249
Path functions	258
Selection functions	260
String manipulation functions	267
Translation functions	270
XSLT functions	272
Chapter 15: Page content	275
Assets panel functions	275
Behavior functions	285
Clipboard functions	293
Library and template functions	298
Snippets panel functions	303
Spry widget editing functions	306
Inserting Spry widgets functions	308
Browser compatibility check functions	311
Chapter 16: Dynamic documents	319
Server components functions	319
Data source functions	320
Extension Data Manager functions	321
Live data functions	324
Server behavior functions	328
Server model functions	330
Chapter 17: Design	337
CSS layout functions	337
Frame and frameset functions	356
Layer and image map functions	358
Layout environment functions	360
Layout view functions	365
Zoom functions	374
Guide functions and properties	377
Table editing functions	384
Chapter 18: Code	393
Code functions	393
Find and replace functions	397
General editing functions	402
Print function	417
Quick Tag Editor functions	418
Code view functions	420
Tag editor and tag library functions	436
Chapter 19: Enablers	440
Enabler functions	440

Match case Limit results 1 per page

DREAMWEAVER CS3

API Reference

390

Returns

Nothing.

Example

If the user creates a record set called "

myRs

", the following code would create a menu for

myRS

dw.codeHints.addMenu(

"CodeHints

object

methods",

// menu is enabled if object methods are enabled

"myRS.",

// pop up menu if user types "myRS."

new Array("firstName", "lastName"),

// items in drop-down menu for myRS

new Array("firstName", "lastName"),

// text to actually insert in document

null,

// no icons for this menu

"ASP

VB, ASP

JS");

// specific to the ASP doc types

dreamweaver.codeHints.addFunction()

Availability

Dreamweaver MX.

Description

Dynamically defines a new

function

tag. If there is an existing

function

tag with the same pattern and document

type, this function replaces the existing

function

tag.

Arguments

menuGroupId, pattern, {doctypes}, {casesensitive}

•

The

menuGroupId

argument is the ID string attribute of a

menugroup

tag.

•

The

pattern

argument is a string that specifies the pattern attribute for the new

function

tag.

•

The

doctypes

argument, which is optional, specifies that this function is active for only certain document types.

You can specify the

doctypes

argument as a comma-separated list of document type IDs. For a list of Dream-

weaver document types, see the Dreamweaver Configuration/Documenttypes/MMDocumentTypes.xml file.

•

The

casesensitive

argument, which is optional, specifies whether the pattern is case-sensitive. The possible

values for the

casesensitive

argument are the Boolean values

true

false

. The value defaults to

false

if you

omit this argument. If the

casesensitive

argument is a

true

value, the Code Hints menu appears only if the text

that the user types exactly matches the pattern that the pattern attribute specifies. If

casesensitive

is a

false

value, the menu appears even if the pattern is lowercase and the text is uppercase.

Returns

Nothing.

Example

The following example of the

dw.codeHints.addFunction()

function adds the function name pattern

out.newLine()

to the Code Hints menu group

CodeHints

Object

Methods

and makes it active only for

JSP

document types:

dw.codeHints.addFunction(

"CodeHints

Object

Methods",

"out.newLine()",

"JSP")