PrintGetMargins Method (GdViewer)

In This Topic

Returns the physical margins (x and y coordinates), that are part of the default page settings property of the active printer. Both margins are used as defaults for all pages to be printed.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function PrintGetMargins( _
   ByRef LeftMargin As Single, _
   ByRef TopMargin As Single _
) As GdPictureStatus

public GdPictureStatus PrintGetMargins( 
   ref float LeftMargin,
   ref float TopMargin
)

public function PrintGetMargins( 
   var  LeftMargin: Single;
   var  TopMargin: Single
): GdPictureStatus;

public function PrintGetMargins( 
   LeftMargin : float,
   TopMargin : float
) : GdPictureStatus;

public: GdPictureStatus PrintGetMargins( 
   ref float LeftMargin,
   ref float TopMargin
)

public:
GdPictureStatus PrintGetMargins( 
   float% LeftMargin,
   float% TopMargin
)

Parameters

LeftMargin: Output parameter. The physical margin (x-coordinate) at the left of the page, in inches.
TopMargin: Output parameter. The physical margin (y-coordinate) at the top of the page, in inches.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

It is recommend to use the GetStat method or the PrintGetStat method to identify the specific reason for the method's failure, if any.

Just to remind you that the active printer is the printer identified by the PrintGetActivePrinter method or set by the PrintSetActivePrinter method and it is dedicated to executing all subsequent print jobs using this class as well as utilizing all by you altered printer settings.

Example

How to find out some page properties of the active printer.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
Dim message As String = ""
Dim curPrinter As String = GdViewer1.PrintGetActivePrinter()
If GdViewer1.GetStat() = GdPictureStatus.OK Then
    message = "Active printer: " + curPrinter + vbCrLf
Else
    message = "The PrintGetActivePrinter() method has failed with the status: " + GdViewer1.GetStat()
End If
If GdViewer1.GetStat() = GdPictureStatus.OK Then
    Dim leftMargin As Single = 0, rightMargin As Single = 0
    GdViewer1.PrintGetMargins(leftMargin, rightMargin)
            
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        message = message + "    margins: left = " + leftMargin.ToString() + ", right = " + rightMargin.ToString() + vbCrLf
    Else
        message = "The PrintGetMargins() method has failed with the status: " + GdViewer1.GetStat()
    End If
End If
If GdViewer1.GetStat() = GdPictureStatus.OK Then
    Dim prnBin As Integer = GdViewer1.PrintGetPaperBin()
            
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        message = message + "    paper bin: " + prnBin.ToString() + vbCrLf
    Else
        message = "The PrintGetPaperBin() method has failed with the status: " + GdViewer1.GetStat()
    End If
End If
If GdViewer1.GetStat() = GdPictureStatus.OK Then
    Dim prnSize As Integer = GdViewer1.PrintGetPaperSize()
            
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        message = message + "    paper size: " + prnSize.ToString() + vbCrLf
    Else
        message = "The PrintGetPaperSize() method has failed with the status: " + GdViewer1.GetStat()
    End If
End If
If GdViewer1.GetStat() = GdPictureStatus.OK Then
    Dim prnHeight As Single = GdViewer1.PrintGetPaperHeight()
            
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        message = message + "    paper height: " + prnHeight.ToString()
    Else
        message = "The PrintGetPaperHeight() method has failed with the status: " + GdViewer1.GetStat()
    End If
End If
If GdViewer1.GetStat() = GdPictureStatus.OK Then
    Dim prnWidth As Single = GdViewer1.PrintGetPaperWidth()
            
    If GdViewer1.GetStat() = GdPictureStatus.OK Then
        message = message + "    paper width: " + prnWidth.ToString() + vbCrLf
    Else
        message = "The PrintGetPaperWidth() method has failed with the status: " + GdViewer1.GetStat()
    End If
End If
If GdViewer1.GetStat() <> GdPictureStatus.OK Then
    message = "The example has NOT been followed successfully. Status: " + GdViewer1.GetStat().ToString()
End If
MessageBox.Show(message, "GdViewer.PrintGetMargins")

//We assume that the GdViewer1 control has been properly integrated.
string message = "";
string curPrinter = GdViewer1.PrintGetActivePrinter();
if (GdViewer1.GetStat() == GdPictureStatus.OK)
    message = "Active printer: " + curPrinter + "\n";
else
    message = "The PrintGetActivePrinter() method has failed with the status: " + GdViewer1.GetStat();
if (GdViewer1.GetStat() == GdPictureStatus.OK)
{
    float leftMargin = 0, rightMargin = 0;
    GdViewer1.PrintGetMargins(ref leftMargin, ref rightMargin);
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
        message = message + "    margins: left = " + leftMargin.ToString() + ", right = " + rightMargin.ToString() + "\n";
    else
        message = "The PrintGetMargins() method has failed with the status: " + GdViewer1.GetStat();
}
if (GdViewer1.GetStat() == GdPictureStatus.OK)
{
    int prnBin = GdViewer1.PrintGetPaperBin();
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
        message = message + "    paper bin: " + prnBin.ToString() + "\n";
    else
        message = "The PrintGetPaperBin() method has failed with the status: " + GdViewer1.GetStat();
}
if (GdViewer1.GetStat() == GdPictureStatus.OK)
{
    int prnSize = GdViewer1.PrintGetPaperSize();
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
        message = message + "    paper size: " + prnSize.ToString() + "\n";
    else
        message = "The PrintGetPaperSize() method has failed with the status: " + GdViewer1.GetStat();
}
if (GdViewer1.GetStat() == GdPictureStatus.OK)
{
    float prnHeight = GdViewer1.PrintGetPaperHeight();
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
        message = message + "    paper height: " + prnHeight.ToString();
    else
        message = "The PrintGetPaperHeight() method has failed with the status: " + GdViewer1.GetStat();
}
if (GdViewer1.GetStat() == GdPictureStatus.OK)
{
    float prnWidth = GdViewer1.PrintGetPaperWidth();
    if (GdViewer1.GetStat() == GdPictureStatus.OK)
        message = message + "    paper width: " + prnWidth.ToString() + "\n";
    else
        message = "The PrintGetPaperWidth() method has failed with the status: " + GdViewer1.GetStat();
}
if (GdViewer1.GetStat() != GdPictureStatus.OK)
{
    message = "The example has NOT been followed successfully. Status: " + GdViewer1.GetStat().ToString();
}
MessageBox.Show(message, "GdViewer.PrintGetMargins");

Reference

GdViewer Class
GdViewer Members
PrintGetActivePrinter Method
PrintGetPrinterSettings Method
PrintSetActivePrinter Method
PrintSetPrinterSettings Method
PrintGetStat Method