Export (0) Print
Expand All

PrintSystemObject.Commit Method

When overridden in a derived class, writes any changes that your program has made to the object's properties to the actual software or hardware component that the object represents.

Namespace:  System.Printing
Assembly:  System.Printing (in System.Printing.dll)

Public MustOverride Sub Commit

For example, when overridden by the PrintServer class, Commit will write changes that are made to the PrintServer object's properties to the actual computer that the object represents.

The following example shows how to use this method (called on a PrintQueue object, which overrides the method from PrintSystemObject) as part of the process of merging print tickets.

		''' <summary>
		''' Changes the user-default PrintTicket setting of the specified print queue.
		''' </summary>
		''' <param name="queue">the printer whose user-default PrintTicket setting needs to be changed</param>
		Private Shared Sub ChangePrintTicketSetting(ByVal queue As PrintQueue)
			' Obtain the printer's PrintCapabilities so we can determine whether or not
			' duplexing printing is supported by the printer.
			Dim printcap As PrintCapabilities = queue.GetPrintCapabilities()

			' The printer's duplexing capability is returned as a read-only collection of duplexing options
			' that can be supported by the printer. If the collection returned contains the duplexing
			' option we want to set, it means the duplexing option we want to set is supported by the printer,
			' so we can make the user-default PrintTicket setting change.
			If printcap.DuplexingCapability.Contains(Duplexing.TwoSidedLongEdge) Then
				' To change the user-default PrintTicket, we can first create a delta PrintTicket with
				' the new duplexing setting.
				Dim deltaTicket As New PrintTicket()
				deltaTicket.Duplexing = Duplexing.TwoSidedLongEdge

				' Then merge the delta PrintTicket onto the printer's current user-default PrintTicket,
				' and validate the merged PrintTicket to get the new PrintTicket we want to set as the
				' printer's new user-default PrintTicket.
				Dim result As ValidationResult = queue.MergeAndValidatePrintTicket(queue.UserPrintTicket, deltaTicket)

				' The duplexing option we want to set could be constrained by other PrintTicket settings
				' or device settings. We can check the validated merged PrintTicket to see whether the
				' the validation process has kept the duplexing option we want to set unchanged.
				If result.ValidatedPrintTicket.Duplexing = Duplexing.TwoSidedLongEdge Then
					' Set the printer's user-default PrintTicket and commit the set operation.
					queue.UserPrintTicket = result.ValidatedPrintTicket
					Console.WriteLine("PrintTicket new duplexing setting is set on '{0}'.", queue.FullName)
					' The duplexing option we want to set has been changed by the validation process
					' when it was resolving setting constraints.
					Console.WriteLine("PrintTicket new duplexing setting is constrained on '{0}'.", queue.FullName)
				End If
				' If the printer doesn't support the duplexing option we want to set, skip it.
				Console.WriteLine("PrintTicket new duplexing setting is not supported on '{0}'.", queue.FullName)
			End If
		End Sub

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

© 2014 Microsoft