EntryMacro Class

Script Function to Execute on Form Field Entry.When the object is serialized out as xml, its qualified name is w:entryMacro.

Inheritance Hierarchy


Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)


Public Class EntryMacro _
    Inherits MacroNameType
Dim instance As EntryMacro
public class EntryMacro : MacroNameType


[ISO/IEC 29500-1 1st Edition]

17.16.10 entryMacro (Script Function to Execute on Form Field Entry)

This element specifies a subroutine in a scripting language which should be executed when the when the run contents of the parent form field are entered. The language and location of this subroutine can be determined using any method desired by an application. [Note: It is at the discretion of an application to determine the scope and timing of "entering" a form field, for example, when the user moves the insertion point in a user interface or upon each operation by an application without a user interface, etc. end note]

If this element is omitted, then no subroutine shall be associated with entering the run contents of the parent form field. If this element specifies a macro which cannot be located or is not supported by an application, then its value can be ignored, but shall not be lost upon resaving the file.

[Example: Consider the following WordprocessingML fragment for the properties of a checkbox form field:

<w:entryMacro w:val="TestEntryFunction" />

The entryMacro element specifies that any application which processes this file should attempt to locate and execute a scripting subroutine called TestEntryFunction when the contents of the checkbox are entered. If this subroutine cannot be located or executed, then this setting is silently ignored. end example]

Parent Elements

ffData (§17.16.17)



val (Name of Script Function)

Specifies the name of a single scripting subroutine which shall be associated with the parent element. Its use is specifies based on the context of the parent XML element.

[Example: Consider the following WordprocessingML fragment for the properties of a form field:

<w:exitMacro w:val="HelloWorld" />

The val attribute specifies that a script function called HelloWorld must be used in the context of the parent element; in this case, to execute when the field is exited. end example]

The possible values for this attribute are defined by the ST_MacroName simple type (§17.18.51).

[Note: The W3C XML Schema definition of this element’s content model (CT_MacroName) is located in §A.1. end note]

© ISO/IEC29500: 2008.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also


EntryMacro Members

DocumentFormat.OpenXml.Wordprocessing Namespace