Cicode Programming Reference > Cicode Function Categories > Super Genie Functions Introduction > AssMetadataWin

AssMetadataWin

Uses the metadata information from the current animation-point for the associations for a new Super Genie page, and displays the new Super Genie in a new window.

Syntax

AssMetadataWin(sPage, INT x, INT y, INT mode)

sPage:

The name of the Super Genie page to open.

X:

The x pixel coordinate of the top left corner of the window. Default value is 0.

Y:

The y pixel coordinate of the top left corner of the window. Default value is 0.

Mode:

The mode of the window:

0 - Normal page (default value).

1 - Page child window. The window is closed when a new page is displayed, for example, when the PageDisplay() or PageGoto() function is called. The parent is the current active window.

2 - Window child window. The window is closed automatically when the parent window is freed with the WinFree() function. The parent is the current active window.

4 - No re-size. The window is displayed with thin borders and no maximize/minimize icons. The window cannot be re-sized.

8 - No icons. The window is displayed with thin borders and no maximize/minimize or system menu icons. The window cannot be re-sized.

16 - No caption. The window is displayed with thin borders, no caption, and no maximize/minimize or system menu icons. The window cannot be re-sized.

32 - Echo enabled. When enabled, keyboard echo, prompts, and error messages are displayed on the parent window. This mode should only be used with child windows (for example, Mode 1 and 2).

64 - Always on top.

128 - Open a unique window. This mode stops this window from being opened more then once.

256 - Display the entire window. This mode commands that no parts of the window will appear off the screen

512 - Open a unique Super Genie. This mode stops a Super Genie from being opened more than once (at the same time). However, the same Super Genie with different associations can be opened.

1024 - Disables dynamic resizing of the new window, overriding the setting of the [Page]DynamicSizing parameter.

4096 - Allows the window to be resized without maintaining the current aspect ratio. The aspect ratio defines the relationship between the width and the height of the window, which means this setting allows you to stretch or compress the window to any proportions. This option overrides the setting of the [Page]MaintainAspectRatio parameter.

8192 - Text on a page will be resized in proportion with the maximum scale change for a resized window. For example, consider a page that is resized to three times the original width, and half the original height. If this mode is set, the font size of the text on the page will be tripled (in proportion with the maximum scale). This option overrides the setting of the [Page] ScaleTextToMax parameter.

16384 - Hide the horizontal scroll bar.

32768 - Hide the vertical scroll bar.

65536 - Disable horizontal scrolling.

131072 - Disable vertical scrolling.

You can select multiple modes by adding modes together (for example, set Mode to 9 to open a page child window without maximize, minimize, or system menu icons).

nAN:    

An animation number that uniquely identifies an object. This object contains the list of metadata definitions that will be used to perform the association operations.This parameter is optional with -2 being the default value. When -2 is specified, it is the same as using the function KeyGetCursor() which returns the animation number of the current active command cursor. Refer to KeyGetCursor() for usage and behavior.

 

UNINTENDED EQUIPMENT OPERATION

If called after other cicode functions in a command expression field, retrieve the animation number first, then pass it through the nAN parameter.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

Return Value

0 (zero) if successful, error code if unsuccessful.

Example

/* Example of calling AssMetadataWin after other cicode functions */

An = KeyGetCursor();

SomeVal = TagRead(“SomeTag”); // do additional work

AssMetadataWin(“!TestSG”, 50, 50, 1, An);

Related Functions

Ass, AssChain, AssMetadata, AssMetadataPage, AssMetadataPopup, AssChainPage, AssChainPopUp, AssChainWin, AssChainWinFree, AssGetProperty, AssGetScale, AssInfo, AssInfoEx, AssPage, AssPopUp, AssScaleStr, AssTag, AssTitle, AssVarTags, AssWin

See Also

Super Genie Functions