PrinterSettings.IsDefaultPrinter Property

Definition

Namespace:

System.Drawing.Printing

Assembly:

System.Drawing.Common.dll

Package:

System.Drawing.Common v9.0.0-rc.2.24474.1

Source:

PrinterSettings.cs

Gets a value indicating whether the PrinterName property designates the default printer, except when the user explicitly sets PrinterName.

public:
 property bool IsDefaultPrinter { bool get(); };

public bool IsDefaultPrinter { get; }

member this.IsDefaultPrinter : bool

Public ReadOnly Property IsDefaultPrinter As Boolean

Property Value

Boolean

true if PrinterName designates the default printer; otherwise, false.

Examples

The following example demonstrates how to use the IsDefaultPrinter property. To run this example, paste the following code into a form and call PopulateInstalledPrintersCombo from the form's constructor or Load event-handling method.

private ComboBox comboInstalledPrinters = new ComboBox();
private PrintDocument printDoc = new PrintDocument();

private void PopulateInstalledPrintersCombo()
{
    comboInstalledPrinters.Dock = DockStyle.Top;
    Controls.Add(comboInstalledPrinters);

    // Add list of installed printers found to the combo box.
    // The pkInstalledPrinters string will be used to provide the display string.
    int i;
    string pkInstalledPrinters;

    for (i = 0; i < PrinterSettings.InstalledPrinters.Count; i++)
    {
        pkInstalledPrinters = PrinterSettings.InstalledPrinters[i];
        comboInstalledPrinters.Items.Add(pkInstalledPrinters);
        if (printDoc.PrinterSettings.IsDefaultPrinter)
        {
            comboInstalledPrinters.Text = printDoc.PrinterSettings.PrinterName;
        }
    }
}

Private WithEvents comboInstalledPrinters As New ComboBox
Private WithEvents printDoc As New PrintDocument

Private Sub PopulateInstalledPrintersCombo()
    comboInstalledPrinters.Dock = DockStyle.Top
    Controls.Add(comboInstalledPrinters)

    ' Add list of installed printers found to the combo box.
    ' The pkInstalledPrinters string will be used to provide the display string.
    Dim i As Integer
    Dim pkInstalledPrinters As String

    For i = 0 To PrinterSettings.InstalledPrinters.Count - 1
        pkInstalledPrinters = PrinterSettings.InstalledPrinters.Item(i)
        comboInstalledPrinters.Items.Add(pkInstalledPrinters)
        If (printDoc.PrinterSettings.IsDefaultPrinter()) Then
            comboInstalledPrinters.Text = printDoc.PrinterSettings.PrinterName
        End If
    Next
End Sub

Remarks

IsDefaultPrinter always returns false when you explicitly set the PrinterName property to a string value other than null.

See also

• PrinterName