Click or drag to resize

BasicNoUIObjMacroCaption Method

Returns a macro/module's caption.

Namespace: WinWrap.Basic.Server
Assembly: WinWrap.Basic.Server (in WinWrap.Basic.Server.dll)
Syntax
public string MacroCaption(
	string fileName
)

Parameters

fileName  String
Return the caption for this macro/module. If this is a null string, use the value of the FileName property as the file name.

Return Value

String
The caption for this macro/module.

Implements

IBasicNoUIMacroCaption(String)
Remarks
This is the caption displayed by the IDE for the file name.

Macro/Module Paths

Macro/module paths are typically file paths. However, it is sometimes useful to work with macros/modules that are not stored as files. A macro/module path is of the form:

C#
[*[*]]path[*]
Part Description
'*' Paths that being with '*' are non-file system macro/modules. The application provides the methods for reading and writing these files. Paths that begin and end with '*' are hidden from the IDE. User's can't step into or otherwise inspect the contents.
'**' Paths that begin with '**' are non-file system modules. The application provides the methods for reading and writing these files. Running an event-driven module loads it using LoadModule.
path This is the identity of the macro/module.

Example
Print the active sheet's macro caption:
Debug.WriteLine(basicIdeCtl1.MacroCaption(""));
See Also