Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6l

Application v 6.6b

  

 

Chapter Seventeen — Application Integration Functions (continued)

GetEditWindowType Function

Overview

The GetEditWindowType function returns the designated type code for a requested window.

Syntax/Parameters

Syntax

dword = GetEditWindowType ( handle hwTarget | int index, [int view] );

Parameters

hwTarget

A handle. If hwTarget is specified, then index or filename cannot be specified.

index

An int specifying an Edit Manager Index. If index is specified, then hwTarget or filename cannot be specified. Use -1 to return the window type for the active window.

view

An optional int specifying the view index. If the view index is not specified, the active view’s type is returned.

Return Value

Returns a dword containing the formatted window type information or 0 on failure. Use the GetLastError function to retrieve error information.

Remarks

The window type code is a combination of flags with a window ID. These are defined as part of the SDK. The codes are as follows:

  Define   Bitwise
Code
  Description  
  Window/View Types          
  ID          
    EDX_TYPE_ID_MASK   0x00000FFF   Unique ID By View (see below)  
  Non-View DLL (ribbons)          
    EDX_TYPE_NON_VIEW   0xFFFF0000   Code (DLL # is low word)  
  Mapped Data Types          
    EDX_TYPE_MASK   0xC0000000   Class Window Mask  
    EDX_TYPE_EDIT   0x00000000   Editor Class Window (any data)  
    EDX_TYPE_VIEW   0x40000000   View Only Type (with mapped data)  
  Non-Mapped Data        
    EDX_TYPE_PROJECT   0x80000000   Editor Class Window  
    EDX_TYPE_TAB_VIEW   0xC0000000   Tab View (Rack/Index) Class Window  
  Characteristics (support)        
    EDX_TYPE_SUPPORT_MASK   0x3FF00000   Bits Mask (not ordinal)  
    EDX_TYPE_READ_ONLY   0x00100000   View is Read-Only  
    EDX_TYPE_TEXT   0x00200000   View Supports Text/Free Flow  
    EDX_TYPE_HTML   0x00400000   View Supports HTML/Free Flow  
    EDX_TYPE_DATA   0x00800000   View Supports Table/Data Structure  
    EDX_TYPE_IMAGE   0x01000000   View Supports Image Editing  
    EDX_TYPE_VIDEO   0x02000000   View Supports Video Editing  
    EDX_TYPE_AUDIO   0x04000000   View Supports Audio Editing  
    EDX_TYPE_CODE   0x08000000   View Supports Text/Free Flow  
    EDX_TYPE_SUPPORT_EDX   0x20000000   Supports EDX (Edit Object)  
  Location Addressing (caret)        
    EDX_TYPE_POS_MASK   0x000FF000   Type of Location (bitwise)  
    EDX_TYPE_POS_NONE   0x00000000   Does not Support Positioning/Caret  
    EDX_TYPE_POS_TEXT   0x00001000   Text X/Y Caret  
    EDX_TYPE_POS_CELLS   0x00002000   Data as Rows/Columns Caret  
    EDX_TYPE_POS_PIXELS   0x00004000   Pixel Positioning  
    EDX_TYPE_POS_TIME   0x00008000   Time Positioning  
    EDX_TYPE_POS_FIELD   0x00010000   Named Fields  
               
  Known View IDs          
  Base Types          
    EDX_TYPE_DASHBOARD   0x00000010   Dashboard View  
    EDX_TYPE_DATA_VIEW   0x00000020   Data View (edit, native)  
    EDX_TYPE_FORMS_VIEW   0x00000030   Forms View (native, data view)  
    EDX_TYPE_IMAGE_VIEW   0x00000040   Image View (edit)  
    EDX_TYPE_OBJECT_VIEW   0x00000050   Object (PDF) View (read-only)  
    EDX_TYPE_PAGE_VIEW   0x00000060   Page View  
    EDX_TYPE_PDF_VIEW   0x00000070   PDF View (edit/convert)  
    EDX_TYPE_PROJECT_VIEW   0x00000080   Project View (native)  
    EDX_TYPE_TEXT_VIEW   0x00000090   Text View  
    EDX_TYPE_WEB_VIEW   0x000000A0   Web View  
  Application Specific Types          
    EDX_TYPE_EDGAR_VIEW   0x00000110   EDGAR Submission View (data view)  
    EDX_TYPE_NSS_VIEW   0x00000120   Novaworks Submission Service  
    EDX_TYPE_XBRL_VIEW   0x00000130   XBRL View (data view)  
    EDX_TYPE_XBRL_TREE   0x00000140   XBRL Tree View (data view)  
    EDX_TYPE_XML_13F_VIEW   0x00000150   Form 13F View (data view)  
    EDX_TYPE_XML_13H_VIEW   0x00000160   Form 13H View (data view)  
    EDX_TYPE_XML_D_VIEW   0x00000170   Form D View (data view)  
    EDX_TYPE_XML_MA_VIEW   0x00000180   Form MA View (data view)  
    EDX_TYPE_XML_MFP_VIEW   0x00000190   Form MFP View (data view)  
    EDX_TYPE_XML_NSAR_VIEW   0x000001A0   Form NSAR View (obsolete)  
    EDX_TYPE_XML_SDR_VIEW    0x000001A8   Form SDR View (data view)   
    EDX_TYPE_XML_S16_VIEW   0x000001B0   Section 16 View (data view)  
    EDX_TYPE_XML_RGA_VIEW   0x000001C0   Regulation A View (data view)  
    EDX_TYPE_XML_C_VIEW   0x000001D0   Form C View (data view)  
    EDX_TYPE_XML_17_VIEW   0x000001E0   Form X-17A-5 View (data view)  
    EDX_TYPE_XML_CFP_VIEW   0x000001F0   Form CFPORTAL View (data view)  
    EDX_TYPE_XML_17H_VIEW   0x00000210   Form 17-H View (data view)  
    EDX_TYPE_XML_TA_VIEW   0x00000220   Form TA View (data view)  
    EDX_TYPE_XML_CEN_VIEW   0x00000230   Form N-CEN View (data view)  
    EDX_TYPE_XML_NPT_VIEW   0x00000240   Form N-PORT View (data view)  
    EDX_TYPE_XML_S16_COM_VIEW   0x00000250   Section 16 Composite View (data view)  
    EDX_TYPE_XML_ATS_VIEW   0x00000260   Form ATS-N View (data view)  
    EDX_TYPE_XML_24F2_VIEW   0x00000270   Form 24F-2 View (data view)  
    EDX_TYPE_XML_144_VIEW   0x00000280   Form 144 View (data view)  
    EDX_TYPE_XML_NPX_VIEW   0x00000290   Form N-PX View (data view)  
    EDX_TYPE_XML_SC13DG_VIEW   0x00000300   Schedule 13D/G View (data view)  
    EDX_TYPE_XML_NCR_VIEW   0x00000310   Form N-CR View (data view)  
    EDX_TYPE_XML_SHO_VIEW   0x00000320   Form SHO View (data view)  
    EDX_TYPE_XML_1_VIEW   0x00000330   Form 1 View (data view)  
    EDX_TYPE_XML_ANE_VIEW   0x00000340   Form ANE View (data view)  

Most edit windows contain views of the same type. However, some types, such as Page View, will be combined with a Text View (HTML Code View) window type.

If the window is specified as a handle, the request is sent directly to the window.

The following definitions have been deprecated in favor of new names:

EDX_TYPE_PSG_DASHBOARD              EDX_TYPE_DASHBOARD      
EDX_TYPE_PSG_DATA_VIEW              EDX_TYPE_DATA_VIEW      
EDX_TYPE_PSG_FORMS_VIEW             EDX_TYPE_FORMS_VIEW     
EDX_TYPE_PSG_IMAGE_VIEW             EDX_TYPE_IMAGE_VIEW     
EDX_TYPE_PSG_OBJECT_VIEW            EDX_TYPE_OBJECT_VIEW    
EDX_TYPE_PSG_PAGE_VIEW              EDX_TYPE_PAGE_VIEW      
EDX_TYPE_PSG_PDF_VIEW               EDX_TYPE_PDF_VIEW       
EDX_TYPE_PSG_PROJECT_VIEW           EDX_TYPE_PROJECT_VIEW   
EDX_TYPE_PSG_TEXT_VIEW              EDX_TYPE_TEXT_VIEW      
EDX_TYPE_PSG_WEB_VIEW               EDX_TYPE_WEB_VIEW       

 

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE