FillFormat Object

The FillFormat object contains the properties for any object that may be filled, such as an ellipse, rectangle, legend backgrounds, etc.

The following table provides all properties of the FillFormat object.

Property

Description

Application

Returns the application object. It is a read only property.

BackColor

Returns/sets the background color as an RGB value. The BackColor property is superseded by BackColorRGBA property. BackColor has been preserved for backwards compatibility.

BackColorRGBA

Returns the background RGBA color object. Unlike BackColor it is a read only property.

Coverage

Returns/sets the pattern fill coverage mode.

ForeColor

Returns/sets the foreground color as an RGB value. The ForeColor property is superseded by ForeColorRGBA property. ForeColor has been preserved for backwards compatibility.

ForeColorRGBA

Returns the foreground RGBA color object. Unlike ForeColor, it is a read only property.

Parent

Returns the parent object. It is a read only property.

Pattern

Returns/sets the fill pattern.

Transparent

Returns/sets the background transparency mode.

XPatternOffset

Returns/sets the X-axis pattern offset.

XPatternScale

Returns/sets the X-axis pattern scale.

YPatternOffset

Returns/sets the Y-axis pattern offset

YPatternScale

Returns/sets the Y-axis pattern scale.

The following table provides the methods of the FillFormat object:

Method

Description

LoadPattern

Loads a fill pattern file.

Example

The following script demonstrates how the FillFormat object is used in reference to the Ellipse object.

Sub Main

 

'Declares SurferApp as an object

Dim SurferApp As Object

 

'Creates an instance of the Surfer Application object and assigns it

'to the variable named "SurferApp"

Set SurferApp = CreateObject("Surfer.Application")

 

'Makes Surfer visible

SurferApp.Visible = True

 

'Declares Plot as an object

Dim Plot As Object

 

'Creates a plot document in Surfer and assigns it to the variable

'named "Plot"

Set Plot = SurferApp.Documents.Add(srfDocPlot)

 

'Declares Shapes as an object

Dim Shapes As Object

 

'Assigns the Shapes collection to the variable named "Shapes

Set Shapes = Plot.Shapes

 

'Declares Ellipse as an object

Dim Ellipse As Object

 

'Creates an ellipse and assigns it to the variable named "Ellipse"

Set Ellipse = Shapes.AddEllipse(5,7,6,10)

 

'Declares FillFormat as an object

Dim FillFormat As Object

 

'Assigns the fill properties of the ellipse to the variable named

'"FillFormat"

Set FillFormat = Ellipse.Fill

 

End Sub