Gradient.property

Description

Settings that control the gradient display in a DataWindow object. Gradient display properties are not supported in RichText, Graph, or OLE DataWindow presentation styles.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.datawindow.gradient.property

Describe and Modify argument:

"DataWindow.gradient.property { = value }"

Parameter

Description

property

A property for the gradient. Properties and their settings are listed in the table that follows.

value

The value to be assigned to the property. For gradient properties, value can be a quoted DataWindow expression.


 

Property for Gradient

Value

Angle

An integer indicating the angle in degrees (values are 0 to 360) used to offset the color and transparency gradient. This property is used only when datawindow.brushmode takes values of 3 or 4.

Painter: Background tab, Gradient group.

Color

The gradient color of the DataWindow. This property is only in effect when datawindow.brushmode takes values 1 through 5.

Painter: Background tab, Gradient group

Focus

An integer in the range 0 to 100, specifying the distance (as a percentage) from the center where the background color is at its maximum. (For example, if the radial gradient is used and the value is set to 0, the color will be at the center of the background; if the value is set to 100, the color will be at the edges of the background.)

Painter: Background tab, Gradient group

Repetition.Mode

Specifies the mode for determining the number of gradient transitions.

Permitted values and their meanings are:

  • 0

    Gradient.repetition.count determines the number of gradient transitions

  • 1

    Gradient.repetition.length determines the number of gradient transitions

Painter: Background tab, Gradient group.

Repetition.Count

An integer specifying the number of gradient transitions for background color and transparency. A value of 0 indicates 1 transition. A value of 3 indicates 4 transitions. This property is used only when the datawindow.brushmode property takes values from 1 to 4 and when the when the datawindow.gradient.repetition.mode value is 0 (by count). The maximum is 10,000.

Painter: Background tab, Gradient group.

Repetition.Length

A long specifying the number of gradient transitions. This property is used only when the datawindow.brushmode property takes values from 1 to 4 and the datawindow.gradient.repetition.mode property takes the value of 1 (by length). The units for the length that you assign for gradient transitions are set by the datawindow.units property.

Painter: Background tab, Gradient group.

Scale

An integer in the range 0 to 100 specifying the rate of transition to the gradient color (as a percentage).

Painter: Background tab, Gradient group

Spread

An integer in the range 0 to 100 indicating the contribution of the second color to the blend (as a percentage).

Painter: Background tab, Gradient group

Tranparency

An integer in the range 0 to 100, where 0 means that the secondary (gradient) background is opaque and 100 that it is completely transparent. The gradient defines transitions between the primary and secondary transparency settings.

Painter: Background tab, Gradient group


Usage

In the painter

Select the DataWindow object and set the value on the Background tab of the Properties view.

If you save to an EMF or WMF, the properties on the Background tab are not saved with the DataWindow.

Examples

string ls_data
ls_data = dw_1.Object.datawindow.brushmode
dw_1.Object.datawindow.Brushmode = 5
ls_data = dw_1.Describe("datawindow.brushmode")
dw_1.Modify("datawindow.Brushmode=6")
dw_1.Modify("datawindow.Gradient.Transparency=75")

See also

Brushmode

Picture.property