CA2433472C

CA2433472C - System and method for issuing a message to a program

Info

Publication number: CA2433472C
Application number: CA2433472A
Authority: CA
Inventors: Marcin Sawicki; Brian Michael Jones; Jeffrey C. Reynar; Edward W. Tharp
Original assignee: Microsoft Corp; Microsoft Technology Licensing LLC
Current assignee: Microsoft Corp
Priority date: 2002-06-25
Filing date: 2003-06-25
Publication date: 2013-07-30
Anticipated expiration: 2023-06-25
Also published as: JP2004133892A; US20030237049A1; KR20040002658A; JP4809577B2; CA2433472A1; CN1474271B; BR0301713A; EP1376355A2; EP1376355A3; AU2003204800A1; MXPA03005802A; KR100955751B1; AU2003204800B2; US7716676B2; CN1474271A; RU2342698C2

Abstract

Described is a mechanism for issuing a.n event notification message, from a first program to a second program, to indicate that an action occurred within the first program, where the event notification message includes a parameter that indicates that the action is one of a group of possible actions. More specifically, in an application configured to edit documents created with the eXtensible Markup Language XML, the occurrence of an XML-related action causes the event notification message to be issued. The XML-related action may be either an XML- related move action, an XML-related insert action, or an XML-related delete action. In this way, a single event notification message can be used to indicate the occurrence of three different types of actions while editing an XML document.

Description

SYSTEM AND METHOD FOR ISSUING A MESSAGE
TO A PROGRAM
Background of the Invention Software applications are gradually becoming more and more complex and powerful. What was once a simple text editor may now be a complex word processor with countless rich features, for example the ability to create Web pages or edit XML markup. As technology evolves, each software application provides more and more functionality to enhance a user's experience. In addition, many software applications now expose their native functionality to add-on applications through programmatic interfaces. For example, object oriented programming has enabled some software applications and their documents to be treated as objects. These objects publicly expose the functionality of the applications in the form of methods that may be called and properties that may be read or set to manipulate the applications or documents. These advancements have enabled programmers to develop third-party add-ons to automate tasks and functions formerly performed manually while interacting with the application. Many such add-on applications are developed in simple programming languages, such as the Visual Basic for Applications (VBA) language. These add-ons can work by calling the application's methods and properties to achieve various goals and customize the application's core functionality for a custom environment.
In addition to being able to make calls fi-om the custom code of the add-on to the core application, there is need for the custom code to be written in such a way that it actually responds to (as opposed to "initiates") calls from the application when something happens in the application itself. For example, one could want to write custom code for a word processing application, that reacts in some special way to the user's keystrokes received by the application and perhaps blocks some of them if the user is editing an area where only some types of letters are allowed. In such cases, there is need for a way for the programmer to let the application know that there is special custom code that the application should run when a given type of event occurs. Once the custom code is registered with the application, the code can now "react" in useful ways to specific events occurring within the core application, thereby extending the application's core functionality.

Summary of the Invention The present invention is directed at a mechanism for issuing an event notification message, from one fragment of code to another (which may not be part of the original code of the program but rather added by a third-party solution vendor to extend the original program's functionality). The notification message is of a specific type that indicates which of the possible events actually occurred.
For example, the notification message could be triggered by some special state that the program has entered. The event notification message could in such a case include parameters describing what the old state was, what the new state is, and a description of the reason that caused the program to enter this state. More specifically, in an application configured to edit documents created with the eXtensible Markup Language XML, the occurrence of an XML-related change of state as a result of a user-initiated action causes the event notification message to be issued.
The XML-related state change that is reported by the event could be a change in the XML-based context of the user's insertion point in a word processing application. It could be triggered by for example the user moving the insertion point out of one XML element and into another. Or it could be triggered when the user inserts a new XML element around the selection. Or it could be triggered when the user deletes the XML element that currently surrounds the user's insertion point. In this way, a single event notification message can be used to indicate this kind of state change regardless of which of the three different user actions caused the state change while editing an XML document. It is useful for the add-on programmer to be able to write code responding to this kind of event for example in order to provide the user with context sensitive feedback, depending on where in the XML
structure the user is currently editing content. For example, when the user starts editing the contents of a <city> XML element, the custom add-on could automatically suggest a list of frequently used cities to the user. In one aspect, the invention is directed at a data structure for notifying a program of the occurrence of an XML-related action in another program (or another part of the same program).
The data structure includes an identifier indicating that an XML-related state change has occurred. The data structure also includes a plurality of parameters. One parameter is used to identify a first XML node affected by the state change, and

2 According to one aspect of the present invention, there is provided a computer-readable storage medium encoded with instructions for issuing a notification from a first program to a second program, the instructions for execution by a processor and using a data structure, the data structure comprising: an identifier field indicating that the data structure represents an occurrence of a single event related to an action performed on an XML document by the first program; a first parameter field identifying a first XML node associated with the event and contained within an XML namespace not native to the first program, wherein the first XML node corresponds to a node within which the current selection existed when performance of the action began; a second parameter field identifying a second XML node associated with the event, wherein the second XML node corresponds to a node within which the current selection will exist after the action has been performed; a third parameter field identifying a type of event that occurred, wherein the type of event is selected from one of a plurality of types of events; and a fourth parameter field identifying a current selection within the XML document, wherein the first parameter, second parameter, third parameter and fourth parameter are included in a single event message received by the second program in response to a state change caused by at least one of a plurality of actions and used to provide supplemental functionality to the first program when at least one of a plurality of actions occur.
According to another aspect of the present invention, there is provided a computer-readable storage medium having instructions stored thereon for execution by a processor, the instructions comprising: a first program code means for editing a document that includes XML nodes, at least a plurality of the XML nodes including content, the first program code means being configured to issue a single 'event notification in response to a single action being performed by the first program code means on a node contained within an XML namespace not native to the first program code means, wherein the single event notification is generated in the form of a public interface, the single action being an identified one from a plurality of types of actions; and a second program code means configured to receive the single event notification and to handle the single event notification with an event handler, the event handler including computer-3a executable instructions for responding to at least one of the plurality of types of actions, wherein the second program code means uses the single event notification to provide supplemental functionality to the first program.
According to another aspect of the present invention, there is provided a computer-readable storage medium having computer-executable instructions stored thereon, the computer-executable instructions when executed by a processor perform a method for issuing a message from a first program to a second program, the method comprising: issuing, from the first program to the second program, an event notification comprising a plurality of parameters, the event notification being indicative that a single XML-related action occurred on a first XML node contained within an XML namespace not native to the first program related to the first program, a first parameter identifying the first XML node associated with the XML-related action, a second parameter identifying a second XML node associated with the XML-related action, and a third parameter identifying one of a plurality of types of actions that corresponds to the XML-related action; wherein the second program uses the event notification to provide supplemental functionality to the first program.
According to still another aspect of the present invention, there is provided a computer-readable storage medium having computer-executable instructions stored thereon, the computer-executable instructions when executed by a processor perform a method for issuing a message from a first program to a second program, the method comprising: receiving, by the second program from the first program, comprising a plurality of parameters, the event notification being indicative that a single XML-related action occurred on a first XML node contained within an XML n.amespace not native to the first program related to the first program, a first parameter identifying the first XML node associated with the XML-related action, a second parameter identifying a second XML node associated with the XML-related action, and a third parameter identifying one of a plurality of types of actions that corresponds to the XML-related action; in response to receiving the event notification by the second program, the first parameter, the 3b second parameter, and the third parameter, providing supplemental functionality to the first program.
According to yet another aspect of the present invention, there is provided a computer-readable storage medium having computer-executable instructions stored thereon, the computer-executable instructions when executed by a processor perform a method for issuing an event notification from a first program to a second program, the method comprising: determining, in a first program, an occurrence of an action for editing a document, the document including XML nodes contained in a plurality of XML namespaces; selecting a type of action from a plurality of action types, the selected type of action correlated to the determined action; in response to the action, issuing an event notification from the first program to a second program, the event notification including a first parameter field identifying a first XML node contained within one of the plurality of XML namespaces not native to the first program and associated with the action, a second parameter field identifying a second XML node associated with the action, and a third parameter field identifying the selected type of the action and used by the second program to provide supplemental functionality to the first program.
According to yet another aspect of the present invention, there is provided a computer-readable storage medium having instructions stored thereon for issuing a notification from a first program to a second program, the instructions for execution by a processor and comprising: a notification issuer configured as part of the first program to issue an event notification in response to determining that an event occurred, the event being associated with action performed by the first program on an Extensible Markup Language (XML) document, irrespective of a type of the action, wherein the event notification comprises a data structure, the data structure comprising: an identifier field indicating that the data structure represents an occurrence of the action performed on the XML document by the first program, a first parameter field identifying a current selection within the XML
document, a second parameter field identifying a first XML node associated with the event and contained within an XML namespace not native to the first program, wherein the first XML node corresponds to a first associated node within which the 3c current selection existed when performance of the action began, a third parameter field identifying a second XML node associated with the event, wherein the second XML node corresponds to a second associated node within which the current selection will exist after the action has been performed, and a fourth parameter field identifying a type of the event that occurred, wherein the type of the event is selected from one of a plurality of event types; and a single event handler, associated with the second program, configured to receive the event notification irrespective of which of a plurality of actions caused the event notification to be sent, wherein the first parameter, the second parameter, the third parameter, and the fourth parameter are included in the event notification received by the second program in response to a state change caused by at least one of the plurality of actions and used to provide supplemental functionality to the first program when the at least one of the plurality of actions occurs.
According to yet another aspect of the present invention, there is provided a computer-readable storage medium having instructions stored thereon for execution by a processor, the instructions comprising: a first program code means for editing a document that includes a plurality of Extensible Markup Language (XML) nodes, wherein at least a portion of the plurality of XML nodes include content; a notification issuing means configured as part of the first program code means to issue a single event notification in response to determining that an event occurred, the event being associated with an action performed by the first program code means on a corresponding node containing an XML namespace not native to the first program code means, wherein the single event notification is irrespective of a type of the action and comprises a plurality of parameters, the plurality of parameters comprising: a first parameter identifying the first XML node associated with the XML-related action, a second parameter identifying a second XML node associated with the XML-related action, and a third parameter identifying one of a plurality of action types that corresponds to the XML-related action; and a second program code means configured to receive the single event notification and to handle the single event notification with an event handler, the event handler including computer-executable instructions for receiving the single event notification at the event handler regardless of which of a 3d plurality of action types caused the single event notification to be issued and responding to each of the plurality of action types, wherein the second program uses the single event notification to provide supplemental functionality to the first program.
According to yet another aspect of the present invention, there is provided a computer-readable storage medium which stores a set of instructions which when executed performs a method for issuing a message from a first program to a second program, the method executed by the set of instructions comprising: issuing by a notification issuer configured as part of the first program, from the first program to the second program, an event notification in response to determining that an event associated with a single Extensible Markup Language (XML) related action occurred on a first XML node contained within an XML
namespace not native to the first program related to the first program, the event notification being irrespective of a type of the action and having a plurality of parameters, the plurality of parameters comprising: a first parameter identifying the first XML node associated with the XML-related action, a second parameter identifying a second XML node associated with the XML-related action, and a third parameter identifying one of a plurality of action types that corresponds to the XML-related action; wherein the second program uses the event notification to provide supplemental functionality to the first program; and receiving the event notification comprising the plurality of parameters, by the second program from the first program, wherein the second program is configured to receive the event notification by a single event handler irrespective of which of the plurality of action types caused the event message to be sent and respond to the received event notification by providing supplemental functionality to the first program.
According to yet another aspect of the present invention, there is provided a method for issuing an event notification from a first program to a second program, the method comprising: determining, in the first program, an occurrence of an action for editing a document, the document including Extensible Markup Language (XML) nodes contained in a plurality of XML namespaces;
selecting a type of action from a plurality of action types, the selected type of 3e action correlated to the determined action; in response to the occurred action, irrespective of the type of action, issuing an event notification, by a notification issuer configured as part of the first program, from the first program to a second program, the event notification including a first parameter field identifying a first XML node contained within one of the plurality of XML namespaces not native to the first program and associated with the action, a second parameter field identifying a second XML node associated with the action, and a third parameter field identifying the selected type of the action and used by the second program to provide supplemental functionality to the first program; and receiving, by the second program, the event notification, wherein the second program comprises a single event handler configured to receive the event notification irrespective of which of the plurality of action types caused the event notification to be issued.
3f Brief Description of the Drawings FIGURE 1 is a functional block diagram of a computing environment in which implementations of the present invention may be embodied.
FIGURE 2 is a functional block diagram overview of software applications that expose and use a public interface, in accordance with one embodiment of the present invention.
FIGURE 3 is a logical representation of one implementation of an event notification message that may be employed in one embodiment of the present invention.
FIGURE 4 is a graphical representation of what a display may look like presented by a software application allowing an XML document to be edited, in accordance with one embodiment of the invention.
FIGURE 5 is a graphical representation of what another display may look like presented by the software application allowing the XML document to be further edited, in accordance with one embodiment of the invention.
FIGURE 6 is a graphical representation of what still another display may look like presented by the software application allowing the XML document to be edited further still, in accordance with one embodiment of the invention.
Illustrative Computing Environment of the Invention FIGURE 1 illustrates an exemplary computing device that may be included in various forms in systems implementing the invention. In a very basic configuration, computing device 100 typically includes at least one processing unit 102 and system memory 104. Processing unit 102 inc [udes existing physical processors, those in design, multiple processors acting together, virtual processors, and any other device or software program capable of interpreting binary executable instructions. Depending on the exact configuration and type of computing device, system memory 104 may be volatile (such as RAM), non-volatile (such as ROM, flash memory, etc.) or some combination of the two. System memory 104 typically includes an operating system 105, one or more program modules 106, and may include program data 107. This basic configuration is illustrated in FIGURE 1 by those components within dashed line 108.

Computing device 100 may also have additional features or functionality. For example, computing device 100 may also include additional data storage devices (removable and/or non-removable) such as, for example, magnetic disks, optical disks, or tape. Such additional storage is illustrated in FIGURE 1 by removable storage 109 and non-removable storage 110. Computer storage media may include volatile and nonvolatile, removable and non-removable media implemented in any method or technology for storage of information, such as computer readable instructions, data structures, program modules or other data.
System memory 104, removable storage 109 and non-removable storage 110 are all examples of computer storage media. Computer storage media includes, but is not limited to, RAM, ROM, EEPROM, flash memory or other memory technology, CD-ROM, digital versatile disks (DVD) or other optical storage, magnetic cassettes, magnetic tape, magnetic disk storage or other magnetic storage devices, or any other medium which can be used to store the desired information and which can be accessed by computing device 100. Any such computer storage media may be part of device 100. Computing device 100 may also have input device(s) 112 such as keyboard, mouse, pen, voice input device, touch input device, etc. Output device(s) 114 such as a display, speakers, printer, etc. may also be included. All these devices are known in the art and need not be discussed at length here.
Computing device 100 may also contain communications connection(s) 116 that allow the device to communicate with other computing devices 118, such as over a network. Communications connection(s) 116 is an example of communication media. Communication media typically embodies computer readable instructions, data structures, program modules or other data in a modulated data signal such as a carrier wave or other transport mechanism and includes any information delivery media. The term "modulated data signal"
means a signal that has one or more of its characteristics set or changed in such a manner as to encode information in the signal. By way of example, and not limitation, communication media includes wired media such as a wired network or direct-wired connection, and wireless media such as acoustic, RF, infrared and other wireless media. The term computer readable media as used herein includes both storage media and communication media.

Detailed Description of Embodiments of the Invention The invention enables a software application, such as a word processor, to issue a single type of message, including parameters that refine the message, to notify another application of the occurrence of an state change, even if the state change could be caused by different user actions. More specifically, a software application that allows the editing of eXtensible Markup Language (XML) documents exposes certain functionality to other software applications. This functionality may be related to editing particular markup tags or content.
Developers of add-ons to the software application may rely on being informed of certain markup-editing actions. To that end, the software application exposes notifications of these actions. In accordance with the invention, the software application is configured to issue a notification of more than one action by issuing a single "event" message. In one implementation, the single event message may be operative to indicate the state change resulting from the occurrence of one of three separate actions. First, the single event may be issued in response to an element being deleted that a current selection was inside. Second, the single event may be issued in response to an element being inserted around the current selection.
Third, the single event may be issued in response to the current selection changing from one location to another. Regardless of what the cause of the state change, the event that fires is the same, but it includes the cause for the state change among its parameters.
FIGURE 2 is a functional block diagram of a software application implementing one embodiment of the present invention to issue a single event message to another software application or program in response to the occurrence of one of a plurality of different actions. An XML document editor 201 is a software application that enables a user to create and edit XML documents, such as XML
document 202, in a freestyle editing environment. The XML document editor 201 may be a word processor specially programmed to enable XML creation and editing.
. Although described here in the context of a word processor, it will be appreciated that the invention is not limited to word processors, but in fact has equal applicability to any application capable of manipulating XML (or the like) documents, such as a spreadsheet application, a forms editor, a desktop publishing package, an e-mail editor, a code editing tool, or any other tool where user interaction with the application might result (even if unknown to the user) in an XML document being changed, just to name a few.
The XML document 202 is a file that includes XML elements and content. The XML document 202 may include elements inserted by the XML
An event generator 250 associated with the XML document editor 201 is programmed to listen for the occurrence of certain changes of state in the document as a result of certain actions, and to issue a notification of those state changes if they occur. The notification takes the form of a public interface 251 that exposes certain functionality of the XML document editor 201.
Turning briefly away from the public interface 251, another program, such as an automation component 209, is also included and is programmed to add some supplemental or automated functionality to the XML document editor 201.
In other words, the automation component 209 is a software application that may be developed to provide a user of the XML document editor 201 with some automation the event handler 275 is programmed to respond to the occurrence of particular actions directly related to editing the XML document 202.

Returning now to the interface exposed by the XML document editor 201, the inventors have deterin ined that there are three categories of actions that result in an XML context state change that is of interest to XML-related add-on software applications, such as the automation component 209. These categories include: (1) deleting an XML element surrounding a current selection point, (2) inserting a new XML element around a selection point, and (3) moving the selection point from one location to another. In addition, the case of moving the selection point from one location to another encompasses three distinct XML-relevant situations: (1) moving the selection point from within one XML element to within another XML element, (2) moving the selection point from within one XML
element to content that is not within an XML element, and (3) moving the selection point to within an XML element from content that is not within an XML element.
In the past, each of these categories of actions would have justified a separate notification, requiring the developer of the automation component 209 to learn and handle three different events. However, the inventors have determined that these particular three categories of actions are commonly handled by similar code and for similar purposes. Accordingly, a single event has been developed to notify add-on software applications of a state change in the document resulting from each of these three actions. In this way, a single event handler, such as event handler 275, may be implemented to take advantage of the functionality exposed by the XML
document editor 201. It should be noted that in this case, the term "functionality"
means functionality related to the experience of editing XML-related content or elements.
With a single event, the automation component 209 can include a single event handler 275 programmed to respond to the XML context state changes caused by each of the three categories of actions. This design simplifies the job of developing the automation component 209 without sacrificing the flexibility of handling different events. In one specific implementation, the event exposed by the public interface 251 could take substantially the form illustrated in FIGURE

3, and reproduced here:
XMLChange( Sel As Selection, OldzUILNode As XMLNode , NewXML Node As XMLNode , Reason As WdXMLChangeReason ) where each term in the instruction has the following meaning. The term "XMLChange" refers to the name of the event being exposed, the "Sel"
parameter 301 corresponds to an object representing a current selection point or selected content within an XML document being edited, the "OldXMLNode"
parameter 302 corresponds to an object representing an XML element in which the selection existed prior to completion of the pending action, the "NewXMLNode"
parameter 303 corresponds to an object representing an XML element in which the selection will exist after completion of the pending action, and the "Reason"
parameter 304 corresponds to an identifier of the category of the particular pending action that results in this XML context state change. The Reason parameter is used to identify one of the three categories of actions described above.
Accordingly, when this message is issued by the XML document editor 201, the Reason parameter passed is one of three that defines which of the three types of actions has occurred.
In order to take advantage of the event exposed by the XML
document editor 201, the event handler 275 includes a declaration that makes the event handler 275 aware of the event, and then the code to execute in response to each of the three categories of actions. What follows is pseudo code that can be used in one specific implementation to handle the event described above:
Public WithEvents oWordProc As WordProc.Application Private Sub oWordProc_XMLChange( Sel As Selection, OldXMLNode As XMLNode , NewXMLNode As XMLNode , Reason As WdXMLChangeReason ) Select Case Reason Case wdXMLChangeReasonInsert Code to execute in response to an XML insertion Case wdXMLChangeReasonDelete Code to execute in response to an XML deletion Case wdXMLChangeReasonMove Code to execute in response to moving the selection point End Select End Sub Those skilled in the art will appreciate that the above pseudo code first creates an object "oWordProc" that is of "WordProc.Application" type, where objects of type WordProc.Application are basically instantiations of the functionality made available by the software application named "WordProc." In this instance, the WordProc application corresponds to the XML document editor 201 so that the oWordProc object corresponds to an instance of the XML document editor 201.
Including the "WithEvents" statement makes the oWordProc object aware of events generated by the XML document editor 201. To that end, the subroutine named "oWordProc_XMLChange" includes code to handle the XMLChange event described above. The parameters of the handler code and the message are the same.
In this particular instance, a Select/Case construct has been used to handle each of the three reasons that the event may be raised. For instance, the statement "Case wdXMLChangeReasonInsert" may be used to handle an event fired for the reason that an XML element has been inserted around a selection. The statement "Case wdXMLChangeReasonDelete" may be used to handle an event fired for the reason that an XML element surrounding the selection has been deleted.
And the statement "Case wdXMLChangeReasonMove" may be used to handle an event fired for the reason that the selection point has moved in some way XML-relevant way. Each of these three cases will now be described with reference to FIGUREs 4 through 6.
FIGURE 4 is a graphical representation of what a display 410 may look like presented by the XML document editor 201 while allowing the XML
document 202 to be edited. As illustrated, the XML document 202 may be a resume document with several portions wrapped by XML elements. For instance, the name "John Doe" is included within a <name> element 405, which is in turn included within a <resume> element 407. An insertion point is shown at an original location 415 corresponding to content within a element 430.
While editing, a user may perfoim many actions on the XML
document 202, including moving the insertion point. For instance, during editing the insertion point may be moved from the original location 415 to a new location within the stream of text "Professor Smith." Note that this stream of text, as illustrated, is not contained within any current XML element. Accordingly, based on this action and its surrounding circumstances, an event will be raised indicating that the insertion point was moved from one XML element to content not within any XML element. In this case, a message closely resembling the event illustrated above may be issued with parameters as will now be defined.
The Sel parameter may include an object that contains a current selection. In the described example, the current selection is related to the original location 415 of the insertion point. In other words, the entire content of the 
element may be passed in the Selection object or some subset of that content if less than all the content is selected. Since the insertion point moved from within the XML element , the OldXMLNode corresponds to the particular element 430 within which the original location 415 existed. Similarly, the NewXMLNode corresponds to the XML element to which the insertion point has moved, which in this case is NULL because there is no XML element surrounding the new location 425. Finally, the Reason parameter includes an indicator that an XML-related Move action has taken place.
It should be noted that the insertion point could have been moved in the other direction (e.g., from the new location 425 to the original location 415). In that case, the XML context change event would still have been raised, although the OldXMLNode would have been NULL, and the NewXMLNode would have been the element 430. The other parameters would have been as just described.
It should be appreciated by those skilled in the art, that the creators of the word processing application are free to define which types of XML elements cause the event to fire or not. For example, application creators could decide that Move, Insert or Delete actions involving elements of some special namespace they select do not cause the event to fire, but they do if the elements are from another namespace. More specifically, application creators could decide that elements from the namespace representing the native XML schema of a ward processing application are completely invisible to the state change detector that causes the event to fire and only elements from the non-native namespaces are "watched" by the event generator 250.
FIGURE 5 is another display of the XML document 202 after further edits have been performed. First, the user may insert a new XML element around the "Professor Smith" text, thereby moving it into the <resume> element 407.
Based on these circumstances, an XML-related insert event is raised by the XML
document editor 201. Accordingly, the Sel parameter of the event includes a Selection object representing the content of the new XML element 510, the text "Professor Smith."
Since that text was not included within an XML element prior to the insert action, the OldXMLNode is NULL. The NewXMLNode identifies the new element, the <references> element 510. Finally, the reason parameter includes an identifier corresponding to an insert event.
In this example, after the user inserts the <references> element 510, the insertion point is moved from the <references> element 510 to the <objective>
element 512, thereby causing another move event to be raised. However, unlike the move event described above, the current move event corresponds to moving the insertion point from one XML element (the <references> element 510) to another XML element (the <objective> element 512). In this case, the Sel parameter of the event corresponds to the content of the <references> element 510, the text "Professor Smith." The OldXMLNode parameter identifies the <references>
element 510, and the NewXMLNode parameter identifies the <objective> element 512. And finally, the Reason parameter identifies the type of event as an XML-related move event.
FIGURE 6 is yet another display of the XML document 202 after further edits have been performed. In this situation, the user has deleted the <objective> element from around the "Rewarding employment" text 610, causing an XML-related delete event to be raised. In similar fashion to the events described above, the delete event includes a Sel parameter that identifies the "Rewarding employment" text 610 as the current selection, the <objective> element 512 (FIGURE 5) as the OldXMLNode, and the <resume> element 407 as the NewXMLNode. Finally, the Reason parameter includes an indication that an XML-related delete action has been performed.
In summary, the invention enables overloading a single event notification to indicate the occurrence of a state change resulting from plural XML-related actions in an XML editing environment. The single event notification for plural actions simplifies the task of developing add-on software applications that take advantage of functionality exposed by the XML editing environment.
The above specification, examples and data provide a complete description of the manufacture and use of the composition of the invention.
Since many embodiments of the invention can be made without departing from the spirit and scope of the invention, the invention resides in the claims hereinafter appended.

Claims

CLAIMS:

1. A computer-readable storage medium encoded with a data structure for issuing a notification from a first program to a second program, the data structure comprising:
an identifier field indicating that the data structure represents an occurrence of a single event related to an action performed on an XML document by the first program;
a first parameter field identifying a first XML node associated with the event and contained within an XML namespace not native to the first program, wherein the first XML node corresponds to a node within which the current selection existed when performance of the action began;
a second parameter field identifying a second XML node associated with the event, wherein the second XML node corresponds to a node within which the current selection will exist after the action has been performed;
a third parameter field identifying a type of event that occurred, wherein the type of event is selected from one of a plurality of types of events; and a fourth parameter field identifying a current selection within the XML
document, wherein the first parameter, second parameter, third parameter and fourth parameter are included in a single event message received by the second program in response to a state change caused by at least one of a plurality of actions and used to provide supplemental functionality to the first program when at least one of a plurality of actions occur.

2. The computer-readable medium of claim 1, wherein the plurality of types of events is selected from a group consisting of: an XML-related move action, an XML-related insert action, and an XML-related delete action.

3. The computer-readable medium of claim 2, wherein the XML-related move action comprises moving a current selection from the first XML node to the second XML node.

4. The computer-readable medium of claim 2, wherein the XML-related move action comprises moving a current selection from content that does not have an associated XML node to the second XML node.

5. The computer-readable medium of claim 2, wherein the XML-related move action comprises moving a current selection from the first XML node to content that does not have an associated XML node.

6. The computer-readable medium of claim 2, wherein the XML-related insert action comprises causing a current selection to be within the second XML
node.

7. The computer-readable medium of claim 2, wherein the XML-related delete action comprises deleting the first XML node such that a current selection that was within the first XML node becomes within the second XML node.

8. The computer-readable medium of claim 1, wherein the data structure is configured to be passed from the first program to the second program when performance of the action is initiated, and wherein the first, second, third, and fourth parameter fields are configured to elicit from the second program another action responsive to the single event.

9. A computer-readable storage medium having instructions stored thereon for execution by a processor, the instructions comprising:
a first program code means for editing a document that includes XML nodes, at least a plurality of the XML nodes including content, the first program code means being configured to issue a single event notification in response to a single action being performed by the first program code means on a node contained within an XML namespace not native to the first program code means, wherein the single event notification is generated in the form of a public interface, the single action being an identified one from a plurality of types of actions; and a second program code means configured to receive the single event notification and to handle the single event notification with an event handier, the event handler including computer-executable instructions for responding to at least one of the plurality of types of actions, wherein the second program code means uses the single event notification to provide supplemental functionality to the first program.

10. The computer-readable storage medium of claim 9, wherein the event handler includes computer-executable instructions for responding to each of the plurality of types of actions, and wherein the response includes causing a third program code means to perform a further action that is different from the single action.

11. The computer-readable storage medium of claim 9, wherein the plurality of types of actions comprises an XML-related move action corresponding to moving a current selection from content that does not have an associated XML
node to within an XML node.

12. The computer-readable storage medium of claim 9, wherein the plurality of types of actions comprises an XML-related move action corresponding to moving a current selection from within an XML node to content that does not have an associated XML node.

13. The computer-readable storage medium of claim 9, wherein the plurality of types of actions comprises an XML-related move action corresponding to moving a current selection from within one XML node to within another XML
node.

14. The computer-readable storage medium of claim 9, wherein the plurality of types of actions comprises an XML-related insert action corresponding to inserting an XML node around content within the document.

15. The computer-readable storage medium of claim 9, wherein the plurality of types of actions comprises an XML-related delete action corresponding to deleting an XML node from the document.

16. The computer-readable storage medium of claim 9, wherein the plurality of types of actions comprises an XML-related move action, an XML-related insert action, and an XML-related move action.

17. A computer-readable storage medium having computer-executable instructions stored thereon, the computer-executable instructions when executed by a processor perform a method for issuing a message from a first program to a second program, the method comprising:
issuing, from the first program to the second program, an event notification comprising a plurality of parameters, the event notification being indicative that a single XML-related action occurred on a first XML node contained within an XML namespace not native to the first program related to the first program, a first parameter identifying the first XML node associated with the XML-related action, a second parameter identifying a second XML node associated with the XML-related action, and a third parameter identifying one of a plurality of types of actions that corresponds to the XML-related action; wherein the second program uses the event notification to provide supplemental functionality to the first program.

18. A computer-readable storage medium having computer-executable instructions stored thereon, the computer-executable instructions when executed by a processor perform a method for issuing a message from a first program to a second program, the method comprising:
receiving, by the second program from the first program, comprising a plurality of parameters, the event notification being indicative that a single XML-related action occurred on a first XML node contained within an XML namespace not native to the first program related to the first program, a first parameter identifying the first XML node associated with the XML-related action, a second parameter identifying a second XML node associated with the XML-related action, and a third parameter identifying one of a plurality of types of actions that corresponds to the XML-related action;

in response to receiving the event notification by the second program, the first parameter, the second parameter, and the third parameter, providing supplemental functionality to the first program.

19. A computer-readable storage medium having computer-executable instructions stored thereon, the computer-executable instructions when executed by a processor perform a method for issuing an event notification from a first program to a second program, the method comprising:
determining, in a first program, an occurrence of an action for editing a document, the document including XML nodes contained in a plurality of XML
namespaces;
selecting a type of action from a plurality of action types, the selected type of action correlated to the determined action;
in response to the action, issuing an event notification from the first program to a second program, the event notification including a first parameter field identifying a first XML node contained within one of the plurality of XML
namespaces not native to the first program and associated with the action, a second parameter field identifying a second XML node associated with the action, and a third parameter field identifying the selected type of the action and used by the second program to provide supplemental functionality to the first program.

20. The computer-readable storage medium of claim 19, wherein the selected type of action comprises a delete action type if the determined action includes a deletion of an XML node from the document.

21. The computer-readable storage medium of claim 20, wherein the selected type of action comprises an XML-related insert action type if the determined action includes an insertion of an XML node around content within the document.

22. The computer-readable storage medium of claim 21, wherein the selected type of action comprises an XML-related move action type if the determined action includes at least one from a set of: movement of a current selection from content that does not have an associated XML node to within an XML node, movement of a current selection from within an XML node to content that does not have an associated XML node, and movement of a current selection from within one XML node to within another XML node.

23. The computer-readable storage medium of claim 22, wherein the second program includes a 'macro' application that provides automated functionality in the first program.

24. The computer-readable storage medium of claim 19, wherein the supplemental functionality includes providing a user interface to invoke a process external to the first program.

25. A computer-readable storage medium having instructions stored thereon for issuing a notification from a first program to a second program, the instructions for execution by a processor and comprising:
a notification issuer configured as part of the first program to issue an event notification in response to determining that an event occurred, the event being associated with action performed by the first program on an Extensible Markup Language (XML) document, irrespective of a type of the action, wherein the event notification comprises a data structure, the data structure comprising:
an identifier field indicating that the data structure represents an occurrence of the action performed on the XML document by the first program, a first parameter field identifying a current selection within the XML
document, a second parameter field identifying a first XML node associated with the event and contained within an XML namespace not native to the first program, wherein the first XML node corresponds to a first associated node within which the current selection existed when performance of the action began, a third parameter field identifying a second XML node associated with the event, wherein the second XML node corresponds to a second associated node within which the current selection will exist after the action has been performed, and a fourth parameter field identifying a type of the event that occurred, wherein the type of the event is selected from one of a plurality of event types; and a single event handler, associated with the second program, configured to receive the event notification irrespective of which of a plurality of actions caused the event notification to be sent, wherein the first parameter, the second parameter, the third parameter, and the fourth parameter are included in the event notification received by the second program in response to a state change caused by at least one of the plurality of actions and used to provide supplemental functionality to the first program when the at least one of the plurality of actions occurs.

26. The computer-readable storage medium of claim 25, wherein the plurality of event types are selected from a group comprising an XML-related move action, an XML-related insert action, and an XML-related delete action.

27. The computer-readable storage medium of claim 26, wherein the XML-related move action comprises moving the current selection from the first XML node to the second XML node.

28. The computer-readable storage medium of claim 26, wherein the XML-related move action comprises moving the current selection from content that does not have an associated XML node to the second XML node.

29. The computer-readable storage medium of claim 26, wherein the XML-related move action comprises moving the current selection from the first XML node to content that does not have an associated XML node.

30. The computer-readable storage medium of claim 26, wherein the XML-related insert action comprises causing the current selection to be within the second XML node.

31. The computer-readable storage medium of claim 26, wherein the XML-related delete action comprises deleting the first XML node such that the current selection that was within the first XML node becomes within the second XML node.

32. The computer-readable storage medium of claim 25, wherein the data structure is configured to be passed from the first program to the second program when performance of the action is initiated, and wherein the first parameter, the second parameter, the third parameter, and the fourth parameter fields are configured to elicit from the second program another action responsive to the single event.

33. A computer-readable storage medium having instructions stored thereon for execution by a processor, the instructions comprising:
a first program code means for editing a document that includes a plurality of Extensible Markup Language (XML) nodes, wherein at least a portion of the plurality of XML nodes include content;
a notification issuing means configured as part of the first program code means to issue a single event notification in response to determining that an event occurred, the event being associated with an action performed by the first program code means on a corresponding node containing an XML namespace not native to the first program code means, wherein the single event notification is irrespective of a type of the action and comprises a plurality of parameters, the plurality of parameters comprising:
a first parameter identifying the first XML node associated with the XML-related action, a second parameter identifying a second XML node associated with the XML-related action, and a third parameter identifying one of a plurality of action types that corresponds to the XML-related action; and a second program code means configured to receive the single event notification and to handle the single event notification with an event handler, the event handler including computer-executable instructions for receiving the single event notification at the event handler regardless of which of a plurality of action types caused the single event notification to be issued and responding to each of the plurality of action types, wherein the second program code means uses the single event notification to provide supplemental functionality to the first program code means.

34. The computer-readable storage medium of claim 33, wherein the event handler further includes computer-executable instructions for responding to each of the plurality of action types, and wherein the response includes causing a third program code means to perform a further action that is different from the performed action.

35. The computer-readable storage medium of claim 33, wherein the plurality of action types comprise an XML-related move action corresponding to moving a current selection from content that does not have an associated XML
node to within an XML node.

36. The computer-readable storage medium of claim 33, wherein the plurality of action types comprise an XML-related move action corresponding to moving a current selection from within an XML node to content that does not have an associated XML node.

37. The computer-readable storage medium of claim 33, wherein the plurality of action types comprise an XML-related move action corresponding to moving a current selection from within one XML node to within another XML
node. .

38. The computer-readable storage medium of claim 33, wherein the plurality of action types comprise an XML-related insert action corresponding to inserting an XML node around content within the document.

39. The computer-readable storage medium of claim 33, wherein the plurality of action types comprise an XML-related delete action corresponding to deleting an XML node from the document.

40. The computer-readable storage medium of claim 33, wherein the plurality of action types comprise an XML-related move action, an XML-related insert action, and an XML-related move action.

41. A computer-readable storage medium which stores a set of instructions which when executed performs a method for issuing a message from a first program to a second program, the method executed by the set of instructions comprising.
issuing by a notification issuer configured as part of the first program, from the first program to the second program, an event notification in response to determining that an event associated with a single Extensible Markup Language (XML) related action occurred on a first XML node contained within an XML namespace not native to the first program related to the first program, the event notification being irrespective of a type of the action and having a plurality of parameters, the plurality of parameters comprising:
a first parameter identifying the first XML node associated with the XML-related action, a second parameter identifying a second XML node associated with the XML-related action, and a third parameter identifying one of a plurality of action types that corresponds to the XML-related action; wherein the seCond program uses the event notification to provide supplemental functionality to the first program;
and receiving the event notification comprising the plurality of parameters, by the second program from the first program, wherein the second program is configured to receive the event notification by a single event handler irrespective of which of the plurality of action types caused the event message to be sent and respond to the received event notification by providing supplemental functionality to the first program.

42. A method for issuing an event notification from a first program to a second program, the method comprising:
determining, in the first program, an occurrence of an action for editing a document, the document including Extensible Markup Language (XML) nodes contained in a plurality of XML namespaces;
selecting a type of action from a plurality of action types, the selected type of action correlated to the determined action;
in response to the occurred action, irrespective of the type of action, issuing an event notification, by a notification issuer configured as part of the first program, from the first program to a second program, the event notification including a first parameter field identifying a first XML node contained within one of the plurality of XML namespaces not native to the first program and associated with the action, a second parameter field identifying a second XML node associated with the action, and a third parameter field identifying the selected type of the action and used by the second program to provide supplemental functionality to the first program; and receiving, by the second program, the event notification, wherein the second program comprises a single event handler configured to receive the event notification irrespective of which of the plurality of action types caused the event notification to be issued.

43. The method of claim 42, wherein the selected type of action comprises a delete action type if the determined action includes a deletion of at least one of XML nodes from the document.

44. The method of claim 43, wherein the selected type of action comprises an XML-related insert action type if the determined action includes an insertion of at least one of XML nodes around content within the document.

45. The method of claim 44, wherein the selected type of action comprises an XML-related move action type if the determined action includes at least one from a set of: movement of a current selection from content that does not have an associated XML node to within at least one of XML nodes, movement of the current selection from within the at least one of XML nodes to content that does not have an associated XML node, and movement of the current selection from within a first one of the XML nodes to within a second one of the XML
nodes.

46. The method of claim 45, wherein the second program includes a 'macro' application that provides automated functionality in the first program.

47. The method of claim 42, wherein the supplemental functionality includes providing a user interface to invoke a process external to the first program.