IPDEPlugInCallbackProtocol Interface

Definition

Namespace:: PrintCore

Assembly:: Microsoft.macOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Callback protocol implemented by the print system that allows printing dialog extensions to obtain information about the current printer and print job, including session, settings, page format, printer, and PPD data.

[Foundation.Protocol(BackwardsCompatibleCodeGeneration=false, Name="PDEPlugInCallbackProtocol", WrapperType=typeof(PrintCore.PDEPlugInCallbackProtocolWrapper))]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetPrintSession", ReturnType=typeof(PrintCore.PMPrintSession), Selector="printSession")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetPrintSettings", ReturnType=typeof(PrintCore.PMPrintSettings), Selector="printSettings")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetPageFormat", ReturnType=typeof(PrintCore.PMPageFormat), Selector="pageFormat")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetPrinter", ReturnType=typeof(PrintCore.PMPrinter), Selector="PMPrinter")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetPpdFile", ReturnType=typeof(System.IntPtr), Selector="ppdFile")]
[Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="WillChangePpdOptionKeyValue", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(System.String), typeof(System.String) }, ReturnType=typeof(System.Boolean), Selector="willChangePPDOptionKeyValue:ppdChoice:")]
public interface IPDEPlugInCallbackProtocol : IDisposable, ObjCRuntime.INativeObject

[<Foundation.Protocol(BackwardsCompatibleCodeGeneration=false, Name="PDEPlugInCallbackProtocol", WrapperType=typeof(PrintCore.PDEPlugInCallbackProtocolWrapper))>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetPrintSession", ReturnType=typeof(PrintCore.PMPrintSession), Selector="printSession")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetPrintSettings", ReturnType=typeof(PrintCore.PMPrintSettings), Selector="printSettings")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetPageFormat", ReturnType=typeof(PrintCore.PMPageFormat), Selector="pageFormat")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetPrinter", ReturnType=typeof(PrintCore.PMPrinter), Selector="PMPrinter")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="GetPpdFile", ReturnType=typeof(System.IntPtr), Selector="ppdFile")>]
[<Foundation.ProtocolMember(IsProperty=false, IsRequired=true, IsStatic=false, Name="WillChangePpdOptionKeyValue", ParameterByRef=new System.Boolean[] { false, false }, ParameterType=new System.Type[] { typeof(System.String), typeof(System.String) }, ReturnType=typeof(System.Boolean), Selector="willChangePPDOptionKeyValue:ppdChoice:")>]
type IPDEPlugInCallbackProtocol = interface
    interface INativeObject
    interface IDisposable

Derived: PrintCore.PDEPlugInCallbackProtocol

Attributes: ProtocolAttribute ProtocolMemberAttribute

Implements: INativeObject IDisposable

Properties

Name	Description
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from INativeObject)

Methods

Name	Description
GetPageFormat()	Returns the page format used by the dialog.
GetPpdFile()	Returns a pointer to the CUPS PPD structure (`ppd_file_s`) for the current printer. Use CUPS PPD functions to query and set options on the returned pointer.
GetPrinter()	Returns the current printer. For a page setup dialog this is the default printer; for a print dialog it is the currently selected printer.
GetPrintSession()	Returns the current print session.
GetPrintSettings()	Returns the print settings being modified by the dialog.
WillChangePpdOptionKeyValue(String, String)	Notifies the print system that the plugin intends to change a PPD option choice. The print system validates the change and returns whether it is allowed.

Extension Methods

Name	Description
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)

Applies to