Navigation:  Programmer's Reference > Sending data to DPlot from another application >

TextNote macro command

Print this Topic Previous pageReturn to chapter overviewNext page

Macro commands may be used either in macros or by sending the commands to DPlot via dynamic data exchange (DDE). Some commands are valid only in macros (noted by Macros Only). Commands sent to DPlot via DDE must be enclosed by square brackets [     ]. Macro commands should not include the brackets.

Command parameters shown in the descriptions below are placeholders for the actual values. Command parameters are either numeric values, equations that evaluate to numbers, or character strings. Character string parameters are always bound by double quotation marks. Equations must be preceded by an equals sign (=).

The pipe symbol (|) in the command syntax indicates that a parameter is optional, and should not be included in your macro unless otherwise noted.

All indices into arrays are 1-based, e.g. Curve1=1 refers to the first curve in a plot.

A 0x prefix for numbers in the descriptions below indicates hexadecimal notation; e.g. 0x0010 = 16.

JR/Viewer indicates that the command is supported by DPlot Jr or DPlot Viewer.
JR/Viewer indicates that the command is NOT supported by DPlot Jr or DPlot Viewer.



JR   Viewer

Obsolete (though still supported). Use TextNoteEx.

Adds a notation to the plot. Note is the text of the notation. X,Y are the coordinates of the upper left corner of the note, expressed as a percentage of the plot size (0.0 to 1.0). Frame = 1 to draw a rectangle around the note. Opaque = 1 to hide any objects intersecting the note. Button = 1 if the note is "activated" with a button. TabStops is the number of character cells used for tab positioning. See the Add/Edit Note command for more information.

To break a note into multiple lines, you may either embed carriage return-line feed sequences into the note text, or include the literal sequence "\n". The latter method is the only way to include line breaks in a note produced by a macro. Examples:


Control.LinkExecute "[TextNote(""Line 1" & chr$(13) & chr$(10) & "Line 2"",0.1,0.1,1,1,0,8)]"

In C/C++, using DPLOTLIB:

"[TextNote(\"Line 1\r\nLine 2\",0.1,0.1,1,1,0,8)]");

In Fortran, using DPLOTLIB:

'[TextNote("Line 1\nLine 2",0.1,0.1,1,1,0,8)]'//char(0))

In a macro:

[TextNote("Line 1\nLine 2",0.1,0.1,1,1,0,8)]


Please note:

Character string arguments require a bit of care, depending on your development environment. Character string arguments in all DPlot commands are always enclosed by double quotation marks. In some environments (Visual Basic and all flavors of C, for example), double quotation marks are also used to delineate all character strings (including the command itself). The following example will always cause a syntax error in Visual Basic:

ret = DPlot_Command(docnum,"[FileOpen("myfile.grf")]")

Instead, use:

ret = DPlot_Command(docnum,"[FileOpen(""myfile.grf"")]")

in C, C++, C# you'd accomplish the same thing with:

ret = DPlot_Command(docnum,"[FileOpen(\"myfile.grf\")]");

If a character string argument is a variable, as in (VB):

Dim arg as string
arg = "myfile.grf"

... then you can build the command in VB as:

ret = DPlot_Command(docnum,"[FileOpen(" & chr$(34) & arg & chr$(34) & ")]")

In all flavors of C, the same can be accomplished with

char arg[256];
char cmd[512];
ret = DPlot_Command(docnum,cmd);

This does not apply to the DPlot macro editor, in which each line is by definition a character string and does not require delineators, nor to FORTRAN and possibly other languages, in which the delineator for character strings is a single quote, e.g. '[FileOpen("...")]'

To embed a double quotation mark within a character string which is itself delineated by double quotation marks, use the Symbol font equivalent instead. For example, "Radius=6{\s²}" inches will be processed as





See also

Add/Edit Note menu command

DeleteNote macro command


Page url: