excel.worksheetaddedeventargs.yml

### YamlMime:TSType
name: Excel.WorksheetAddedEventArgs
uid: 'excel!Excel.WorksheetAddedEventArgs:interface'
package: excel!
fullName: Excel.WorksheetAddedEventArgs
summary: Provides information about the worksheet that raised the added event.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: source
    uid: 'excel!Excel.WorksheetAddedEventArgs#source:member'
    package: excel!
    fullName: source
    summary: Gets the source of the event. See `Excel.EventSource` for details.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'source: Excel.EventSource | "Local" | "Remote";'
      return:
        type: '<xref uid="excel!Excel.EventSource:enum" /> | "Local" | "Remote"'
  - name: type
    uid: 'excel!Excel.WorksheetAddedEventArgs#type:member'
    package: excel!
    fullName: type
    summary: Gets the type of the event. See `Excel.EventType` for details.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'type: "WorksheetAdded";'
      return:
        type: '"WorksheetAdded"'
  - name: worksheetId
    uid: 'excel!Excel.WorksheetAddedEventArgs#worksheetId:member'
    package: excel!
    fullName: worksheetId
    summary: Gets the ID of the worksheet that is added to the workbook.
    remarks: >-
      \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml


      async function onWorksheetAdd(event) {
          await Excel.run(async (context) => {
              console.log(
                  "Handler for worksheet onAdded event has been triggered. Newly added worksheet Id : " +
                  event.worksheetId
              );
          });
      }

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'worksheetId: string;'
      return:
        type: string