AV_Layer.AVMenuItem (Acrobat)

	Typedef
	AVMenuItem A menu item under a menu in the Acrobat viewer. It has a number of attributes, including a name, a keyboard shortcut, a procedure to execute when the menu item is selected, a procedure to compute whether the menu item is enabled, a procedure to compute whether the menu item is check marked, and whether or not it has a submenu.

	Callback
	AVMenuItemPredicate A callback that is called for each menu item enumerated by AVMenubarAcquireMenuItemByPredicate(). The first menu item for which this callback returns true is acquired.

	Method
	AVMenuItem AVMenuItemAcquire(AVMenuItem menuItem) Acquires a menu item. It increments the menu item's reference count.
	AVMenu AVMenuItemAcquireSubmenu(AVMenuItem menuItem) Acquires the submenu attached to the specified menu item, if there is one. When you are done with the submenu, release it using AVMenuRelease().
	AVMenuItem AVMenuItemClone(AVMenuItem menuItem) Creates a new menu item object using an existing menu item as a template. If the menu item contains a submenu, that submenu is also copied.
	void AVMenuItemExecute(AVMenuItem menuItem) Executes a menu item's AVExecuteProc(). It does nothing if menuItem is NULL, if menuItem has no AVExecuteProc, or if menuItem is not enabled.
	ASBool AVMenuItemGetLongOnly(AVMenuItem menuItem) Gets the flag indicating whether a menu item is visible only in long-menus mode.
	ASAtom AVMenuItemGetName(AVMenuItem menuItem) Gets the atom for the language-independent name of the menu item.
	AVMenu AVMenuItemGetParentMenu(AVMenuItem menuItem) Gets the menu in which the specified menu item appears.
	ASBool AVMenuItemGetShortcut(AVMenuItem menuItem, char* key, AVFlagBits16* flags) Gets the shortcut key for the specified menu item.
	AVTArraySize AVMenuItemGetTitle(AVMenuItem menuItem, char* buffer, AVTArraySize bufferSize) Gets a menu item's title, which is the string that appears in the user interface.
	void AVMenuItemGetTitleAsASText(AVMenuItem menuItem, ASText title) Gets the menu item's title as it appears in the user interface, as an ASText object.
	ASBool AVMenuItemIsEnabled(AVMenuItem menuItem) Tests whether the specified menu item is enabled.
	ASBool AVMenuItemIsMarked(AVMenuItem menuItem) Tests whether menuItem is marked (for example, it appears with a check mark).
	ASBool AVMenuItemIsScriptable(AVMenuItem menuItem) Determines whether the given menu item is an executable menu item.
	ASBool AVMenuItemIsVisible(AVMenuItem menuItem) Tests whether the specified menu item is visible on its parent menu. The visibility state is calculated using the AVComputeVisibleProc().
	AVMenuItem AVMenuItemNew(const char* title, const char* name, AVMenu submenu, ASBool longMenusOnly, char shortcut, AVFlagBits16 flags, AVIcon icon, ASExtension owner) Creates and acquires a new AVMenuItem. The menu item can be added to a menu using AVMenuAddMenuItem().
	AVMenuItem AVMenuItemNewWithASText(ASConstText title, const char* name, AVMenu submenu, ASBool longMenusOnly, char shortcut, AVFlagBits16 flags, AVIcon icon, ASExtension owner) Creates and acquires a new AVMenuItem. The menu item can be added to a menu using AVMenuAddMenuItem().
	void AVMenuItemRelease(AVMenuItem menuItem) Releases a menu item. It decrements the reference count and destroys the menu item if the count is zero.
	void AVMenuItemRemove(AVMenuItem menuItem) Removes a menu item from the menu hierarchy and releases it. It does nothing if menuItem is NULL.
	void AVMenuItemSetComputeEnabledProc(AVMenuItem menuItem, AVComputeEnabledProc proc, void* data) Sets the user-supplied procedure to call to determine whether the menu item is enabled. It does nothing if menuItem is NULL.
	void AVMenuItemSetComputeMarkedProc(AVMenuItem menuItem, AVComputeMarkedProc proc, void* data) Sets the user-supplied procedure that determines whether the menu item appears with a check mark. It does nothing if menuItem is NULL. If the menu item has no AVExecuteProc() (see AVMenuItemSetExecuteProc()), its AVComputeMarkedProc() is never called. To avoid this, add an AVExecuteProc() that does nothing, and if you wish the menu item to gray out, also add an AVComputeEnabledProc() that always returns false.
	void AVMenuItemSetComputeVisibleProc(AVMenuItem menuItem, AVComputeVisibleProc proc, void* data) Sets the user-supplied procedure that determines whether the menu item appears when its parent menu is opened. It does nothing if menuItem is NULL.
	void AVMenuItemSetExecuteProc(AVMenuItem menuItem, AVExecuteProc proc, void* data) Sets the user-supplied procedure to execute whenever the menu item is chosen. It does nothing if menuItem is NULL. Clients must not set the execute procedure of the Acrobat viewer's built-in menu items.
	void AVMenuItemSetTitle(AVMenuItem menuItem, const char* title) Sets a menu item's title, which is the string that appears in the user interface. Use this method to manage menu items whose titles change (such as 'show/hide fooWindow'), instead of inserting and removing menu items on the fly.
	void AVMenuItemSetTitleWithASText(AVMenuItem menuItem, ASConstText title) Sets a menu item's title, which is the string that appears in the user interface, from a constant text object. Use this method to manage menu items whose titles change (such as 'show/hide fooWindow'), instead of inserting and removing menu items on the fly.

Typedefs Detail

AVMenuItem

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

typedef struct _t_AVMenuItem* AVMenuItem;

A menu item under a menu in the Acrobat viewer. It has a number of attributes, including a name, a keyboard shortcut, a procedure to execute when the menu item is selected, a procedure to compute whether the menu item is enabled, a procedure to compute whether the menu item is check marked, and whether or not it has a submenu.

See Also

File: AVExpT.h

Line: 1391

Callbacks Detail

AVMenuItemPredicate

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax

ASBool (*AVMenuItemPredicate)(AVMenuItem menuItem, void *clientData)

A callback that is called for each menu item enumerated by AVMenubarAcquireMenuItemByPredicate(). The first menu item for which this callback returns true is acquired.

See Also

AVMenubarAcquireMenuItemByPredicate

File: AVExpT.h

Line: 1487

Method Detail

AVMenuItemAcquire

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVMenuItem AVMenuItemAcquire(AVMenuItem menuItem)

Acquires a menu item. It increments the menu item's reference count.

Parameters

menuItem —

IN/OUT The menu item to acquire.

Returns

The menu item acquired.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1766

AVMenuItemAcquireSubmenu

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVMenu AVMenuItemAcquireSubmenu(AVMenuItem menuItem)

Acquires the submenu attached to the specified menu item, if there is one. When you are done with the submenu, release it using AVMenuRelease().

Parameters

menuItem —

IN/OUT The menu item whose submenu is obtained.

Returns

The specified menu item's submenu. It returns NULL if menuItem is NULL or if menuItem does not have a submenu.

See Also

AVMenuAcquire
AVMenuRelease

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1950

AVMenuItemClone

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVMenuItem AVMenuItemClone(AVMenuItem menuItem)

Creates a new menu item object using an existing menu item as a template. If the menu item contains a submenu, that submenu is also copied.

Parameters

menuItem —

The menu item to copy.

Returns

The new menu item object.

See Also

AVMenuItemNew
AVMenuItemNewWithASText

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8973

AVMenuItemExecute

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVMenuItemExecute(AVMenuItem menuItem)

Executes a menu item's AVExecuteProc(). It does nothing if menuItem is NULL, if menuItem has no AVExecuteProc, or if menuItem is not enabled.

You cannot execute a menu item that has a submenu (for example, the Pages menu item in the Document menu).

Parameters

menuItem —

The menu item to execute.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1989

AVMenuItemGetLongOnly

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVMenuItemGetLongOnly(AVMenuItem menuItem)

Gets the flag indicating whether a menu item is visible only in long-menus mode.

Parameters

menuItem —

The menu item whose flag is obtained.

Returns

true if the menu item is visible only in long-menus mode. false if the menu item is visible in both long and short menus, or if menuItem is NULL.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1873

AVMenuItemGetName

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASAtom AVMenuItemGetName(AVMenuItem menuItem)

Gets the atom for the language-independent name of the menu item.

Parameters

menuItem —

IN/OUT The menu item whose language-independent name is obtained.

Returns

The ASAtom corresponding to the name of the specified menu item, or ASAtomNull if menuItem is NULL. The ASAtom can be converted to a string using ASAtomGetString().

See Also

AVMenuItemGetTitle

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1805

AVMenuItemGetParentMenu

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVMenu AVMenuItemGetParentMenu(AVMenuItem menuItem)

Gets the menu in which the specified menu item appears.

Parameters

menuItem —

IN/OUT The menu item whose parent menu is obtained.

Returns

The menu in which the specified menu item appears. It returns NULL if this menu item is not in a menu.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 2002

AVMenuItemGetShortcut

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVMenuItemGetShortcut(AVMenuItem menuItem, char* key, AVFlagBits16* flags)

Gets the shortcut key for the specified menu item.

Parameters

	`menuItem` —	The menu item whose shortcut is obtained.

	`key` —	(Filled by the method) The key that is a shortcut for the menu item (an ASCII character). The value NO_SHORTCUT (see AVExpT.h) indicates that the menu item has no shortcut.

	`flags` —	(Filled by the method) Modifier keys, if any, used as part of the shortcut. It must be an OR of the Modifier Keys values, except that AV_COMMAND will never be present.

Returns

true if menuItem is not NULL and menuItem has a shortcut, false otherwise.

See Also

AVMenuItemNew

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1859

AVMenuItemGetTitle

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVTArraySize AVMenuItemGetTitle(AVMenuItem menuItem, char* buffer, AVTArraySize bufferSize)

Gets a menu item's title, which is the string that appears in the user interface.

Parameters

	`menuItem` —	The menu item whose title is obtained.

	`buffer` —	(Filled by the method) A buffer to hold the `NULL`-terminated name. If title is `NULL`, it returns the length of the menu item's name, but does not fill the buffer.

	`bufferSize` —	The maximum number of characters that can be placed into `title`. If the name is longer than this, only the first `bufferSize - 1` characters are placed into `buffer`, and the buffer is `NULL`-terminated.

Returns

The length of the title. It returns 0 if menuItem is NULL.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1826

AVMenuItemGetTitleAsASText

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVMenuItemGetTitleAsASText(AVMenuItem menuItem, ASText title)

Gets the menu item's title as it appears in the user interface, as an ASText object.

Parameters

	`menuItem` —	The menu item whose title is obtained.

	`title` —	(Filled by the method) The text object containing the title.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8233

AVMenuItemIsEnabled

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVMenuItemIsEnabled(AVMenuItem menuItem)

Tests whether the specified menu item is enabled.

Parameters

menuItem —

The menu item whose enabled flag is obtained.

Returns

true if menuItem is enabled, if menuItem is NULL, or if menuItem has no AVComputeEnabledProc(). It returns false if the menu item is disabled or its AVComputeEnabledProc() raises an exception.

See Also

AVMenuItemSetComputeEnabledProc

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1962

AVMenuItemIsMarked

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVMenuItemIsMarked(AVMenuItem menuItem)

Tests whether menuItem is marked (for example, it appears with a check mark).

Parameters

menuItem —

The menu item whose marked state is obtained.

Returns

true if menuItem is marked. It returns false if menuItem is NULL, if the menu item does not have an AVComputeMarkedProc(), or if it raises an exception.

See Also

AVMenuItemSetComputeMarkedProc

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1975

AVMenuItemIsScriptable

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVMenuItemIsScriptable(AVMenuItem menuItem)

Determines whether the given menu item is an executable menu item.

Parameters

menuItem —

IN The given menu item.

Returns

true if the given menu item is executable.

Since

PI_ACROVIEW_VERSION >= 0x00080000

File: AVProcs.h

Line: 9791

AVMenuItemIsVisible

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





ASBool AVMenuItemIsVisible(AVMenuItem menuItem)

Tests whether the specified menu item is visible on its parent menu. The visibility state is calculated using the AVComputeVisibleProc().

Parameters

menuItem —

The menu item whose visibility state is tested.

Returns

true if menuItem is visible, or if menuItem has no AVComputeVisibleProc(). It returns false if the menu item is not visible, if its AVComputeVisibleProc() raises an exception (this is not recommended), or if menuItem is NULL.

See Also

AVMenuItemSetComputeVisibleProc

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 9233

AVMenuItemNew

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVMenuItem AVMenuItemNew(const char* title, const char* name, AVMenu submenu, ASBool longMenusOnly, char shortcut, AVFlagBits16 flags, AVIcon icon, ASExtension owner)

Creates and acquires a new AVMenuItem. The menu item can be added to a menu using AVMenuAddMenuItem().

Release the AVMenuItem using AVMenuItemRelease() after it has been added to a menu.

Parameters

	`title` —	The string shown in the user interface for this menu item. Use a hyphen to create a separator menu item. This value is also returned by AVMenuItemGetTitle(). On Windows, an ampersand (`&`) character in the string results in underlining the character after it on the menu item.

	`name` —	The language-independent name of the menu item to create. This is the value returned by AVMenuItemGetName(). `name` must not contain any spaces. Client developers should prefix the names of menu items they add with the name of their client and a colon, to avoid collisions in the menu item name space. For example, a client named `myPlug` might add menu items named `myPlug:Scan` and `myPlug:Find`.

	`submenu` —	A submenu (if any) for which this menu item is the parent. Pass `NULL` if this menu item does not have a submenu.

	`longMenusOnly` —	(Ignored in Acrobat 3.0 or later) If `true`, the menu item is visible only when the user selects Full Menus. If `false`, the menu item is visible for both Full Menus and Short Menus modes.

	`shortcut` —	The key to use as a shortcut for the menu item (an ASCII character). Use NO_SHORTCUT (see AVExpT.h) if the menu item has no shortcut. The Acrobat viewer does not check for conflicts between shortcuts. The consequences of multiple menu items having the same shortcut is undefined. On Windows, the shortcut is not displayed for any menu item that also has an icon, although the shortcut will work.

	`flags` —	Modifier keys, if any, used as part of the shortcut. It must be an OR of the Modifier Keys values, except that AV_COMMAND cannot be specified.

	`icon` —	The icon to show in the menu item, or `NULL` if no icon is shown. On Windows, `icon` is a 24x24 sample monochrome `HBITMAP`.

	`owner` —	The `gExtensionID` extension registering the menu item.

Returns

The newly created menu item.

See Also

AVMenuAddMenuItem
AVMenuItemRelease

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1753

AVMenuItemNewWithASText

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





AVMenuItem AVMenuItemNewWithASText(ASConstText title, const char* name, AVMenu submenu, ASBool longMenusOnly, char shortcut, AVFlagBits16 flags, AVIcon icon, ASExtension owner)

Creates and acquires a new AVMenuItem. The menu item can be added to a menu using AVMenuAddMenuItem().

Release the AVMenuItem using AVMenuItemRelease() after it has been added to a menu.

Parameters

	`title` —	A constant text object containing the string shown in the user interface for this menu item. Use a hyphen to create a separator menu item. This value is also returned by AVMenuItemGetTitleAsASText(). On Windows, an ampersand (`&`) character in the string results in underlining the character after it on the menu item.

	`name` —	The language-independent name of the menu item to create. This is the value returned by AVMenuItemGetName(). `name` must not contain any spaces. Client developers should prefix the names of menu items they add with the name of their client and a colon, to avoid collisions in the menu item name space. For example, a client named `myPlug` might add menu items named m`yPlug:Scan` and `myPlug:Find`.

	`submenu` —	The submenu (if any) for which this menu item is the parent. Pass `NULL` if this menu item does not have a submenu.

	`longMenusOnly` —	(Ignored in Acrobat 3.0 or later) If `true`, the menu item is visible only when the user selects Full Menus. If `false`, the menu item is visible for both Full Menus and Short Menus modes.

	`shortcut` —	The key to use as a shortcut for the menu item (an ASCII character). Use `NO_SHORTCUT` (see AVExpT.h) if the menu item has no shortcut. The Acrobat viewer does not check for conflicts between shortcuts. The consequences of multiple menu items having the same shortcut is undefined. On Windows, the shortcut is not displayed for any menu item that also has an icon, although the shortcut will work.

	`flags` —	Modifier keys, if any, used as part of the shortcut. It must be an OR of the Modifier Keys values, except that `AV_COMMAND` cannot be specified.

	`icon` —	The icon to show in the menu item, or `NULL` if no icon is shown. On Windows, `icon` is a 24x24 sample monochrome `HBITMAP`.

	`owner` —	The gExtensionID extension registering the menu item.

Returns

The newly created menu item.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8218

AVMenuItemRelease

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVMenuItemRelease(AVMenuItem menuItem)

Releases a menu item. It decrements the reference count and destroys the menu item if the count is zero.

Parameters

menuItem —

IN/OUT The menu item to release.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1778

AVMenuItemRemove

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVMenuItemRemove(AVMenuItem menuItem)

Removes a menu item from the menu hierarchy and releases it. It does nothing if menuItem is NULL.

Keyboard accelerators for the Acrobat viewer's built-in menu items will always work, even if the menu item is removed.

Parameters

menuItem —

IN/OUT The menu item to remove.

See Also

AVMenuItemAcquire
AVMenuItemRelease

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1792

AVMenuItemSetComputeEnabledProc

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVMenuItemSetComputeEnabledProc(AVMenuItem menuItem, AVComputeEnabledProc proc, void* data)

Sets the user-supplied procedure to call to determine whether the menu item is enabled. It does nothing if menuItem is NULL.

Parameters

	`menuItem` —	The menu item whose AVComputeEnabledProc() is set.

	`proc` —	A user-supplied callback to call whenever the Acrobat viewer needs to know whether `menuItem` should be enabled. This procedure is called every time the menu is displayed, so it should not do time-intensive processing.

	`data` —	A pointer to user-supplied data to pass to `proc` each time it is called.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1912

AVMenuItemSetComputeMarkedProc

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVMenuItemSetComputeMarkedProc(AVMenuItem menuItem, AVComputeMarkedProc proc, void* data)

Sets the user-supplied procedure that determines whether the menu item appears with a check mark. It does nothing if menuItem is NULL. If the menu item has no AVExecuteProc() (see AVMenuItemSetExecuteProc()), its AVComputeMarkedProc() is never called. To avoid this, add an AVExecuteProc() that does nothing, and if you wish the menu item to gray out, also add an AVComputeEnabledProc() that always returns false.

Parameters

	`menuItem` —	The menu item whose AVComputeMarkedProc() is set.

	`proc` —	A user-supplied callback to call whenever the Acrobat viewer needs to know whether `menuItem` should be marked.

	`data` —	A pointer to user-supplied data to pass to `proc` each time it is called.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1936

AVMenuItemSetComputeVisibleProc

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVMenuItemSetComputeVisibleProc(AVMenuItem menuItem, AVComputeVisibleProc proc, void* data)

Sets the user-supplied procedure that determines whether the menu item appears when its parent menu is opened. It does nothing if menuItem is NULL.

Parameters

	`menuItem` —	The menu item whose visibility procedure is set.

	`proc` —	User-supplied procedure to call when the Acrobat viewer needs to know if the menu item is visible.

	`data` —	A pointer to user-supplied data to pass to `proc` each time it is called.

See Also

AVMenuItemIsVisible

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 9218

AVMenuItemSetExecuteProc

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVMenuItemSetExecuteProc(AVMenuItem menuItem, AVExecuteProc proc, void* data)

Sets the user-supplied procedure to execute whenever the menu item is chosen. It does nothing if menuItem is NULL. Clients must not set the execute procedure of the Acrobat viewer's built-in menu items.

Parameters

	`menuItem` —	The menu item whose execute procedure is set.

	`proc` —	A user-supplied callback to call whenever `menuItem` is selected.

	`data` —	A pointer to user-supplied data to pass to `proc` each time it is called.

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1891

AVMenuItemSetTitle

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVMenuItemSetTitle(AVMenuItem menuItem, const char* title)

Sets a menu item's title, which is the string that appears in the user interface. Use this method to manage menu items whose titles change (such as 'show/hide fooWindow'), instead of inserting and removing menu items on the fly.

Parameters

	`menuItem` —	IN/OUT The menu item whose title is set.

	`title` —	IN/OUT The new menu title. It must be a `NULL`-terminated string.

See Also

AVMenuItemGetTitle
AVMenuItemGetName

Since

PI_ACROVIEW_VERSION >= 0x00020000

File: AVProcs.h

Line: 1840

AVMenuItemSetTitleWithASText

()

Product availability: Acrobat, Reader

Platform availability: Macintosh, Windows, UNIX

Syntax





void AVMenuItemSetTitleWithASText(AVMenuItem menuItem, ASConstText title)

Sets a menu item's title, which is the string that appears in the user interface, from a constant text object. Use this method to manage menu items whose titles change (such as 'show/hide fooWindow'), instead of inserting and removing menu items on the fly.

Parameters

	`menuItem` —	The menu item whose title is set.

	`title` —	The new menu title, as a constant text object.

Since

PI_ACROVIEW_VERSION >= 0x00060000

File: AVProcs.h

Line: 8247

Acrobat API Reference	All Layers \| All Objects \| Index \| Samples \| Frames No Frames
AVMenuItem	Typedefs \| Callbacks \| Methods

Layer	AV_Layer
Object	AVMenuItem