Table of Contents

Class WindowsPrinter

Namespace
CENTREL.XIA.Configuration.Types
Assembly
CENTREL.XIA.Configuration.Types.dll

Represents a printer connected to a Windows machine.

public class WindowsPrinter : GlobalSerializableClassicBase, IComparable<WindowsPrinter>
Inheritance
WindowsPrinter
Implements

Constructors

WindowsPrinter()

Initializes a new instance of the CENTREL.XIA.Configuration.Types.WindowsPrinter class.

public WindowsPrinter()

Properties

AvailabilityString

Gets the times that the printer is available for use as a human readable string.

public string AvailabilityString { get; set; }

Property Value

string

AvailableFrom

Gets or sets the time at which the printer is available from. A DateTime.MinValue indicates that the printer is always available.

public DateTime AvailableFrom { get; set; }

Property Value

DateTime

AvailableUntil

Gets or sets the time until which the printer is available. A DateTime.MinValue indicates that the printer is always available.

public DateTime AvailableUntil { get; set; }

Property Value

DateTime

CapabilityDescriptions

Gets or sets the capabilities of the printer - for example "Copies", "Color", "Duplex", "Collate".

public SerializableStringCollection CapabilityDescriptions { get; set; }

Property Value

SerializableStringCollection

Caption

Gets or sets the display name of this printer - for example "EPSON Stylus SX200 Series".

public string Caption { get; set; }

Property Value

string

Comment

Gets or sets the comment assigned to this printer. This applies to Windows 2003 and above only.

public string Comment { get; set; }

Property Value

string

DeviceID

Gets or sets the unique ID of the printer.

public string DeviceID { get; set; }

Property Value

string

Direct

Gets or sets whether the machine should print directly to the printer rather than spooling the job. This information is available on Windows XP and above only.

public BooleanOption Direct { get; set; }

Property Value

BooleanOption

DriverName

Gets or sets the name of the driver installed for this printer - for example "EPSON Stylus SX200 Series" or "Microsoft XPS Document Writer".

public string DriverName { get; set; }

Property Value

string

EnableAdvancedFeatures

Gets or sets whether advanced printing features should be enabled. This information is available on Windows XP and above only.

public BooleanOption EnableAdvancedFeatures { get; set; }

Property Value

BooleanOption

HoldMismatchedDocuments

Gets or sets whether the printer should hold documents in the queue when document and printer setups do not match. This information is available on Windows XP and above only.

public BooleanOption HoldMismatchedDocuments { get; set; }

Property Value

BooleanOption

Location

Gets or sets the location of the printer as entered by the user.

public string Location { get; set; }

Property Value

string

PortName

Gets or sets the name of the port to which the printer is connected - for example "XPSPort:" or "USB001".

public string PortName { get; set; }

Property Value

string

PrintProcessor

Gets or sets the name of the print spooler that handles print jobs - for example "Epson Inkjet".

public string PrintProcessor { get; set; }

Property Value

string

Priority

Gets or sets the priority of the printer. Jobs on a higher priority printer are scheduled first. This information is available on Windows XP and above only.

public int Priority { get; set; }

Property Value

int

Queued

Gets or sets whether the machine should buffer the print job rather than starting printing immediately. This information is available on Windows XP and above only.

public BooleanOption Queued { get; set; }

Property Value

BooleanOption

Security

Gets or sets the security assigned to this printer.

public WindowsGenericSecurityDescriptor Security { get; set; }

Property Value

WindowsGenericSecurityDescriptor

SeparatorFile

Gets or sets the absolute path of the file to be used to create a separator page. This page is used to separate print jobs sent to the printer.

public string SeparatorFile { get; set; }

Property Value

string

ShareName

Gets or sets the share name of the printer. This applies whether the printer is shared locally or is a share on a remote machine. If this printer is not shared this returns an empty string.

public string ShareName { get; set; }

Property Value

string

ShareNameString

Gets the share name of the printer, or returns "[Not Shared]" if the printer is not shared.

public string ShareNameString { get; }

Property Value

string

SpoolModeString

Gets the print spool mode as a human readable string. This information is available on Windows XP and above only.

public string SpoolModeString { get; set; }

Property Value

string

Methods

CompareTo(WindowsPrinter)

Compares two CENTREL.XIA.Configuration.Types.WindowsPrinter objects allow sorting alphabetically by printer name.

public int CompareTo(WindowsPrinter other)

Parameters

other WindowsPrinter

The CENTREL.XIA.Configuration.Types.WindowsPrinter to compare to.

Returns

int

The sort order of the two CENTREL.XIA.Configuration.Types.WindowsPrinter objects.

ToString()

Returns the display name of this printer - for example "EPSON Stylus SX200 Series".

public override string ToString()

Returns

string

The display name of this printer.