Visit Gigasoft's Web Site
 ProEssentials v9 Help

GraphAnnotationText

Scope

Pego, Pesgo, Pe3do, Pepso

Type

Property Array of type String

Default

empty

.NET

PeAnnotation.Graph.Text

Ocx|Vcl

GraphAnnotationText

DLL

PEP_szaGRAPHANNOTATIONTEXT

 

Purpose

This property contains the text for the graph annotations which are located by the GraphAnnotationX and GraphAnnotationY properties.

 

The following two-character prefix codes can be used to control placement of the text. If no prefix is supplied, the graph annotation text will be dynamically positioned around the graph annotation location to prevent overlapping text. Note the pipe delimiter can be redefined with the Delimiter property.

 

Prefix

Description

|c

Center bottom justified text

|l

Left bottom justified text

|r

Right bottom justified text

|C

Center top justified text

|L

Left top justified text

|R

Right top justified text

|e

Top, vertical, and centered text

|E

Bottom, vertical text, centered

|m

Bottom, vertical text, right-side

|M

Top, vertical text, left-side

|s

Bottom, vertical text, left-side

|S

Top, vertical text, right-side

|d

Centered on left side with vertical text

|D

Centered on right side with vertical text

|f

Left justified, horizontal text centered vertically

|g

Right justified, horizontal text centered vertically

|H

Special code to be used with GraphAnnotationType.Pointer (see below and example 031 in the demo)

|V

Similar to |H above, but vertically orients text

 

Example Strings

"|cCentered String Example"

"|lLeft justified text"

 

Using the |H justification code with Pointer annotation types.

 

'// Manually places text at separate coordinates than annotation.    //

'// Pointer points to (20,90) but text is located at (33,120)        //

'// Note that coordinates are split and terminated with pipe symbol. //

Pego1.PeAnnotation.Graph.X(nCount) = 20

Pego1.PeAnnotation.Graph.Y(nCount) = 90

Pego1.PeAnnotation.Graph.Text(nCount) = "|H33.0|120.0|Moveable"

Pego1.PeAnnotation.Graph.Type(nCount) = GraphAnnotationType.Pointer

 

Comments

PeAnnotation.Graph.Text members of Pego.PeAnnotation.Graph, Pesgo.PeAnnotation.Graph, Pe3do.PeAnnotation.Graph, Pepso.PeAnnotation.Graph

 

Graph annotations are implemented with the following other properties. GraphAnnotationX, GraphAnnotationY, GraphAnnotationType, GraphAnnotationColor, GraphAnnotationAxis ,and HideIntersectingText.

 

Within the demo, see example 015 and 031.

 

See GraphAnnotationType which includes example code.

 

Refer to Chapter 7, Question 10 for more information on annotations.

 

When used with PEvget, the destination buffer must be large enough to hold all of the tab delimited string information. For property arrays, calling PEvget with lpDest equal to NULL will return the number of bytes needed to hold the data.