DicomObjects.NET.8.48 Documentation
DicomObjects Namespace / DicomPrint Class / Format Property

In This Topic
    Format Property
    In This Topic
    Common printing variable, the printing format
    Public Property Format As System.String
    Dim instance As DicomPrint
    Dim value As System.String
    instance.Format = value
    value = instance.Format
    public System.string Format {get; set;}
    public read-write property Format: System.String; 
    public function get,set Format : System.String
    public: __property System.string* get_Format();
    public: __property void set_Format( 
       System.string* value
    property System.String^ Format {
       System.String^ get();
       void set (    System.String^ value);

    FilmSize, Orientation, Format, AnnotationFormat and Copies, these are the most commonly used variables when printing so they are given names, so that users do not need to remember the attribute tags for each, and which of the DataSets they apply to. These properties are simply shortcuts to values in Session or FilmBox. The equivalences and default values are as below:

    Property DataSet Tags Default Value
    FilmSize FilmBox 2010, 0050 blank (printer default)
    Orientation FilmBox 2010, 0040 "PORTRAIT"
    Format FilmBox 2010, 0010 "STANDARD\1,1"
    AnnotationFormat FilmBox 2010, 0030 blank
    Copies Session 2000, 0010 1

    Note that the "X" in the FilmSize value must be a capital letter !


    Target Platforms: .NET CLR 4.8 or higher

    See Also