GenericSPGenerateAllOverlayImages Method |
Gets images which represent each overlay and feature code - that is, drawn in the appropriate pen,
brush and shape - and saves them as files to a given folder, if necessary.
Namespace:
Cadcorp.GFB.CadcorpSP
Assembly:
Cadcorp.GFB.GenericStoredProcedures (in Cadcorp.GFB.GenericStoredProcedures.dll) Version: 9.0.2618.0 (9.0.2618.0)
Syntaxpublic void GenerateAllOverlayImages(
OverlayStyle[] styles,
int width,
int height,
string imgFormat,
string path,
bool force
)
Public Sub GenerateAllOverlayImages (
styles As OverlayStyle(),
width As Integer,
height As Integer,
imgFormat As String,
path As String,
force As Boolean
)
Parameters
- styles
- Type: CadcorpOverlayStyle
The styles to create images for (produced by GetOverlayStyles()) - width
- Type: SystemInt32
The width of the required image. - height
- Type: SystemInt32
The height of the required image. - imgFormat
- Type: SystemString
The format of the required image. For valid values, see
Render() - path
- Type: SystemString
The path to write the files to. - force
- Type: SystemBoolean
If true, always generate images. If false, only generate if the relevant file
does not exist.
Remarks
The file for each image is (shape)(brush)_(pen).(format), with any illegal characters deleted.
It is assumed that the GeognoSIS user account has write permission on the given path.
See Also