Cadcorp SIS API Methods

Publish Method

Description

Publishes data.

Syntax

Visual Basic
Public Function Export( _
   ByVal clsPublish As String, _
   ByVal filename As String, _
   ByVal parameters As String _
) As Integer

Parameters

clsPublish

The Publisher class to use. The supported classes are EPS, SVG and XPS.

filename

The full file path and name of where the published file is to be located.

parameters

The parameters depend on the selected publish type, as follows:

SvgPublisher, SvgPublisherTiny, SvgPublisherZipped, SvgPublisherZippedTiny

Mime type

image/svg+wml

parameters

General parameters

pagesize, string

A0
A1
A2
A3
A4
A5
A6
ANSI_A
ANSI_B
ANSI_C
ANSI_D
ANSI_E
ANSI_F
B5
Ledger
Legal
Letter
Custom

unit, string

point
mm
cm
inch

width, double

height, double

pageorientation, string

Portrait
Landscape

Gradient fill Mode parameter:

gradienttrianglerendermethod, string

Subdivide
Linear
Radiate

Options parameters:

uri, boolean

Export Hyperlinks for items with populated URI attribute, true=1 false=0

sisdata, boolean

Export SIS schema layer and item attributes, true=1 false=0

textaspolygon, boolean

Text as polygon, true=1 false=0

outlinedtextaspolygon, boolean

outlined text as polygon, true=1 false=0

Output parameters:

pageresolution, string

default 600 dpi

pageoutputcolor, string

Monochrome (or Mono)
Color

referenceDC, string

Screen
Printer (for current printer)
Auto (for auto selected printer)

minimumlinethicknessmm, double

default 1.0

XPSPublisher

Mime type

application/vnd.ms-xpsdocument

parameters

General parameters

pagesize, string

A0
A1
A2
A3
A4
A5
A6
ANSI_A
ANSI_B
ANSI_C
ANSI_D
ANSI_E
ANSI_F
B5
Ledger
Legal
Letter
Custom

unit, string

point
mm
cm
inch

width, double

height, double

pageorientation, string

Portrait
Landscape

Package Information parameters:

title, string
subject, string
author, string
keywords, string
description, string

Options parameters:

uri, boolean,

Export Hyperlinks for items with populated URI attribute, true=1 false=0

sisdata, boolean,

Export SIS schema layer and item attributes, true=1 false=0

textaspolygon, boolean,

Text as polygon, true=1 false=0

outlinedtextaspolygon, boolean,

Outlined text as polygon, true=1 false=0

Gradient fill Mode parameter:

gradienttrianglerendermethod, string,

Subdivided
Linear

Output parameters:

jobcopies, integer

Number of job copies (default=1)

pageresolution, string,

default 600 dpi

pageoutputcolor, string

Monochrome (or Mono)
Color

referenceDC, string

Screen
Printer (for current printer)
Auto (for auto selected printer)

minimumlinethicknessmm, double,

default 1.0

Security parameters:

digitalsignature, boolean

Sign the package, true=1 false=0

encryptrights, string

Rights file name if Encrypted/Right-managed

preproduction, boolean

Pre-production, true=1 false=0

EPSPublisher

Mime type

application/x-postscript

parameters

General parameters

pagesize, string

A0
A1
A2
A3
A4
A5
A6
ANSI_A
ANSI_B
ANSI_C
ANSI_D
ANSI_E
ANSI_F
B5
Ledger
Legal
Letter
Custom

unit, string

point
mm
cm
inch

width, double

height, double

pageorientation, string

Portrait
Landscape

Document Properties parameters

title, string
subject, string
author, string
keywords, string
description, string

Output parameters:

pageresolution, string,

default 600 dpi

pageoutputcolor, string

Monochrome (or Mono)
Color

referenceDC, string

Screen
Printer (for current printer)
Auto (for auto selected printer)

minimumlinethicknessmm, double,

default 1.0

Options parameters:

languagelevel, integer

1
2
3

colormode, string,

RGB
CMYK

imageencoding, string

Ascii85
Hexadecimal (or Hex)

simulatetransparency, boolean

Simulate transparent color blending, true=1 false=0

embedjapanesefont, boolean

Embed Japanese Font, true=1 false=0

Examples

Example 1 - Publish as an SVG:

sis.Publish("SvgPublisher","C:\filename.svg","pagesize=A4, pageorientation=portrait")

Example 2 - Publish as an EPS:

sis.Publish("EPSPublisher","C:\filename.eps","pagesize=A4, pageorientation=portrait")

Example 3 - Publish as an XPS:

sis.Publish("XPSPublisher","C:\filename.xps","pagesize=A4, pageorientation=portrait")

Remarks

Available: GEO MM ME MD OD OM SISpy

Groups:


Send comments on this topic.

Click to return to www.cadcorp.com

© Copyright 2000-2017 Computer Aided Development Corporation Limited (Cadcorp).