GetEditWindowType Function

GoFiler Legato Script Reference

Legato v 1.5d

Application v 5.25a

Table of Contents	< < Previous	Next >>

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)
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_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
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_PSG_DASHBOARD	0x00000010	Dashboard View
	EDX_TYPE_PSG_DATA_VIEW	0x00000020	Data View (edit, native)
	EDX_TYPE_PSG_FORMS_VIEW	0x00000030	Forms View (native, data view)
	EDX_TYPE_PSG_IMAGE_VIEW	0x00000040	Image View (edit)
	EDX_TYPE_PSG_OBJECT_VIEW	0x00000050	Object (PDF) View (read-only)
	EDX_TYPE_PSG_PAGE_VIEW	0x00000060	Page View
	EDX_TYPE_PSG_PDF_VIEW	0x00000070	PDF View (edit/convert)
	EDX_TYPE_PSG_PROJECT_VIEW	0x00000080	Project View (native)
	EDX_TYPE_PSG_TEXT_VIEW	0x00000090	Text View
Specialized Types
	EDX_TYPE_EDGAR_VIEW	0x00000110	EDGAR Submission 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 (data view) (not XML)
	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)

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.

Related Functions

Platform Support

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

Legato IDE

Table of Contents	< < Previous	Next >>

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.