CIP Visual Basic.NET documentation for interface "IpfcPlotInstructions"

Interface IpfcPlotInstructions

Description

Instructions object used to plot drawings.

This export-instructions class has been superseeded by IpfcPrinterInstructions objects.

See Also:: IpfcPlotInstructions.Create(), IpfcModel.Export()

Direct Parent Classes:: IpfcExportInstructions

Property Summary


`Property`	`FirstPage`	`as Long [optional]`
	When PageRangeChoice is `PlotPageRange.PLOT_RANGE_OF_PAGES`, this specifies the first page to print. Otherwise, the value is `null`

`Property`	`LabelPlot`	`as Boolean`
	If set to `true` , generates the plot with a label. Default is `false`; no label is created.

`Property`	`LastPage`	`as Long [optional]`
	When PageRangeChoice is `PlotPageRange.PLOT_RANGE_OF_PAGES`, this specifies the last page to print. Otherwise, the value is `null`

`Property`	`OutputQuality`	`as Long`
	A value of 0, 1, 2, or 3. Default is 1. Defines the amount of checking for overlapping lines in a plot or 2-D export file, such as IGES, before making a file. The values are interpreted as follows: 0-Does not check for overlapping lines or collect lines of the same pen color. 1-Does not check for overlapping lines, but collects lines of the same pen color for plotting. 2-Partially checks edges with two vertices, and collects lines of the same pen color for plotting. 3-Does a complete check of all edges against each other, regardless of the number of vertices, font, or color. Collects lines of the same pen color for plotting.

`Property`	`PageRangeChoice`	`as IpfcPlotPageRange`
	One of the `IpfcPlotPageRange` enumeration objects. Default is PlotPageRange.PLOT_RANGE_ALL.

`Property`	`PaperSize`	`as IpfcPlotPaperSize`
	One of the `IpfcPlotPaperSize` enumeration objects. Default is PlotPaperSize.ASIZEPLOT.

`Property`	`PaperSizeX`	`as Double [optional]`
	When PaperSize is `PlotPaperSize.VARIABLEPLOTSIZE`, this specifies the size of the plotter paper in the X dimension. Otherwise, the value is `null`

`Property`	`PaperSizeY`	`as Double [optional]`
	When PaperSize is `PlotPaperSize.VARIABLEPLOTSIZE`, this specifies the size of the plotter paper in the Y dimension. Otherwise, the value is `null`.

`Property`	`PenSlew`	`as Boolean`
	Set to `true` if you want to adjust pen velocity. Default is `false`.

`Property`	`PenVelocityX`	`as Double`
	When PenSlew is `true`, this value is a multiple of the default pen speed in the X dimension. Permitted range is 0.1 to 100. Ignored when PenSlew is `false`.

`Property`	`PenVelocityY`	`as Double`
	When PenSlew is `true`, this value is a multiple of the default pen speed in the y dimension. Permitted range is 0.1 to 100. Ignored when PenSlew is `false`.

`Property`	`PlotterName`	`as String`
	c.f. The print dialog for support names eg: POSTSCRIPT, COLORPOSTSC

`Property`	`SegmentedOutput`	`as Boolean`
	Set to `true` to generate a segmented plot. Default is `false`.This may be `true` only if you are plotting a single page.

`Property`	`SeparatePlotFiles`	`as Boolean`
	Defines the default in the Print to File dialog box. `true`-Sets the default to Create Separate Files. `false` -A single file is created by default.

`Property`	`UserScale`	`as Double`
	Specifies a scale factor between 0.01 and 100 for scaling a model or drawing for plotting. Default is 0.01.

Method Summary


`Function`	`CCpfcPlotInstructions.Create (PlotterName as String) as IpfcPlotInstructions`
	Creates a new instructions object used to plot a part, drawing, or assembly.

Property Detail

Property FirstPage as Long [optional]

When PageRangeChoice is PlotPageRange.PLOT_RANGE_OF_PAGES, this specifies the first page to print. Otherwise, the value is null

Property LabelPlot as Boolean

If set to true , generates the plot with a label. Default is false; no label is created.

Property LastPage as Long [optional]

When PageRangeChoice is PlotPageRange.PLOT_RANGE_OF_PAGES, this specifies the last page to print. Otherwise, the value is null

Property OutputQuality as Long

A value of 0, 1, 2, or 3. Default is 1. Defines the amount of checking for overlapping lines in a plot or 2-D export file, such as IGES, before making a file.

The values are interpreted as follows:

0-Does not check for overlapping lines or collect lines of the same pen color.
1-Does not check for overlapping lines, but collects lines of the same pen color for plotting.
2-Partially checks edges with two vertices, and collects lines of the same pen color for plotting.
3-Does a complete check of all edges against each other, regardless of the number of vertices, font, or color. Collects lines of the same pen color for plotting.

Property PageRangeChoice as IpfcPlotPageRange

One of the IpfcPlotPageRange enumeration objects. Default is PlotPageRange.PLOT_RANGE_ALL.

Property PaperSize as IpfcPlotPaperSize

One of the IpfcPlotPaperSize enumeration objects. Default is PlotPaperSize.ASIZEPLOT.

Property PaperSizeX as Double [optional]

When PaperSize is PlotPaperSize.VARIABLEPLOTSIZE, this specifies the size of the plotter paper in the X dimension. Otherwise, the value is null

Property PaperSizeY as Double [optional]

When PaperSize is PlotPaperSize.VARIABLEPLOTSIZE, this specifies the size of the plotter paper in the Y dimension. Otherwise, the value is null.

Property PenSlew as Boolean

Set to true if you want to adjust pen velocity. Default is false.

Property PenVelocityX as Double

When PenSlew is true, this value is a multiple of the default pen speed in the X dimension. Permitted range is 0.1 to 100. Ignored when PenSlew is false.

Property PenVelocityY as Double

When PenSlew is true, this value is a multiple of the default pen speed in the y dimension. Permitted range is 0.1 to 100. Ignored when PenSlew is false.

Property PlotterName as String

c.f. The print dialog for support names eg: POSTSCRIPT, COLORPOSTSC

Note: MS_PRINT_MGR is not supported

Property SegmentedOutput as Boolean

Set to true to generate a segmented plot. Default is false.This may be true only if you are plotting a single page.

Property SeparatePlotFiles as Boolean

Defines the default in the Print to File dialog box.

true-Sets the default to Create Separate Files.
false -A single file is created by default.

Property UserScale as Double

Specifies a scale factor between 0.01 and 100 for scaling a model or drawing for plotting. Default is 0.01.

Method Detail

Function CCpfcPlotInstructions.Create (PlotterName as String) as IpfcPlotInstructions

Creates a new instructions object used to plot a part, drawing, or assembly.

The drawing must be displayed in a window to be successfully plotted. The return value must be passed to IpfcModel.Export() to produce the output file. This export-instructions class has been superseeded by IpfcPrinterInstructions objects.

Parameters:

PlotterName: The name of a printer, typed exactly as it would appear in a user's File > Print dialog.

Returns:: The instructions object