diagGroup (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / Diagram Editor functions / Types of variables

Properties specific to diagGroup variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Diagram functions

diagGroup (Type of variable)

In french: diagGroupe

Inherits from diagShape (Type of variable)

The diagGroup type is used to define all the advanced characteristics of a group of shapes in a Diagram Editor control. The characteristics of this group can be defined and changed using different WLanguage properties.

Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

//Info(DIAGEDT_MyDiagram.Size)

MyShape1 is diagRectangle
MyShape1.X = 100
MyShape1.Y = 100
MyShape1.Width = 50
MyShape1.Height = 50
MyShape1.Background.Color = PastelRed

MyShape2 is diagOval
MyShape2.X = 250
MyShape2.Y = 100
MyShape2.Width = 50
MyShape2.Height = 50
MyShape2.Background.Color = PastelRed

// Reference the displayed diagram
MyDiagram is Diagram <- DIAGEDT_DIAGRAM

MyGroup is diagGroup
MyGroup.Shape.Add(MyShape1)
MyGroup.Shape.Add(MyShape2)

Add(MyDiagram.Shape, MyGroup)

Properties

Properties specific to diagGroup variables

Remark: The diagGroup type inherits from the diagShape type. This means all the properties of the diagShape type are available for the diagGroup type. These properties appear in italics in the list below.

The following properties can be used to handle a shape of type diagGroup:

Property name	Type used	Effect

ActionAllowed	diagActionAllowed or constant	diagActionAllowed variable used to define the changes the user can make to the shape. diagActionNone constant: no action available. diagActionAll constant (Default value): all actions are available.
Angle	Real	Angle of rotation of the shape (in degrees).
Background	Constant, integer or Color	Background color of the shape. The Color property is used to define the background color of the shape. This property can correspond to: an RGB color (returned by RGB), an HSL color (returned by HSL), a WLanguage preset color. a variable of type Color. In this case, the opacity specified in the variable is taken into account.
Border	diagBorder	Characteristics of the shape border. The available properties are: Color: border color. Thickness: border thickness. Type: border type.
Comment	Character string	Note about the shape. This note is not displayed.
ConnectionPoint	Array of diagConnectionPoint	List of connection points of the shape.
Height	Real	Height of the box that contains the shape before rotation or zoom, expressed in pixels.
Name	Character string	Shape name. This name will be used for searching, for example, if the shape is in a library.
Note	Character string	Note associated with the shape.
Opacity	Integer	Percentage of opacity of the shape. This value ranges from invisible (0) to completely opaque (100).
Shadow	Boolean	True if the shape has a shadow, False otherwise.
Shape	Array of diagShape	Shapes in the group.
Text	diagText	Text (with formatting) inside the shape.
Width	Real	Width of the box that contains the shape before rotation or zoom, expressed in pixels.
X	Real	X-coordinate of the box that contains the shape before rotation or zoom, expressed in pixels. This X-coordinate is relative to the parent of the shape.
Y	Real	Y-coordinate of the box that contains the shape before rotation or zoom, expressed in pixels. This Y-coordinate is relative to the parent of the shape.