• <GetStart>
  • CSPro User's Guide
    • The CSPro System
    • Data Dictionary Module
    • The CSPro Language
    • Data Entry Module
    • Batch Editing Applications
    • Tabulation Applications
    • Data Sources
    • CSPro Statements and Functions
      • Statement Format Symbols
      • Alphabetical List of Functions and Statements
      • List of Reserved Words
      • Deprecated Features
      • Declaration Statements
      • Numeric Values
      • String Values
      • Symbol Functions
      • Item Functions
      • Array Object
      • Audio Object
      • Barcode and QR Codes
      • Case Object
      • Document Object
      • File Object
      • Freq Object
      • Geometry Object
      • HashMap Object
      • Image Object
        • Image Statement
        • Image.load Function
        • Image.save Function
        • Image.width Function
        • Image.height Function
        • Image.getExif Function
        • EXIF Tags
        • Image.resample Function
        • Image.createQRCode Function
        • Image.takePhoto Function
        • Image.captureSignature Function
        • Image.view Function
        • Image.clear Function
        • JSON Representation
      • List Object
      • Map Object
      • Path
      • Pff Object
      • StringWriter Object
      • SystemApp Object
      • ValueSet Object
      • Program Control Statements
      • Assignment Statements
      • Data Entry Statements and Functions
      • Batch Edit Statements
      • Numeric Functions
      • String Functions
      • Multiple Occurrence Functions
      • General Functions
      • Date and Time Functions
      • External File Functions
      • Synchronization Functions
    • Text Templates
    • Templated Reporting System
    • HTML, Markdown, and JavaScript Integration
    • Action Invoker
    • Appendix
  • <CSEntry>
  • <CSBatch>
  • <CSTab>
  • <DataManager>
  • <TextView>
  • <TblView>
  • <CSFreq>
  • <CSDeploy>
  • <CSPack>
  • <CSDiff>
  • <CSConcat>
  • <Excel2CSPro>
  • <CSExport>
  • <CSIndex>
  • <CSReFmt>
  • <CSSort>
  • <ParadataConcat>
  • <ParadataViewer>
  • <CSCode>
  • <CSDocument>
  • <CSView>
  • <CSWeb>

Image.view Function

Format
b = image_name.view(ʃviewer_argumentsʅ);
Description
The Image.view function displays the image held by the Image object. The image will be show in an embedded web brower. If you prefer to display the image using the system's default viewer for the image type, you can use the following syntax:
view(filename(image_name));
This approach will only work if the image has been saved to the disk.
Viewer Arguments
Optional named arguments can be used to control how the embedded web browser displays on Windows:
  • title := string expression giving the title of the window.
  • width := numeric expression specifying the width of the window in display units.
  • height := numeric expression specifying the height of the window in display units.
  • showCloseButton := conditional expression that, if false, hides the window's Close button.
If either the height or width is specified, then both values must be provided. Hiding the Close button also removes the margin around the web browser, so the browser will fill the entire embedded window.
Return Value
The function returns a logical value of 1 (true) if the image was displayed, 0 (false) if there was an error viewing the image, and default if the Image object does not contain an image.
Example
Image tree_photo;

// ... load or take photo

tree_photo.
view();

when accept("Are you satisfied with the photo of the tree?", "Yes", "No");
   
1 -> tree_photo.save("Tree Photo.jpg");
   
2 -> tree_photo.clear();
endwhen;
See also: Image Object