I would appreciate if in the example of delete() you also showed the proper way to delete a sheet if i'm not sure it exists. Thanks!

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: ecc449d8-02af-e5c1-9e6e-74fc9067ca62
• Version Independent ID: 6cc5351c-a26b-5d83-5b8b-df1b92ff3e3a
• Content: Excel.Worksheet class
• Content Source: docs/docs-ref-autogen/excel/excel.worksheet.yml
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

The OfficeExtension.Error object (for Word, Excel, and OneNote) has a traceMessages member, which is a string array. The Word error.md page shows an example where it creates these trace messages, by calling context.trace (short example: Word.run(function(context) { context.trace("Hello world"); })). However, reference/word/requestcontext.md contains no mention of the trace method. A search for the word "trace" reveals it to be mentioned only in the error.md pages for Word, Excel, and OneNote, and only the Word error.md page reveals how to use context.trace. I would expect this method to be documented on the requestcontext.md page also. In addition, if traceMessages is available in other applications (e.g. PowerPoint, Outlook) it should be documented on those pages as well.

The explanation for getItem(index) is: "Gets a content control by its index in the collection." And the expected data type is "number". This implies the method returns the content control at the given position in the document (first, second, etc.) Using the method in this manner returns the error "ItemNotFound: We couldn’t find the item you requested. Check the OfficeExtension.Error.debugInfo for more information." On Stack Overflow Juan B. Labra states: "getItem() works with IDs". The ID value of a content control is of type String (in the COM APIs) and it's also not an "index" value. I lost a lot of time trying to get this to work. Plesae update the documentation.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: d6b1d537-d611-5bbd-1f09-017881ea2e50
• Version Independent ID: 0a843707-89d9-1738-5693-a6d4cdf0d008
• Content: Word.ContentControlCollection class
• Content Source: docs/docs-ref-autogen/word/word.contentcontrolcollection.yml
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Office.context.mailbox.item.getSelectedRegExMatches() returns null in Outlook 2013 desktop experience while returning an expected array of one match in the web client.

Expected Behavior

Using contextual add-in, when I open the add-in in outlook 2013 desktop client, it should return the array of all the matched texts.

Current Behavior

Instead of returning the list of the matched texts, its retunring me null in Outlook 2013, though is working fine on Outlook 365 (web).

Steps to Reproduce, or Live Example

1. Extension point in Manifest file:

<ExtensionPoint xsi:type="DetectedEntity">
              <Label resid="AddIn.Title" />
              <SourceLocation resid="AddIn.WebApp" />
              <Rule xsi:type="RuleCollection" Mode="And">
                <Rule xsi:type="ItemIs" ItemType="Message" />
                <Rule xsi:type="ItemHasRegularExpressionMatch" PropertyName="BodyAsPlaintext" RegExName="BodyFilter" RegExValue="Click here to (Play|Poll|View)" Highlight="all" />
              </Rule>
</ExtensionPoint>

2. Debugged the issue with Outlook 2013 desktop client. The value returning was null, instead of the matching tests array

Context

By opening the add-in with the text match, I am trying to load up a web page.

Your Environment

• Platform [PC desktop, Mac, iOS, Office Online]: PC desktop
• Host [Excel, Word, PowerPoint, etc.]: Outlook 2013
• Office version number: 2013
• Operating System: Windows

Since Custom Functions is no longer in Preview, - Preview should be removed from the API Reference TOC node that's currently labeled Custom Functions - Preview.

[Enter feedback here]

Document Details

Retrieving the page is not required as it's not being used on the sample code

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 211bf382-30fa-d9dc-f3e3-f4705f637fc9
• Version Independent ID: 6e96ba12-0995-2aac-050a-48b7c62a4cbf
• Content: Visio.PageLoadCompleteEventArgs interface
• Content Source: docs/docs-ref-autogen/visio/visio.pageloadcompleteeventargs.yml
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

There seems to be an undocumented limit to the size of the array which can be assigned to Excel.Range.values. To demonstrate:

await Excel.run(async (context) => {
    context.application.suspendApiCalculationUntilNextSync();
    const worksheet = context.workbook.worksheets.getActiveWorksheet();
    const newValues = (new Array(2000)).fill((new Array(10)).fill('0'));
    worksheet.getRangeByIndexes(0, 0, 2000, 10).values = newValues;
    await context.sync();
});

Running this in an add-in in Excel Online (Build ID 16.0.11512.37951) will cause the API to throw RichApi.Error: An internal error has occurred. This code successfully sets the specified cell values if I change the number of rows to less than 500. I understand that I can assign a non-array string to set identical values to all cells in that range; my task involves setting different values to a range.

I am not seeing anything about limits in the API documentation or the Excel add-in concepts pages. I would appreciate it if Excel.Range.values contained info on: a way to find out the size limits for new values, and any differences to this limit for various platforms (desktop and browsers). Thank you.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: ccb771e9-3e72-94e4-751b-9178521e08fc
• Version Independent ID: 09f81d36-d60d-3b72-467f-c9335c1e91d0
• Content: Excel.Range class - Office Add-ins
• Content Source: docs/docs-ref-autogen/excel/excel.range.yml
• Product: excel
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

How would one determine if a cell has been double-clicked?
Also, How would one be able to detect a right-click event?

These seems to be missing from the API for Excel.

Is there a coding solution for the above handling of user actions that you could share?

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 75f3cb21-a7f5-6816-5915-0a9750b64b91
• Version Independent ID: 625c1438-56e6-c911-d32c-6ccf7bf135d0
• Content: Excel.WorksheetSingleClickedEventArgs interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/excel/excel.worksheetsingleclickedeventargs.yml
• Product: excel
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Hi MSFT, your API documentation is well written. Easy to follow.

Document details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: ce26535b-e975-bd31-a5e7-4a21c1ed609f
• Version Independent ID: 9b6b1592-17de-928b-e386-92dc1625c3a8
• Content: Word JavaScript API overview
• Content Source: docs/docs-ref-conceptual/overview/word-add-ins-reference-overview.md
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

missing a semicolon after this line var controlBackgroundColor = Office.context.officeTheme.controlBackgroundColor in the example

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 57500af6-fb91-7a89-58aa-4c604b412bed
• Version Independent ID: f356c836-0840-558e-121e-4b68d7b3d741
• Content: Office.OfficeTheme interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/office/office.officetheme.yml
• Product: non-product-specific
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

The argument cellAddress can be an excel range. Maybe it could be nice to specify that the range object must be a singular cell. Cheers

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 8de5a350-77d5-9694-63a0-e5e1160b171a
• Version Independent ID: bb8eaed0-6d9c-b1ef-2607-7bcea4211681
• Content: Excel.CommentCollection class - Office Add-ins
• Content Source: docs/docs-ref-autogen/excel/excel.commentcollection.yml
• Product: excel
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Hi Office.js team,
This interface is really clear and I can understand definition, but let me share feedback for better developer experience. If the document provide error code table, developers can consider and write better conditional statements. Currently we don't have any info about what number is passed through code property.

Fortunately and unfortunately, I've never seen error in my environment and hard to see what happen and to decide conditional statement. Would you please consider to provide error table like Microsoft Graph document?
https://docs.microsoft.com/en-us/graph/errors

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: f99ea712-014b-8562-5a76-7ed4a409f11f
• Version Independent ID: e64fa016-f63f-69c9-2751-a3cacc11b1fe
• Content: Office.Error interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/office/office.error.yml
• Product: non-product-specific
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Property description for controlForegroundColor reads "Gets the Office theme body control color as a hexadecimal color triplet (e.g. "FFA500")" where it should read "...control foreground color..." striking "body."

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 57500af6-fb91-7a89-58aa-4c604b412bed
• Version Independent ID: f356c836-0840-558e-121e-4b68d7b3d741
• Content: Office.OfficeTheme interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/office/office.officetheme.yml
• Product: non-product-specific
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

The documentation on this page for the title property indicates it is read only. It isn't.

This code runs fine chart.axes.valueAxis.title.text = "Title"; //Excel API 1.1

It would seem useless if it were really read only.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 2e6384df-0fcf-23ab-8882-3722703f9d50
• Version Independent ID: 82a4bb65-e904-31ac-c4e2-8104a07f210c
• Content: Excel.ChartAxis class - Office Add-ins
• Content Source: docs/docs-ref-autogen/excel/excel.chartaxis.yml
• Product: excel
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

GetAsync() returns a string, not the object it was called on.

callback?: (result: AsyncResult<Office.Body>)
Should be:
``callback?: (result: AsyncResult<string>)````
for all getAsync() methods

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 076f70b1-5d37-89d9-b6d1-a249b85506ee
• Version Independent ID: 347c34b6-0586-9ce5-2c84-ae010c27b276
• Content: Office.Body interface
• Content Source: docs/docs-ref-autogen/outlook/office.body.yml
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Currently there's no toc.yml file in the overview folder, which results in there being no TOC, breadcrumbs, or "PDF download" link displayed when the Overview page is loaded without the view parameter in the URL.

We should add a toc.yml file to the overview folder (just as there's a toc.yml file in every other docs-ref-autogen subfolder). Maybe just have it contain a link to the Preview or otherwise newest (where there's no Preview) docs page for each host?

Adding this toc.yml file will eliminate a few errors in the CATS report. Not urgent, but we should do it when we can find time.

Not the color of the border line.
It's the background color.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 9091b50e-16b8-50b1-f1b3-b6768504a77d
• Version Independent ID: 2d71a29a-195e-6b85-ae11-25ebe2e09e70
• Content: Excel.RangeFill class - Office Add-ins
• Content Source: docs/docs-ref-autogen/excel/excel.rangefill.yml
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Hello,

I was trying to use below code.

Office.context.mailbox.removeHandlerAsync(Office.EventType.ItemChanged, loadNewItem, function (result) {
      if (result.status === Office.AsyncResultStatus.Failed) {
        console.log("event failed");
      }
    });
function loadNewItem(eventArgs) {
  // Load the properties of the newly selected item
  console.log("event changed");
}

It is throwing me parameter mismatch error.

outlook-web-16.01.js:9 Uncaught Error: Sys.ParameterCountException: multiple optional functions in parameter list
at Function.Error.create (MicrosoftAjax.js:5)
at Function.Error.parameterCount (MicrosoftAjax.js:5)
at c (outlook-web-16.01.js:9)
at OSF.DDA.AsyncMethodCall.verifyAndExtractCall (outlook-web-16.01.js:9)
at f.(lab5228.lab.pega.com/prweb/OutlookAddIn/aDksxW2FqLyskV_TGzmXXSRT2XjlmHkP*/anonymous function) (https://appsforoffice.microsoft.com/lib/1.1/hosted/outlook-web-16.01.js:9:73976)
at window.OSF.DDA.OutlookAppOm.u.DDA.OutlookAppOm.value [as removeHandlerAsync] (outlook-web-16.01.js:9)
at revokeAsyncHandler (outlookaddin_1955471633.js!sfaoutlookaddin_13410501646.js!crm_ui_harnessactions_13285258855.js!!.js:1342)
at :1:1

Can some one let me know whether removeHandlerAsync usage is proper or not. Is it documented wrong in Office API doc?

The hostname field states that:
A string that can be one of the following values: Outlook, Mac Outlook, OutlookIOS, or OutlookWebApp.

This is not the case.

• When running Outlook on a Mac, the value returned is Outlook, not Mac Outlook. This is has been the case since 1.0
• Additionally, it can return OutlookAndroid.

I propose you change to:
A string that can be one of the following values: Outlook, OutlookAndroid, OutlookIOS, or OutlookWebApp.

This was already brought up in issue #462 (resolved via #467) but I cannot see the changes on this page, which looks to be a new URL compared to when I added the original issues.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: d70e0ab2-3c47-50e6-7c74-13c7ad17a28a
• Version Independent ID: fe7e0914-4be1-1b8c-d173-6a3329caf82e
• Content: Office.Mailbox interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/outlook_1_7/outlook/office.mailbox.yml
• Product: outlook
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Would love to see an option to export individual or more PowerPoint slides to images (for example base64 or png).

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 4bf6ede3-db30-be96-0de6-d4e429d83bd1
• Version Independent ID: 62cb7f3a-1e7b-064e-93eb-09a3f57f0e81
• Content: Office.FileType enum
• Content Source: docs/docs-ref-autogen/office/office.filetype.yml
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

At the bottom on each shared api page is that grid that shows "Supported hosts, by platform". This has been there from the beginning but I'm not sure it makes a lot of sense any longer:

• It is often out of date (most recently, issue #1089).
• The Add-in Availability page provides the a superior view of the same data.
• The grid of platforms is comically out of date, ignoring Office 2016 for Mac and continuing to reference OWA for Devices .

It seems like this boilerplate could simply be replaced with a link to the Add-in Availability page. For the handful of methods that have an edge constraints (i.e. support on platform x is slightly different from the other platforms), this could be continue to live within the overall "Support details" section.

this is a tooling bug and may result from additional parameters being added without these parameters being supported. Versioning must be done at the function level since there can be multiple versions of the same function.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: e082532e-3f42-b930-bd53-fa87e3fe6897
• Version Independent ID: 0eac380f-f840-ff2e-a769-f98fdf01e03c
• Content: Word.Paragraph class - Office Add-ins
• Content Source: docs/docs-ref-autogen/word/word/word.paragraph.yml
• Product: word
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

I am developing a Word add-in that utilizes ContentControl.insertParagraph and ContentControl.placeholderText. According to the documentation, these methods are provided by WordApi requirement set 1.1, which is supported in Office Online.

When I run the add-in in Word 2016 desktop client, everything works fine,
but when I run it in the Word Online , it fails with the following exceptions:

code:"NotAllowed"
errorLocation:"ContentControl.insertParagraph"
message:"The action isn’t supported in Word Online. Check the OfficeExtension.Error.debugInfo for more information."

code:"NotAllowed"
errorLocation:"ContentControl.placeholderText"
message:"The action isn’t supported in Word Online. Check the OfficeExtension.Error.debugInfo for more information."

my script code is:

$(function () {

    Office.initialize = function (reason) {

        // Only support Word 2016 or newer for now
        if (!Office.context.requirements.isSetSupported('WordApi', 1.1)) {
            return;
        }

        Word.run(function (context) {
	      // Load content controls in test document
	      var contentControls = context.document.contentControls;
              context.load(contentControls, 'id, items');
              return context.sync()
                   .then(function () {
                        //Update existing content control.
                        var control = contentControls.items[0];
                        //control.placeholderText = "Inserting paragraph..";
                        control.insertParagraph('Hello, ', Word.InsertLocation.start);
                        return context.sync()
                            .then(function () {
                                console.log('Success!');
                            })
                            .catch(function (error) {
                                console.log('Error: ' + JSON.stringify(error));
                                if (error instanceof OfficeExtension.Error) {
                                    console.log('Debug info: ' + JSON.stringify(error.debugInfo));
                                }
                            });
                    })
                    .catch(function (error) {
                        //Create new content control.
                        var range = context.document.getSelection();
                        var theRange = range.insertText(" ", "End");
                        var contentControl;
                        return context.sync()
			      .then(function () {
				     contentControl = theRange.insertContentControl();
				     //contentControl.placeholderText = "Inserting text..";
				     contentControl.insertParagraph('World..! ', Word.InsertLocation.start);
				     contentControl.load("id");
				     return context.sync();
		              })
                              .catch(function (error) {
                                    console.log('Error: ' + JSON.stringify(error));
                                    if (error instanceof OfficeExtension.Error) {
                                    console.log('Debug info: ' + JSON.stringify(error.debugInfo));
                                    }
                              });
                    });
          })
     };
});

I have commented the statement :-

"control.placeholderText = 'Inserting paragraph..'"

, becuase same exception is thrown for this statement as well.

Any input you could provide would be most appreciated! Thank you!

Hi,

At the end of the Visio JavaScript APIs announcement it states:

Custom solutions that you implement via the Visio JavaScript APIs will work against embedded Visio diagrams in SharePoint Online or any external web page.

However all the documentation I've found is only about embedding Visio diagrams into a SharePoint website.

So :

• Was the functionality of working with any external web page never implemented ?
  or
• The corresponding information is missing ?
  or
• I've misunderstood the blog post and "any external web page" refers to some SharePoint external web page or something (I don't know SharePoint well) ?

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 42852bf8-54dd-c45f-9a20-4c4cbbb7d8ce
• Version Independent ID: 6ad96000-9527-b58b-c6ae-1ccababa2ec7
• Content: Visio JavaScript API overview
• Content Source: docs/docs-ref-conceptual/overview/visio-javascript-reference-overview.md
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

"OSF is not defined"

Fix:
Visio.run(function(ctx)...
should be
Visio.run(session, function(ctx)...

as per this issue report OfficeDev/office-js-docs#1375

Please make the documentation more verbose, for example where to call AddHandler()

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 337c4e45-a450-dbcf-71c2-3f72c4312c64
• Version Independent ID: c3907f0f-fb6a-3436-e194-4aef1dfff43a
• Content: Visio.SelectionChangedEventArgs interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/visio/visio/visio.selectionchangedeventargs.yml
• Product: visio
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Hi
why my customtab never appear in my mac outlook 2016 client?

<ExtensionPoint xsi:type="MessageReadCommandSurface">
						<CustomTab id="myTab">
							<Group id="QuantrTab">
								<Label resid="customTabLabel" />
								<Control xsi:type="Button" id="msgReadOpenPaneButton">
									<Label resid="paneReadButtonLabel" />
									<Supertip>
										<Title resid="paneReadSuperTipTitle" />
										<Description resid="paneReadSuperTipDescription" />
									</Supertip>
									<Icon>
										<bt:Image size="16" resid="icon16" />
										<bt:Image size="32" resid="icon32" />
										<bt:Image size="80" resid="icon80" />
									</Icon>
									<Action xsi:type="ShowTaskpane">
										<SourceLocation resid="messageReadTaskPaneUrl" />
									</Action>
								</Control>
								<!-- Go to http://aka.ms/ButtonCommands to learn how to add more Controls: ExecuteFunction and Menu -->
							</Group>
							<Label resid="customTabLabel2" />
						</CustomTab>
					</ExtensionPoint>

thanks
Peter

The Clients section describes the requirement set for the platform.

I have an Exchange 2016 On-Premises installation, and I set the Requirements element to 1.5.
Regarding the documentation my addin should not be activated in the Exchange 2016 OWA.
If I use the runtime check of the supported version, it says the 1.5 version supported.

Then I tried to use the REST API from my add-in like decribed here but it didn't worked (I got 405 Method Not Allowed).

But I cannot able to use the Exchange Server REST API because it is only supported with hybrid Exchange installation.

Why the add-in activated if I cannot use it properly?
Or at least the documentation should be extended to explain this exception.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 46d8b63e-2e0c-99bd-e089-eacb33a90645
• Version Independent ID: 87e3cf4d-285b-67e8-8a3f-ff623a4bd9fa
• Content: Outlook JavaScript API requirement sets
• Content Source: docs/docs-ref-conceptual/requirement-sets/outlook-api-requirement-sets.md
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

I wish for my add-in to be notified when a message being composed in the outlook web app changes (recipients, message body, subject etc.).

I am unable to get events from Office.context.mailbox.addHandlerAsync. Am I using it correctly?

None of these seem to work.

Office.context.mailbox.addHandlerAsync(Office.EventType.ItemChanged, function(result) {
	console.log(result);
});

Office.context.mailbox.addHandlerAsync(Office.EventType.ItemChanged, function(result) {
	console.log(result);
}, { asyncContext: true },function(result) {
	console.log(result);
});

Office.context.mailbox.addHandlerAsync(Office.EventType.ItemChanged,
	function (eventArgs) {
		console.log(eventArgs);
	},
	function (result) {
		console.log(result);
	}
);

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: afd9eea6-32de-c10a-f0fc-ac6a2e234da5
• Version Independent ID: 8dca85eb-1a29-527b-c82f-7a05b293193f
• Content: mailbox
• Content Source: docs/docs-ref-conceptual/objectmodel/requirement-set-1.6/office.context.mailbox.md
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

There is an error in the sample.
Instead of
var overlayId=shape.view.addOverlay("Image", "Visio Online", "Center", "Center", 50, 50);
Tere must be

var overlayId=shape.view.addOverlay("Image", "Visio Online", "Center", "Middle",50,50);

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 3b3f19e7-3957-257a-1f22-bb0e13720c42
• Version Independent ID: 90e7943a-72a7-e8df-7cbc-c51f257c37b2
• Content: Visio.ShapeView class - Office Add-ins
• Content Source: docs/docs-ref-autogen/visio/visio.shapeview.yml
• Product: visio
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Articles:
https://github.com/OfficeDev/office-js-docs/blob/ExcelJs_OpenSpec/reference/excel/basicdatavalidation.md

and

https://github.com/OfficeDev/office-js-docs/blob/ExcelJs_OpenSpec/reference/excel/datetimedatavalidation.md

Issue:
Both of these articles have misleading descriptions for the formula1 and formula2 properties. The following would be correct for BasicDataValidation:

• formula1: Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan. (The left-hand operand is the value the user tries to enter in the cell.) With the ternary operators Between and NotBetween, specifies the lower bound operand. Values can be numbers or Excel formulas (in quotation marks) such as "=A1" or "=SUM(A1,B2)". For example, setting formula1 to 10 and operator to GreaterThan means that valid data for the range must be greater than 10.

• formula2: With the ternary operators Between and NotBetween, specifies the upper bound operand. Is not used with the binary operators, such as GreaterThan. Values can be numbers or Excel formulas (in quotation marks) such as "=A1" or "=SUM(A1,B2)".

For DateTimeDataValidation object, replace "numbers" in the two preceding bullets with "stringified ISO8606 datetimes (such as "2018-05-01-13-25")"

Is this for the pivot table collection or for the fields collection for a pivot table? The title and description don't match.Is this for the pivot table collection or for the fields collection for a pivot table? The title and description don't match.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 2e4db2db-2b15-e7cb-7ffd-e7705136ed8c
• Version Independent ID: 3d2550d1-67a4-b3ce-7e23-6165969e39ff
• Content: Excel.PivotFieldCollection class - Office Add-ins
• Content Source: docs/docs-ref-autogen/excel/excel.pivotfieldcollection.yml
• Product: excel
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

The hostname field states that:
A string that can be one of the following values: Outlook, Mac Outlook, OutlookIOS, or OutlookWebApp.

This is not the case.

• When running Outlook on a Mac, the value returned is Outlook, not Mac Outlook. This is has been the case since 1.0
• Additionally, it can return OutlookAndroid.

I propose you change to:
A string that can be one of the following values: Outlook, OutlookAndroid, OutlookIOS, or OutlookWebApp.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 727c81a7-dee1-228e-57f5-691b4f9a57d4
• Version Independent ID: 672d730b-ef44-d6dd-7a92-aabc90141992
• Content: Office.Mailbox interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/outlook_1_7/office.mailbox.yml
• Product: outlook
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Hi Team,

For Cloud files (OD/SP) Office.FileProperties provides an URL in below format.
https://<tenant>.sharepoint.com/{sitepath}/{folder path}/filename.extension

In my scenario, I need complete drive item details on file which Add-In is running for cloud file scenario. Is there any way I can convert this file path to derive item id or drive item itself by calling some Microsoft Graph APIs or is there any js api which could do that for me.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: b0375be3-4e8e-d96c-edba-82362090e98a
• Version Independent ID: 42a6fc36-141f-10b4-5688-a5c0d72c05b6
• Content: Office.FileProperties interface
• Content Source: docs/docs-ref-autogen/office/office.fileproperties.yml
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

The documentation says the requirement set for Dialog API is "Dialog", whereas it should be "DialogAPI".

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: a98e72c2-bc8c-5664-f6b8-5317f2ff4b51
• Version Independent ID: a84b77c8-9835-d59e-669d-9a5e4e1480f9
• Content: Office common API requirement sets
• Content Source: docs/docs-ref-conceptual/requirement-sets/office-add-in-requirement-sets.md
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Article URL

https://github.com/OfficeDev/office-js-docs/blob/master/reference/word/body.md#insertparagraphparagraphtext-string-insertlocation-string

Issue

In the description for insertLocation property of the insertParagraph method, the sentence "The value can be 'Start' or 'End'." should be deleted. It is misleadingly incomplete and redundant with the rest of the description.

PhoneSettings only applies to Mail Add-ins so can you please correct the documentation above

"Add-in type: Content, Task pane, Mail"

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 036a61a1-66ce-79a4-848f-08974cf56021
• Version Independent ID: 7278a717-d121-19da-6bc6-9164f3477a06
• Content: PhoneSettings element
• Content Source: docs/docs-ref-conceptual/manifest/phonesettings.md
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

In IdentityAPI 1.1 "Office.Auth" link is broken

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 4e8708f6-d57e-a17f-7665-b791d66af97e
• Version Independent ID: cafbd543-dc87-43b8-421e-0d044e3cc713
• Content: Identity API requirement sets
• Content Source: docs/docs-ref-conceptual/requirement-sets/identity-api-requirement-sets.md
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Hello,

the function Office.context.mailbox.displayNewMessageForm is blocked by browsers because it opens a new window. Allow Popups is a workaround.

Is there a way around it. Maybe an email compose window on the main page for example? Or maybe a functionality to detect whether popup popups are blocked.

We're working with task pane add-ins and module extension add-ins in Outlook.

We need to be able to display a button in a task pane, that changes Outlook's view to a page in our module extension when clicked, passing information from the task pane's context to it.

Is this possible, and if so, how?

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 76004e57-4c78-a1d9-7fd6-1adb6635094e
• Version Independent ID: 7ed56398-e6be-f624-f76d-8982c36fa81a
• Content: Office.UI interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/office/office.ui.yml
• Product: non-product-specific
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

The hostname field states that:
A string that can be one of the following values: Outlook, Mac Outlook, OutlookIOS, or OutlookWebApp.

This is not the case.

• When running Outlook on a Mac, the value returned is Outlook, not Mac Outlook. This is has been the case since 1.0
• Additionally, it can return OutlookAndroid.

I propose you change to:
A string that can be one of the following values: Outlook, OutlookAndroid, OutlookIOS, or OutlookWebApp.

This was already brought up in issue #461 (resolved via #467) but I cannot see the changes on this page, which looks to be a new URL compared to when I added the original issues.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 7d6f3b80-c515-3753-a59a-7bb59c8b0501
• Version Independent ID: 759d1685-0928-664b-acee-05a197ca7aa0
• Content: Office.Diagnostics interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/outlook_1_7/outlook/office.diagnostics.yml
• Product: outlook
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

worksheet protection is not working in officejs Javascript library i'm using.
code:
let password = await passwordHandler();
passwordHelper(password);
await Excel.run(async (context) => {
let activeSheet = context.workbook.worksheets.getActiveWorksheet();
activeSheet.load("protection/protected");

await context.sync();

if (!activeSheet.protection.protected) {
    activeSheet.protection.protect(null, password);
}

});
throwing internal server error using with side loaded web adding.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: fa1ff77c-ae4b-c6ca-706e-b49507ebbbd8
• Version Independent ID: 7a4a4875-c7b0-b873-24f0-84f09b2cd12d
• Content: Excel.WorksheetProtection class - Office Add-ins
• Content Source: docs/docs-ref-autogen/excel/excel.worksheetprotection.yml
• Product: excel
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Article:
Document.setSelectedDataAsync method

Issue:
Following text does not reflect the actual behavior of the API/Excel

NOTE: In Excel, if you specify formulas in the TableData object you pass for the data parameter, you might not get the results you expect due to the "calculated columns" feature of Excel, which automatically duplicates formulas within a column. To work around this when you want to write data that contains formulas to a selected table, try specifying the data as an array of arrays (instead of a TableData object), and specify the coercionType as Microsoft.Office.Matrix or "matrix".

This doesn't actually work: Calculated Columns feature applies when matrix or table coercionTypes are used. Only way to workaround this seems to be to write the cells individually with "text" coercionType.

The hostname field states that:
A string that can be one of the following values: Outlook, Mac Outlook, OutlookIOS, or OutlookWebApp.

This is not the case.

• When running Outlook on a Mac, the value returned is Outlook, not Mac Outlook. This is has been the case since 1.0
• Additionally, it can return OutlookAndroid.

I propose you change to:
A string that can be one of the following values: Outlook, OutlookAndroid, OutlookIOS, or OutlookWebApp.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 2d838795-4f5e-9903-383c-7680c247d683
• Version Independent ID: b823052b-5e15-cf10-6a22-45e79b3e49f3
• Content: Office.Diagnostics interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/outlook_1_7/office.diagnostics.yml
• Product: outlook
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Hi, I'm using the ExcelJs API with addRowsAsync() and deleteAllDataValuesAsync(). (reference)

If the user creates some "computed columns", which enlarge the size of the table (e.g.: a new column with the value of the first column + 1), when I want add new data to the table, how should I handle the "computed" column/s?

      let excelTable = currentWorksheet.tables.getItemOrNullObject(tableName)
      excelTable.rows.load("values")
      excelTable.columns.load("values")

      return context.sync().then(() => {
        if (excelTable.isNullObject) {
          excelTable = currentWorksheet.tables.add(tableRange, true)
          excelTable.name = tableName
          excelTable.getHeaderRowRange().values = [excelHeaders]

          return context.sync().then(() => {
            Office.context.document.bindings.addFromNamedItemAsync(
              tableName,
              Office.BindingType.Table,
              { id: tableName },
              function(result) {
                if (result.status === Office.AsyncResultStatus.Succeeded) {
                  Office.context.document.bindings.getByIdAsync(
                    tableName,
                    null,
                    (asyncResult: any) => {
                      var binding = asyncResult.value
                      binding.addRowsAsync(_excelData)
                    }
                  )
                } else {
                  Debug.error("Error:", result.error.message)
                }
              }
            )
          })
        } else {
          const tableRows = excelTable.rows.items.length
          const tableColumns = excelTable.columns.items.length
          const dataRows = _excelData.length
          const dataColumns = _excelData[0].length

          Office.context.document.bindings.getByIdAsync(
            tableName,
            null,
            (asyncResult: any) => {
              var binding = asyncResult.value
              binding.deleteAllDataValuesAsync()
              binding.addRowsAsync(_excelData)
            }
          )
        }

        excelTable.getRange().format.autofitColumns()
        excelTable.getRange().format.autofitRows()

        return context.sync()
      })

Using Excel for Windows, the new rows aren't added to the table.
Differenly happens if I use Excel Online: the rows are added and the computed column is correctly left "untouched".

Is it a bug of the API?
Can you help me?

Thanks in advance,
Andrea

Dettagli del documento

⚠ Non modificare questa sezione. È necessaria per i collegamenti relativi ai problemi tra docs.microsoft.com ➟ GitHub.

• ID: 58bad507-6f0a-9be6-5c8b-8145b95daaa9
• Version Independent ID: a22025e6-d816-5cd5-0111-7ff42c2a4516
• Content: Office.TableBinding interface
• Content Source: docs/docs-ref-autogen/office/office.tablebinding.yml
• Product: office 365
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

The code samples for the find and findOrNullObject methods have errors. The 2nd parameter just repeats the names of the three properties instead of assigning actually possible values. The line should look like this:
const foundRange = searchRange.findOrNullObject($("#searchText").text(), {
completeMatch: false,
matchCase: false,
searchDirection: forward});

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 91eea38b-5448-965d-f938-c3d13db9dccf
• Version Independent ID: 09f81d36-d60d-3b72-467f-c9335c1e91d0
• Content: Excel.Range class - Office Add-ins
• Content Source: docs/docs-ref-autogen/excel/excel/excel.range.yml
• Product: excel
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

Resource/room selected with Office.context.mailbox.item.location.setAsync is being treated differently of Outlook web and Microsoft Office Outlook selection. Using this code a simple text is being written at Office.context.mailbox.item.location, without references to resource (room) created in Admin Center 365. The outcome is that we can't see the scheduling of this resource/room. See: OfficeDev/office-js#453

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 105ede86-e114-9103-d7f9-10dad0529eee
• Version Independent ID: 8f8f336e-f74d-9bda-cef6-e4c191de80e7
• Content: Office.Location interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/outlook_1_6/office.location.yml
• Product: outlook
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

await Excel.run(async function(context) {

const sheet = context.workbook.worksheets.getActiveWorksheet();
// const workBook = context.workbook.
console.log(sheet.protection);
sheet.protection.unprotect("abc")
const range = sheet.getUsedRange();
range.load("values");
range.load("address");
return context.sync().then(function () {
  console.log(range.address);
})

}).catch(function(error) {

      console.log("Error: " + error);

});

Error

Hi there, it would be awesome if this page had links to the documentation for the return types such as the Excel.WorksheetSingleClickedEventArgs type.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: ecc449d8-02af-e5c1-9e6e-74fc9067ca62
• Version Independent ID: 6cc5351c-a26b-5d83-5b8b-df1b92ff3e3a
• Content: Excel.Worksheet class - Office Add-ins
• Content Source: docs/docs-ref-autogen/excel/excel.worksheet.yml
• Product: excel
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

In just reading this page, it's not clear to what qualifies as a "complete" or "partial" match. e.g., Does "complete" mean that the search string must match the entire cell contents? Or is it more akin to a "whole word" requirement, in which case it would be helpful to know which characters constitute word components vs. word separators.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 61b7d244-ee86-561c-853a-b289b8184c01
• Version Independent ID: 208ba922-39f7-21ac-9481-646216edec6e
• Content: Excel.WorksheetSearchCriteria interface - Office Add-ins
• Content Source: docs/docs-ref-autogen/excel/excel.worksheetsearchcriteria.yml
• Product: excel
• Technology: add-ins
• GitHub Login: @o365devx
• Microsoft Alias: o365devx

I would love to use the JavaScript API for Office but there just isn't enough detail in these docs. I have to do too much guessing and hacking. I've used a lot of APIs. Microsoft has some good API documentation but this isn't it. Python.org has some excellent documentation. cppreference.com is some excellent documentation. The old Windows APIs are very well documented. JavaScript API for Office, not so much. The explanation of the property or method should tell me more than I could guess from the property name. Some of your tutorials are okay we just need more.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 6baf89b8-8d3a-b788-90b9-3514924e25e3
• Version Independent ID: 2b4a7f35-242d-64a3-e412-0313401dfc3a
• Content: Office JavaScript API reference - Office Add-ins
• Content Source: docs/docs-ref-autogen/overview/office.md
• Product: non-product-specific
• GitHub Login: @o365devx
• Microsoft Alias: o365devx