Abrufen oder Festlegen des Betreffs, wenn Sie einen Termin oder eine Nachricht in Outlook verfassenGet or set the subject when composing an appointment or message in Outlook

Die JavaScript-API für Office stellt asynchrone Methoden (subject.getAsync und subject.setAsync) zum Abrufen und Festlegen des Betreffs eines Termins oder einer Nachricht bereit, die der Benutzer erstellt. Diese asynchronen Methoden sind nur in Erstellungs-Add-Ins verfügbar. Vergewissern Sie sich, dass Sie das Add-In-Manifest entsprechend für Outlook eingerichtet haben, damit das Add-In in Erstellformularen aktiviert wird.The JavaScript API for Office provides asynchronous methods (subject.getAsync and subject.setAsync) to get and set the subject of an appointment or message that the user is composing. These asynchronous methods are available only to compose add-ins. To use these methods, make sure you have set up the add-in manifest appropriately for Outlook to activate the add-in in compose forms.

Die Eigenschaft subject ist für einen Lesezugriff sowohl in Erstell- als auch in Leseformularen für Termine und Nachrichten verfügbar. In einem Leseformular greifen Sie auf die Eigenschaft direkt aus dem übergeordneten Objekt zu, wie in:The subject property is available for read access in both compose and read forms of appointments and messages. In a read form, you can access the property directly from the parent object, as in:

item.subject

Da der Benutzer und Ihr Add-In in einem Erstellformular jedoch gleichzeitig den Betreff einfügen oder ändern können, müssen Sie die asynchrone Methode getAsync verwenden, um den Betreff abzurufen, siehe unten:But in a compose form, because both the user and your add-in can be inserting or changing the subject at the same time, you must use the asynchronous method getAsync to get the subject, as shown below:

item.subject.getAsync

Die Eigenschaft subject ist für einen Schreibzugriff nur in Entwurfsvorlagen, und nicht in Leseformularen, verfügbar.The subject property is available for write access in only compose forms and not in read forms.

Wie die meisten asynchronen Methoden in der JavaScript-API für Office verwenden getAsync und setAsync optionale Eingabeparameter. Weitere Informationen zum Festlegen dieser optionalen Eingabeparameter finden Sie unter „Übergeben optionaler Parameter an asynchrone Methoden“ in Asynchrone Programmierung in Office-Add-Ins.As with most asynchronous methods in the JavaScript API for Office, getAsync and setAsync take optional input parameters. For more information about specifying these optional input parameters, see "Passing optional parameters to asynchronous methods" in Asynchronous programming in Office Add-ins.

Betreff abrufenTo get the subject

In diesem Abschnitt sehen Sie das Beispiel eines Codes, der den Betreff des/der vom Benutzer erstellten Termins/Nachricht abruft und den Betreff anzeigt. Bei diesem Codebeispiel wird von einer Regel im Add-In-Manifest ausgegangen, die das Add-In in einer Entwurfsvorlage für einen Termin/eine Nachricht aktiviert, wie unten dargestellt.This section shows a code sample that gets the subject of the appointment or message that the user is composing, and displays the subject. This code sample assumes a rule in the add-in manifest that activates the add-in in a compose form for an appointment or message, as shown below.

<Rule xsi:type="RuleCollection" Mode="Or">
  <Rule xsi:type="ItemIs" ItemType="Appointment" FormType="Edit"/>
  <Rule xsi:type="ItemIs" ItemType="Message" FormType="Edit"/>
</Rule>

Wenn Sie item.subject.getAsync verwenden möchten, stellen Sie eine Rückrufmethode bereit, die den Status und das Ergebnis des asynchronen Aufrufs prüft. Sie können beliebige Argumente für die Rückrufmethode über die optionalen asyncContext-Parameter bereitstellen. Sie rufen Status, Ergebnisse und etwaige Fehler über den asyncResult-Ausgabeparameter des Rückrufs ab. Ist der asynchrone Aufruf erfolgreich, erhalten Sie über die Eigenschaft AsyncResult.value den Betreff als einfache Textzeichenfolge.To use item.subject.getAsync, provide a callback method that checks for the status and result of the asynchronous call. You can provide any necessary arguments to the callback method through the asyncContext optional parameter. You can obtain status, results and any error using the output parameter asyncResult of the callback. If the asynchronous call is successful, you can get the subject as a plain text string using the AsyncResult.value property.

var item;

Office.initialize = function () {
    item = Office.context.mailbox.item;
    // Checks for the DOM to load using the jQuery ready function.
    $(document).ready(function () {
        // After the DOM is loaded, app-specific code can run.
        // Get the subject of the item being composed.
        getSubject();
    });
}

// Get the subject of the item that the user is composing.
function getSubject() {
    item.subject.getAsync(
        function (asyncResult) {
            if (asyncResult.status == Office.AsyncResultStatus.Failed){
                write(asyncResult.error.message);
            }
            else {
                // Successfully got the subject, display it.
                write ('The subject is: ' + asyncResult.value);
            }
        });
}

// Write to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Betreff festlegenTo set the subject

In diesem Abschnitt sehen Sie das Beispiel eines Codes, der den Betreff des/der vom Benutzer erstellten Termins/Nachricht festlegt. Ähnlich wie im vorherigen Beispiel geht dieses Codebeispiel von einer Regel im Add-In-Manifest aus, die das Add-In in einer Entwurfsvorlage für einen Termin/eine Nachricht aktiviert.This section shows a code sample that sets the subject of the appointment or message that the user is composing. Similar to the previous example, this code sample assumes a rule in the add-in manifest that activates the add-in in a compose form for an appointment or message.

Wenn Sie item.subject.setAsync verwenden möchten, geben Sie eine Zeichenfolge mit bis zu 255 Zeichen in den Datenparameter ein. Sie können auch eine Rückrufmethode und Argumente für die Rückrufmethode im asyncContext-Parameter bereitstellen. Prüfen Sie Status, Ergebnis und etwaige Fehlermeldungen im asyncResult-Ausgabeparameter des Rückrufs. Ist der asynchrone Aufruf erfolgreich, fügt setAsync die angegebene Betreffzeichenfolge als einfachen Text ein, der einen vorhandenen Betreff zu diesem Element überschreibt.To use item.subject.setAsync, specify a string of up to 255 characters in the data parameter. Optionally, you can provide a callback method and any arguments for the callback method in the asyncContext parameter. You should check the status, result and any error message in the asyncResult output parameter of the callback. If the asynchronous call is successful, setAsync inserts the specified subject string as plain text, overwriting any existing subject for that item.

var item;

Office.initialize = function () {
    item = Office.context.mailbox.item;
    // Checks for the DOM to load using the jQuery ready function.
    $(document).ready(function () {
        // After the DOM is loaded, app-specific code can run.
        // Set the subject of the item being composed.
        setSubject();
    });
}

// Set the subject of the item that the user is composing.
function setSubject() {
    var today = new Date();
    var subject;

    // Customize the subject with today's date.
    subject = 'Summary for ' + today.toLocaleDateString();

    item.subject.setAsync(
        subject,
        { asyncContext: { var1: 1, var2: 2 } },
        function (asyncResult) {
            if (asyncResult.status == Office.AsyncResultStatus.Failed){
                write(asyncResult.error.message);
            }
            else {
                // Successfully set the subject.
                // Do whatever appropriate for your scenario
                // using the arguments var1 and var2 as applicable.
            }
        });
}

// Write to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Siehe auchSee also