GetDefaultOverlayBoxParameters Method

Returns a DicomOverlayBoxParameters object with its properties set to default values.

Syntax

Visual Basic
C#
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public DicomOverlayBoxParameters GetDefaultOverlayBoxParameters()

'Declaration
 
Public Function GetDefaultOverlayBoxParameters() As DicomOverlayBoxParameters

'Usage
 
Dim instance As DicomPrintScu
Dim value As DicomOverlayBoxParameters
 
value = instance.GetDefaultOverlayBoxParameters()

public DicomOverlayBoxParameters GetDefaultOverlayBoxParameters()

ObjectiveC Syntax

 function Leadtools.Dicom.DicomPrintScu.GetDefaultOverlayBoxParameters()

public:
DicomOverlayBoxParameters^ GetDefaultOverlayBoxParameters();

Return Value

A DicomOverlayBoxParameters object with its properties set to default values.

Remarks

The method sets each of the properties DicomOverlayBoxParameters.OverlayOriginRow and DicomOverlayBoxParameters.OverlayOriginColumn, of the returned object, to 1. The property DicomOverlayBoxParameters.MagnifyToNumberOfColumns is set to a negative value and all string properties are set to null references (Nothing in Visual Basic).

Example

For an example, refer to Associate(String,Int32,String,String,DicomPrintScuPrintManagementClassFlags).

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DicomPrintScu Class
DicomPrintScu Members
CreateOverlayBox Method
UpdateOverlayBox Method