diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f900ddf41..67b987f8d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -108,14 +108,14 @@ remove: Total 10 (delta 1), reused 10 (delta 1) Unpacking objects: 100% (10/10), done. ``` -## Switch to `master` branch +## Switch to `main` branch -In order to add your changes, you will need to do those in the `master` branch. +In order to add your changes, you will need to do those in the `main` branch. -Type the following command in the console to switch to `master` branch: +Type the following command in the console to switch to `main` branch: ``` -git checkout master +git checkout main ``` Now, you can update existing docs or add new docs to the docs repo. @@ -131,15 +131,15 @@ Depending on the doc's intent, you can choose to add your doc into `basics` or ## Submit a pull request -Once you have completed adding your changes, you can submit a pull request. +Once you have completed adding your changes, you can submit a pull request. -Navigate to the forked sp-dev-docs repo in your account. Make sure your current branch is `master` branch. +Navigate to the forked sp-dev-docs repo in your account. Make sure your current branch is `main` branch. -Once you are in the `master` branch, you should see a message stating `This branch is 1 commit ahead of SharePoint:master` and next to it will be a `Pull request` link. +Once you are in the `main` branch, you should see a message stating `This branch is 1 commit ahead of Sharepoint:main` and next to it will be a `Pull request` link. ![Submit a pull request to sp-dev-docs repo](../images/contribute-docs-submit-pr.png) -Click the `Pull request` link to start a new pull request. Make sure you use this [template](PULL_REQUEST_TEMPLATE.md) to fill in your changes. Make sure you are creating this pull request against the `master` branch. +Click the `Pull request` link to start a new pull request. Make sure you use this [template](PULL_REQUEST_TEMPLATE.md) to fill in your changes. Make sure you are creating this pull request against the `main` branch. Once you have all the information, click the `Create pull request` button to submit your pull request. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 92c5a2dd6..6d3825f0c 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -8,7 +8,7 @@ body: value: | - [x] Bug - This is for SharePoint development bugs. If your submission is now about SharePoint development such as out-of-the-box capabilities, SharePoint configuration, please use refer to other support options listed on the [new issue chooser page](https://github.com/SharePoint/sp-dev-docs/issues/new/choose). Please provide as much information as possible so we can best address your submission. Thanks! + This is for SharePoint development bugs. If your submission is not about SharePoint development such as out-of-the-box capabilities, SharePoint configuration, please refer to other support options listed on the [new issue chooser page](https://github.com/SharePoint/sp-dev-docs/issues/new/choose). Please provide as much information as possible so we can best address your submission. Thanks! - Follow our guidance on [How To Create Good Issues](https://github.com/sharepoint/sp-dev-docs/wiki/How-to-Create-Good-Issues). - Remember to include sufficient details and context. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 92a598428..99aeec9af 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -22,6 +22,9 @@ > - **!!IMPORTANT!!** - All submissions must complete the baseline sections included in this template. Ignoring or deleting this template may result in closing the issue with the label **type:incomplete-submission**. > - Follow our guidance on [How To Create Good Pull Requests](https://github.com/SharePoint/sp-dev-docs/wiki/How-to-Create-Good-Pull-Requests). -> - Target the `master` branch of this repo. Released documents are in `live` branch. +> - Target the `main` branch of this repo. +> - When changing a page, ensure you update the `ms.date` front matter wih the current date in the format `MM/DD/YYYY`. +> - Review all build checks and address the automated errors, warnings, and suggestions. +> - *NOTE: The live site is based on the `live` branch. Site owners periodically refresh `live` branch from the `main` branch so merged PRs won't immediately appear on the live site. Please be patient to see your changes appear on the live site.* > > **DELETE THIS SECTION BEFORE SUBMITTING** diff --git a/.github/fabricbot.json b/.github/fabricbot.json new file mode 100644 index 000000000..6dcaf2f39 --- /dev/null +++ b/.github/fabricbot.json @@ -0,0 +1,1149 @@ +{ + "version": "1.0", + "tasks": [ + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "IssueResponder", + "version": "1.0", + "config": { + "conditions": { + "operator": "and", + "operands": [ + { + "name": "isEvent", + "parameters": { + "eventName": "issues" + } + }, + { + "name": "isAction", + "parameters": { + "action": "opened" + } + }, + { + "operator": "not", + "operands": [ + { + "name": "isAssignedToSomeone", + "parameters": {} + } + ] + } + ] + }, + "taskName": "Auto-label incoming issues as Needs Triage", + "actions": [ + { + "name": "addReply", + "parameters": { + "comment": "Thank you for reporting this issue. We will be triaging your incoming issue as soon as possible." + } + }, + { + "name": "addLabels", + "parameters": { + "labels": [ + "Needs: Triage :mag:" + ] + } + } + ] + }, + "id": "DhSdUvTfU" + }, + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "IssueResponder", + "version": "1.0", + "config": { + "conditions": { + "operator": "and", + "operands": [ + { + "operator": "not", + "operands": [ + { + "name": "isActivitySender", + "parameters": { + "user": "msft-github-bot" + } + } + ] + }, + { + "operator": "not", + "operands": [ + { + "name": "isAction", + "parameters": { + "action": "closed" + } + } + ] + }, + { + "name": "hasLabel", + "parameters": { + "label": "no-recent-activity" + } + } + ] + }, + "taskName": "Remove no recent activity label", + "actions": [ + { + "name": "removeLabel", + "parameters": { + "label": "no-recent-activity" + } + } + ] + }, + "id": "EuTNKsOAX" + }, + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "IssueResponder", + "version": "1.0", + "config": { + "conditions": { + "operator": "and", + "operands": [ + { + "name": "isEvent", + "parameters": { + "eventName": "issue_comment" + } + }, + { + "name": "isIssue", + "parameters": {} + }, + { + "name": "isActivitySender", + "parameters": { + "user": { + "type": "author" + } + } + }, + { + "name": "hasLabel", + "parameters": { + "label": "Needs: Author Feedback" + } + } + ] + }, + "taskName": "Add needs attention label to issues", + "actions": [ + { + "name": "addLabels", + "parameters": { + "labels": [ + "Needs: Attention :wave:" + ] + } + } + ] + }, + "id": "4g_ssp7c7" + }, + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "IssueResponder", + "version": "1.0", + "config": { + "conditions": { + "operator": "and", + "operands": [ + { + "name": "isActivitySender", + "parameters": { + "user": { + "type": "author" + } + } + }, + { + "operator": "not", + "operands": [ + { + "name": "isAction", + "parameters": { + "action": "closed" + } + } + ] + }, + { + "name": "hasLabel", + "parameters": { + "label": "Needs: Author Feedback" + } + } + ] + }, + "taskName": "Remove needs author feedback label from issues and pull requests", + "actions": [ + { + "name": "removeLabel", + "parameters": { + "label": "Needs: Author Feedback" + } + } + ] + }, + "id": "LSpcATOkS" + }, + { + "taskType": "scheduled", + "capabilityId": "ScheduledSearch", + "subCapability": "ScheduledSearch", + "version": "1.1", + "id": "R2LaDi6Kz", + "config": { + "taskName": "Closed answered issues in 3 days", + "frequency": [ + { + "weekDay": 0, + "hours": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ] + }, + { + "weekDay": 1, + "hours": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ] + }, + { + "weekDay": 2, + "hours": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ] + }, + { + "weekDay": 3, + "hours": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ] + }, + { + "weekDay": 4, + "hours": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ] + }, + { + "weekDay": 5, + "hours": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ] + }, + { + "weekDay": 6, + "hours": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ] + } + ], + "searchTerms": [ + { + "name": "isIssue", + "parameters": {} + }, + { + "name": "isOpen", + "parameters": {} + }, + { + "name": "hasLabel", + "parameters": { + "label": "status:answered" + } + }, + { + "name": "noActivitySince", + "parameters": { + "days": 3 + } + } + ], + "actions": [ + { + "name": "addReply", + "parameters": { + "comment": "Closing this issue as \"answered\". If you encounter a similar issue(s), please open up a new issue. See our wiki for more details: [Issue-List: Our approach to closed issues](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List#our-approach-to-closed-issues)" + } + }, + { + "name": "closeIssue", + "parameters": {} + }, + { + "name": "lockIssue", + "parameters": { + "reason": "resolved" + } + } + ] + } + }, + { + "taskType": "scheduled", + "capabilityId": "ScheduledSearch", + "subCapability": "ScheduledSearch", + "version": "1.1", + "id": "ejaaeLe6G", + "config": { + "frequency": [ + { + "weekDay": 0, + "hours": [ + 1, + 5, + 9, + 13, + 17, + 21 + ], + "timezoneOffset": -5 + }, + { + "weekDay": 1, + "hours": [ + 1, + 5, + 9, + 13, + 17, + 21 + ], + "timezoneOffset": -5 + }, + { + "weekDay": 2, + "hours": [ + 1, + 5, + 9, + 13, + 17, + 21 + ], + "timezoneOffset": -5 + }, + { + "weekDay": 3, + "hours": [ + 1, + 5, + 9, + 13, + 17, + 21 + ], + "timezoneOffset": -5 + }, + { + "weekDay": 4, + "hours": [ + 1, + 5, + 9, + 13, + 17, + 21 + ], + "timezoneOffset": -5 + }, + { + "weekDay": 5, + "hours": [ + 1, + 5, + 9, + 13, + 17, + 21 + ], + "timezoneOffset": -5 + }, + { + "weekDay": 6, + "hours": [ + 1, + 5, + 9, + 13, + 17, + 21 + ], + "timezoneOffset": -5 + } + ], + "searchTerms": [ + { + "name": "isIssue", + "parameters": {} + }, + { + "name": "isOpen", + "parameters": {} + }, + { + "name": "hasLabel", + "parameters": { + "label": "Needs: Author Feedback" + } + }, + { + "name": "hasLabel", + "parameters": { + "label": "no-recent-activity" + } + }, + { + "name": "noActivitySince", + "parameters": { + "days": 7 + } + } + ], + "taskName": "Close stale issues", + "actions": [ + { + "name": "closeIssue", + "parameters": {} + }, + { + "name": "addReply", + "parameters": { + "comment": "Closing issue due to no response from the original author. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: [No response from the original issue author](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List#no-response-from-the-original-issue-author)" + } + }, + { + "name": "lockIssue", + "parameters": {} + } + ] + }, + "disabled": false + }, + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "IssuesOnlyResponder", + "version": "1.0", + "id": "JN4EianUp", + "config": { + "conditions": { + "operator": "or", + "operands": [ + { + "name": "labelAdded", + "parameters": { + "label": "type:invalid-not-dev-issue" + } + }, + { + "name": "labelAdded", + "parameters": { + "label": "type:invalid" + } + } + ] + }, + "eventType": "issue", + "eventNames": [ + "issues", + "project_card" + ], + "taskName": "Reply & close issues tagged \"type:invalid-not-dev-issue\"", + "actions": [ + { + "name": "addReply", + "parameters": { + "comment": "Thank you for your submission. As explained in our wiki ([Issue List: What doesn't belong in the issue list](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List#what-doesnt-belong-in-the-issue-list)), this issue list is for SharePoint developer/development issues. All capability question/discussion questions, or topics related to SharePoint administration & end-user topics should be reported through the support user interface available in the tenant admin settings. You can also have a discussion and ask questions at the [SharePoint TechCommunity](https://techcommunity.microsoft.com/t5/SharePoint/ct-p/SharePoint) forum. You can learn more about this in our wiki: [type:invalid-not-dev-issue](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List-Labels#typeinvalid-not-dev-issue)" + } + }, + { + "name": "closeIssue", + "parameters": {} + }, + { + "name": "lockIssue", + "parameters": { + "reason": "off-topic" + } + } + ] + } + }, + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "IssuesOnlyResponder", + "version": "1.0", + "id": "dTcNyMD5a", + "config": { + "conditions": { + "operator": "and", + "operands": [ + { + "name": "labelAdded", + "parameters": { + "label": "type:uservoice-request" + } + } + ] + }, + "eventType": "issue", + "eventNames": [ + "issues", + "project_card" + ], + "actions": [ + { + "name": "addReply", + "parameters": { + "comment": "Thank you for your submission. As explained in our wiki ([Issue List: What doesn't belong in the issue list](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List#what-doesnt-belong-in-the-issue-list)), all new feature requests and change requests to existing features should be posted to the [SP Dev UserVoice](https://aka.ms/sp-dev-uservoice) site. You can learn more about this in our wiki: [type:uservoice-request](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List-Labels#typeuservoice-request)" + } + }, + { + "name": "closeIssue", + "parameters": {} + } + ], + "taskName": "Reply & close issues tagged \"type:uservoice-request\"" + } + }, + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "IssuesOnlyResponder", + "version": "1.0", + "id": "TXAA0OOon", + "config": { + "conditions": { + "operator": "and", + "operands": [ + { + "name": "labelAdded", + "parameters": { + "label": "Needs: Context Detail :question:" + } + } + ] + }, + "eventType": "issue", + "eventNames": [ + "issues", + "project_card" + ], + "taskName": "Reply issues tagged \"Needs: Context Detail\"", + "actions": [ + { + "name": "addReply", + "parameters": { + "comment": "The more context details you can provide, the easier it is to help assist on issues. Any code you can provide and/or screenshots of the issue also help. The easier you can make it to reproduce the issue, the easier and quicker it is for someone to help you. Please refer to [How to Create Good Issues](https://github.com/SharePoint/sp-dev-docs/wiki/How-to-Create-Good-Issues), specifically [How to Create Good Issues: Include context](https://github.com/SharePoint/sp-dev-docs/wiki/How-to-Create-Good-Issues#include-context), in our wiki for more details." + } + }, + { + "name": "addLabel", + "parameters": { + "label": "Needs: Author Feedback" + } + } + ] + } + }, + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "IssuesOnlyResponder", + "version": "1.0", + "id": "vAHQpj0AT", + "config": { + "conditions": { + "operator": "and", + "operands": [ + { + "name": "labelAdded", + "parameters": { + "label": "status:duplicate" + } + } + ] + }, + "eventType": "issue", + "eventNames": [ + "issues", + "project_card" + ], + "taskName": "Close issues tagged \"status:duplicate\"", + "actions": [ + { + "name": "addReply", + "parameters": { + "comment": "Closing this issue as a dupe. Please refer to our wiki for more details: [Issue List Labels: status:duplicate](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List-Labels#statusduplicate)" + } + }, + { + "name": "closeIssue", + "parameters": {} + }, + { + "name": "lockIssue", + "parameters": { + "reason": "resolved" + } + } + ] + } + }, + { + "taskType": "scheduled", + "capabilityId": "ScheduledSearch", + "subCapability": "ScheduledSearch", + "version": "1.1", + "id": "Lzyb5Csy_", + "config": { + "frequency": [ + { + "weekDay": 0, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 1, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 2, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 3, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 4, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 5, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 6, + "hours": [ + 0, + 6, + 12, + 18 + ] + } + ], + "searchTerms": [ + { + "name": "isIssue", + "parameters": {} + }, + { + "name": "isClosed", + "parameters": {} + }, + { + "name": "noActivitySince", + "parameters": { + "days": 7 + } + }, + { + "name": "isUnlocked", + "parameters": {} + } + ], + "taskName": "Lock issues if inactive 7d after closing", + "actions": [ + { + "name": "addReply", + "parameters": { + "comment": "Issues that have been closed & had no follow-up activity for at least 7 days are automatically locked. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: [Issue List: Our approach to locked issues](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List#our-approach-to-locked-issues)" + } + }, + { + "name": "lockIssue", + "parameters": { + "reason": "resolved" + } + } + ] + } + }, + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "IssuesOnlyResponder", + "version": "1.0", + "id": "k84udcNf_", + "config": { + "conditions": { + "operator": "and", + "operands": [ + { + "name": "bodyContains", + "parameters": { + "bodyPattern": "Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking." + } + } + ] + }, + "eventType": "issue", + "eventNames": [ + "issues", + "project_card" + ], + "actions": [ + { + "name": "addLabel", + "parameters": { + "label": "area:docs-comment" + } + } + ], + "taskName": "Label new issues created as comment on docs with \"area:docs-comment\"" + } + }, + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "IssuesOnlyResponder", + "version": "1.0", + "id": "NbeJ2zWgh", + "config": { + "conditions": { + "operator": "and", + "operands": [ + { + "name": "labelAdded", + "parameters": { + "label": "type:incomplete-submission" + } + } + ] + }, + "eventType": "issue", + "eventNames": [ + "issues", + "project_card" + ], + "taskName": "Reply & tag issues tagged with type:incomplete-submission", + "actions": [ + { + "name": "addReply", + "parameters": { + "comment": "Thank you for your submission, but there isn't enough detail in the issue for us to review & move forward. The new issue template includes sections for you to fill out. Please resubmit your issue and complete the provided sections in the new item template so we can move forward on it refer to our wiki for more information: [How to Create Good Issues](https://github.com/SharePoint/sp-dev-docs/wiki/How-to-Create-Good-Issues)" + } + }, + { + "name": "removeLabel", + "parameters": { + "label": "Needs: Triage :mag:" + } + }, + { + "name": "closeIssue", + "parameters": {} + } + ] + } + }, + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "PullRequestResponder", + "version": "1.0", + "id": "SgmbtMnlk", + "config": { + "conditions": { + "operator": "and", + "operands": [ + { + "name": "labelAdded", + "parameters": { + "label": "type:incomplete-submission" + } + } + ] + }, + "eventType": "pull_request", + "eventNames": [ + "pull_request", + "issues", + "project_card" + ], + "taskName": "Reply & tag PRs tagged with type:incomplete-submission", + "actions": [ + { + "name": "addReply", + "parameters": { + "comment": "Thank you for your submission, but there isn't enough detail in the pull request for us to review & move forward. The new PR template includes sections for you to fill out. Please resubmit your PR and complete the provided sections in the new item template so we can move forward on it refer to our wiki for more information: [How to Create Good Pull Requests]https://github.com/SharePoint/sp-dev-docs/wiki/How-to-Create-Good-Pull-Requests)" + } + }, + { + "name": "closeIssue", + "parameters": {} + } + ] + } + }, + { + "taskType": "scheduled", + "capabilityId": "ScheduledSearch", + "subCapability": "ScheduledSearch", + "version": "1.1", + "id": "ECBdzA7w3Y7R-jcBx0icn", + "config": { + "frequency": [ + { + "weekDay": 0, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 1, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 2, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 3, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 4, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 5, + "hours": [ + 0, + 6, + 12, + 18 + ] + }, + { + "weekDay": 6, + "hours": [ + 0, + 6, + 12, + 18 + ] + } + ], + "searchTerms": [ + { + "name": "isIssue", + "parameters": {} + }, + { + "name": "isOpen", + "parameters": {} + }, + { + "name": "hasLabel", + "parameters": { + "label": "Needs: Author Feedback" + } + }, + { + "name": "noActivitySince", + "parameters": { + "days": 7 + } + } + ], + "actions": [ + { + "name": "addLabel", + "parameters": { + "label": "no-recent-activity" + } + }, + { + "name": "addReply", + "parameters": { + "comment": "This issue has been automatically marked as stale because it has marked as requiring author feedback but has not had any activity for **7 days**. It will be closed if no further activity occurs **within the next 7 days of this comment**. Please see our wiki for more information: [Issue List Labels: Needs Author Feedback](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List-Labels#needs-author-feedback) & [Issue List: No response from the original issue author](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List#no-response-from-the-original-issue-author)" + } + } + ], + "taskName": "Mark issue with no-recent-activity label if there's no actions in 7 days" + } + }, + { + "taskType": "trigger", + "capabilityId": "IssueResponder", + "subCapability": "IssuesOnlyResponder", + "version": "1.0", + "id": "MdPj2K40N73yDGFnu9REz", + "config": { + "conditions": { + "operator": "and", + "operands": [ + { + "name": "labelAdded", + "parameters": { + "label": "listmaintenance-oldissues" + } + } + ] + }, + "eventType": "issue", + "eventNames": [ + "issues", + "project_card" + ], + "actions": [ + { + "name": "addReply", + "parameters": { + "comment": "This issue is being closed as part of an issue list cleanup project. Issues with no activity in the past 6 months that aren't tracked by engineering as bugs were closed as part of this inititive. If this is still an issue, please [follow the steps outlined to re-open or submit a new issue](https://github.com/sharepoint/sp-dev-docs/wiki/Issue-List#our-approach-to-closed-issues)." + } + }, + { + "name": "closeIssue", + "parameters": {} + } + ], + "taskName": "Close inactive issues based on list maintenance label" + } + } + ], + "userGroups": [] +} diff --git a/.github/label-actions.yml b/.github/label-actions.yml new file mode 100644 index 000000000..80a5bf7aa --- /dev/null +++ b/.github/label-actions.yml @@ -0,0 +1,14 @@ +# Configuration for Label Actions - https://github.com/dessant/label-actions + +# Actions taken when the `type:archive-old-issue` label is added to issues that are being archived. +type:archive-old-issue: + # Post a comment + comment: |+ + Thank you for taking the time to file an issue. We periodically **archive** older or inactive issues as part of our issue management process, which automatically closes them once they are archived. + + If you’d like to understand more about why and how we handle archived (closed) issues, please see [Our approach to closed issues](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List#our-approach-to-closed-issues). + + We appreciate your contribution and if this is still an active issue with the latest SPFx versions, please do resubmit the details. We needed to perform a cleanup, so that we can start with a **clean table** with a new process. We apologize for the inconvenience this might cause. + + # Close the issue + close: true diff --git a/.github/policies/resourceManagement.yml b/.github/policies/resourceManagement.yml new file mode 100644 index 000000000..43263aa44 --- /dev/null +++ b/.github/policies/resourceManagement.yml @@ -0,0 +1,115 @@ +id: bot-issue-management +name: Issue Management +description: Enable tracking & monitoring of issues +resource: repository +disabled: false +configuration: + resourceManagementConfiguration: + scheduledSearches: + - description: Close answered issues after 3 days of inactivity + frequencies: + - hourly: { hour: 0 } + filters: + - isIssue + - isOpen + - hasLabel: { label: status:answered } + - noActivitySince: { days: 3 } + actions: + - addReply: + reply: > + Closing this issue as "answered". If you encounter a similar issue(s), please open up a new issue. See our wiki for more details: [Issue-List: Our approach to closed issues](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List#our-approach-to-closed-issues) + - closeIssue + - lockIssue: + reason: resolved + + - description: Close stale issues with no recent author activity after 7 days + frequencies: + - hourly: { hour: 6 } + filters: + - isIssue + - isOpen + - hasLabel: { label: 'Needs: Author Feedback' } + - hasLabel: { label: no-recent-activity } + - noActivitySince: { days: 7 } + actions: + - addReply: + reply: > + Closing issue due to no response from the original author. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: [No response from the original issue author](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List#no-response-from-the-original-issue-author) + - closeIssue + - lockIssue + + - description: Mark issues as no recent activity after 7 days + frequencies: + - hourly: { hour: 6 } + filters: + - isIssue + - isOpen + - hasLabel: { label: 'Needs: Author Feedback' } + - noActivitySince: { days: 7 } + actions: + - addLabel: { label: no-recent-activity } + - addReply: + reply: > + This issue has been automatically marked as stale because it has marked as requiring author feedback but has not had any activity for **7 days**. It will be closed if no further activity occurs **within the next 7 days of this comment**. Please see our wiki for more information: [Issue List Labels: Needs Author Feedback](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List-Labels#needs-author-feedback) & [Issue List: No response from the original issue author](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List#no-response-from-the-original-issue-author) + + - description: Lock issues inactive 7 days after closing + frequencies: + - hourly: { hour: 6 } + filters: + - isIssue + - isClosed + - noActivitySince: { days: 7 } + - isUnlocked + actions: + - addReply: + reply: > + Issues that have been closed & had no follow-up activity for at least 7 days are automatically locked. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: [Issue List: Our approach to locked issues](https://github.com/SharePoint/sp-dev-docs/wiki/Issue-List#our-approach-to-locked-issues) + - lockIssue: + reason: resolved + + eventResponderTasks: + - if: + - payloadType: Issues + - isAction: { action: opened } + - not: + isAssignedToSomeone: true + then: + - addReply: + reply: > + Thank you for reporting this issue. We will be triaging your incoming issue as soon as possible. + - addLabel: + label: 'Needs: Triage :mag:' + + - if: + - payloadType: Issue_Comment + - isActivitySender: { issueAuthor: true } + - hasLabel: { label: 'Needs: Author Feedback' } + - isOpen + then: + - addLabel: + label: 'Needs: Attention :wave:' + + - if: + - payloadType: Issues + - isActivitySender: { issueAuthor: true } + - not: + isAction: { action: closed } + - hasLabel: { label: 'Needs: Author Feedback' } + then: + - removeLabel: { label: 'Needs: Author Feedback' } + + - if: + - payloadType: Issues + - not: + isActivitySender: { user: microsoft-github-policy-service } + - not: + isAction: { action: closed } + - hasLabel: { label: no-recent-activity } + then: + - removeLabel: { label: no-recent-activity } + + - if: + - payloadType: Issue_Comment + - hasLabel: { label: no-recent-activity } + then: + - removeLabel: { label: no-recent-activity } diff --git a/.github/workflows/label-actions.yml b/.github/workflows/label-actions.yml new file mode 100644 index 000000000..d2dd0ff59 --- /dev/null +++ b/.github/workflows/label-actions.yml @@ -0,0 +1,18 @@ +name: 'Check for Incomplete Issues' + +on: + issues: + types: [labeled, unlabeled] + +permissions: + issues: write + pull-requests: write + +jobs: + reaction: + runs-on: ubuntu-latest + steps: + - uses: dessant/label-actions@v2 + with: + github-token: ${{ github.token }} + process-only: 'issues' diff --git a/.openpublishing.build.ps1 b/.openpublishing.build.ps1 deleted file mode 100644 index aadef7620..000000000 --- a/.openpublishing.build.ps1 +++ /dev/null @@ -1,17 +0,0 @@ -param( - [string]$buildCorePowershellUrl = "https://opbuildstorageprod.blob.core.windows.net/opps1container/.openpublishing.buildcore.ps1", - [string]$parameters -) -# Main -$errorActionPreference = 'Stop' - -# Step-1: Download buildcore script to local -echo "download build core script to local with source url: $buildCorePowershellUrl" -$repositoryRoot = Split-Path -Parent $MyInvocation.MyCommand.Definition -$buildCorePowershellDestination = "$repositoryRoot\.openpublishing.buildcore.ps1" -Invoke-WebRequest $buildCorePowershellUrl -OutFile "$buildCorePowershellDestination" - -# Step-2: Run build core -echo "run build core script with parameters: $parameters" -& "$buildCorePowershellDestination" "$parameters" -exit $LASTEXITCODE diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index d15c23789..f3522487f 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -24,12 +24,12 @@ ], "notification_subscribers": [ "vesaj@microsoft.com", - "bjansen@microsoft.com", - "v-licapu@microsoft.com" + "bjansen@microsoft.com" ], + "sync_notification_subscribers": null, "branches_to_filter": [], "git_repository_url_open_to_public_contributors": "https://github.com/SharePoint/sp-dev-docs", - "git_repository_branch_open_to_public_contributors": "master", + "git_repository_branch_open_to_public_contributors": "main", "skip_source_output_uploading": false, "need_preview_pull_request": true, "contribution_branch_mappings": {}, @@ -37,13 +37,13 @@ { "path_to_root": "_themes", "url": "https://github.com/Microsoft/templates.docs.msft", - "branch": "master", + "branch": "main", "branch_mapping": {} }, { "path_to_root": "_themes.pdf", "url": "https://github.com/Microsoft/templates.docs.msft.pdf", - "branch": "master", + "branch": "main", "branch_mapping": {} }, { @@ -60,11 +60,11 @@ ] }, "need_generate_pdf_url_template": true, - "Targets": { - "Pdf": { - "template_folder": "_themes.pdf" - } - }, + "Targets": { + "Pdf": { + "template_folder": "_themes.pdf" + } + }, "JoinTOCPlugin": [ { "ConceptualTOC": "/docs/toc.yml", diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index 32f484eed..78222f726 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -1,79 +1,274 @@ { - "redirections": [ - { - "source_path": "docs/apis/rest/complete-basic-operations-using-sharepoint-rest-endpoints.md", - "redirect_url": "docs/sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints.md", - "redirect_document_id": false - }, - { - "source_path": "docs/apis/rest/determine-sharepoint-rest-service-endpoint-uris.md", - "redirect_url": "docs/sp-add-ins/determine-sharepoint-rest-service-endpoint-uris", - "redirect_document_id": false - }, - { - "source_path": "docs/apis/rest/get-to-know-the-sharepoint-rest-service.md", - "redirect_url": "docs/sp-add-ins/get-to-know-the-sharepoint-rest-service.md", - "redirect_document_id": false - }, - { - "source_path": "docs/apis/rest/make-batch-requests-with-the-rest-apis.md", - "redirect_url": "docs/sp-add-ins/make-batch-requests-with-the-rest-apis.md", - "redirect_document_id": false - }, - { - "source_path": "docs/apis/rest/navigate-the-sharepoint-data-structure-represented-in-the-rest-service.md", - "redirect_url": "docs/sp-add-ins/navigate-the-sharepoint-data-structure-represented-in-the-rest-service.md", - "redirect_document_id": false - }, - { - "source_path": "docs/apis/rest/set-custom-permissions-on-a-list-by-using-the-rest-interface.md", - "redirect_url": "docs/sp-add-ins/set-custom-permissions-on-a-list-by-using-the-rest-interface.md", - "redirect_document_id": false - }, - { - "source_path": "docs/apis/rest/synchronize-sharepoint-items-using-the-rest-service.md", - "redirect_url": "docs/sp-add-ins/synchronize-sharepoint-items-using-the-rest-service.md", - "redirect_document_id": false - }, - { - "source_path": "docs/apis/rest/upload-a-file-by-using-the-rest-api-and-jquery.md", - "redirect_url": "docs/sp-add-ins/upload-a-file-by-using-the-rest-api-and-jquery.md", - "redirect_document_id": false - }, - { - "source_path": "docs/apis/rest/use-odata-query-operations-in-sharepoint-rest-requests.md", - "redirect_url": "docs/sp-add-ins/use-odata-query-operations-in-sharepoint-rest-requests.md", - "redirect_document_id": false - }, - { - "source_path": "docs/apis/rest/working-with-folders-and-files-with-rest.md", - "redirect_url": "docs/sp-add-ins/working-with-folders-and-files-with-rest.md", - "redirect_document_id": false - }, - { - "source_path": "docs/apis/rest/working-with-lists-and-list-items-with-rest.md", - "redirect_url": "docs/sp-add-ins/working-with-lists-and-list-items-with-rest.md", - "redirect_document_id": false - }, - { - "source_path": "docs/schema/index.md", - "redirect_url": "docs/schema/upgrade-definition-schema.md", - "redirect_document_id": false - }, - { - "source_path": "docs/sp-add-ins/add-a-custom-content-type-to-a-sharepoint-hostedsharepoint-add-in.md", - "redirect_url": "docs/sp-add-ins/add-a-custom-content-type-to-a-sharepoint-hosted-sharepoint-add-in.md", - "redirect_document_id": false - }, - { - "source_path": "docs/sp-add-ins/add-custom-columns-to-a-sharepoint-hostedsharepoint-add-in.md", - "redirect_url": "docs/sp-add-ins/add-custom-columns-to-a-sharepoint-hosted-sharepoint-add-in.md", - "redirect_document_id": false - }, - { - "source_path": "docs/spfx/web-parts/guidance/creating-team-manifest-manually-for-webpart.md", - "redirect_url": "docs/spfx/deployment-spfx-teams-solutions.md", - "redirect_document_id": false - } - ] -} \ No newline at end of file + "redirections": [ + { + "source_path": "docs/apis/rest/complete-basic-operations-using-sharepoint-rest-endpoints.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints", + "redirect_document_id": false + }, + { + "source_path": "docs/apis/rest/determine-sharepoint-rest-service-endpoint-uris.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/determine-sharepoint-rest-service-endpoint-uris", + "redirect_document_id": false + }, + { + "source_path": "docs/apis/rest/get-to-know-the-sharepoint-rest-service.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service", + "redirect_document_id": false + }, + { + "source_path": "docs/apis/rest/make-batch-requests-with-the-rest-apis.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/make-batch-requests-with-the-rest-apis", + "redirect_document_id": false + }, + { + "source_path": "docs/apis/rest/navigate-the-sharepoint-data-structure-represented-in-the-rest-service.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/navigate-the-sharepoint-data-structure-represented-in-the-rest-service", + "redirect_document_id": false + }, + { + "source_path": "docs/apis/rest/set-custom-permissions-on-a-list-by-using-the-rest-interface.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/set-custom-permissions-on-a-list-by-using-the-rest-interface", + "redirect_document_id": false + }, + { + "source_path": "docs/apis/rest/synchronize-sharepoint-items-using-the-rest-service.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/synchronize-sharepoint-items-using-the-rest-service", + "redirect_document_id": false + }, + { + "source_path": "docs/apis/rest/upload-a-file-by-using-the-rest-api-and-jquery.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/upload-a-file-by-using-the-rest-api-and-jquery", + "redirect_document_id": false + }, + { + "source_path": "docs/apis/rest/use-odata-query-operations-in-sharepoint-rest-requests.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/use-odata-query-operations-in-sharepoint-rest-requests", + "redirect_document_id": false + }, + { + "source_path": "docs/apis/rest/working-with-folders-and-files-with-rest.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest", + "redirect_document_id": false + }, + { + "source_path": "docs/apis/rest/working-with-lists-and-list-items-with-rest.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest", + "redirect_document_id": false + }, + { + "source_path": "docs/schema/index.md", + "redirect_url": "/sharepoint/dev/schema/upgrade-definition-schema", + "redirect_document_id": false + }, + { + "source_path": "docs/sp-add-ins/add-a-custom-content-type-to-a-sharepoint-hostedsharepoint-add-in.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/add-a-custom-content-type-to-a-sharepoint-hosted-sharepoint-add-in", + "redirect_document_id": false + }, + { + "source_path": "docs/sp-add-ins/add-custom-columns-to-a-sharepoint-hostedsharepoint-add-in.md", + "redirect_url": "/sharepoint/dev/sp-add-ins/add-custom-columns-to-a-sharepoint-hosted-sharepoint-add-in", + "redirect_document_id": false + }, + { + "source_path": "docs/spfx/web-parts/guidance/creating-team-manifest-manually-for-webpart.md", + "redirect_url": "/sharepoint/dev/spfx/deployment-spfx-teams-solutions", + "redirect_document_id": false + }, + { + "source_path": "docs/general-development/office-365-cdn.md", + "redirect_url": "/sharepoint/dev/office365/enterprise/use-office-365-cdn-with-spo", + "redirect_document_id": false + }, + { + "source_path": "docs/spfx/toolchain/scaffolding-projects-using-yeoman-sharepoint-generator.md", + "redirect_url": "/sharepoint/dev/spfx/yeoman-generator-for-spfx-intro", + "redirect_document_id": false + }, + { + "source_path": "docs/spfx/office-addins-create.md", + "redirect_url": "/sharepoint/dev/spfx/release-1.14", + "redirect_document_id": false + }, + { + "source_path": "docs/spfx/web-parts/get-started/office-addins-tutorial.md", + "redirect_url": "/sharepoint/dev/spfx/release-1.14", + "redirect_document_id": false + }, + { + "source_path": "docs/spfx/sharepoint-2019-support.md", + "redirect_url": "/sharepoint/dev/spfx/sharepoint-2019-and-subscription-edition-support", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/mslearn/m01-01-intro.md", + "redirect_url": "/training/modules/sharepoint-embedded-setup/", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/mslearn/m02-01-intro.md", + "redirect_url": "/training/modules/sharepoint-embedded-create-app/", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/adoptions-and-use.md", + "redirect_url": "/sharepoint/dev/embedded/scenarios-and-use-cases", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/admin-exp/billing.md", + "redirect_url": "/sharepoint/dev/embedded/concepts/admin-exp/billing/billing", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/admin-exp/cta.md", + "redirect_url": "/sharepoint/dev/embedded/concepts/admin-exp/consuming-tenant-admin/cta", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/admin-exp/dev-admin.md", + "redirect_url": "/sharepoint/dev/embedded/concepts/admin-exp/developer-admin/dev-admin", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/app-concepts/terms-and-def.md", + "redirect_url": "/sharepoint/dev/embedded/overview", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/getting-started/enable-sharepoint-embedded.md", + "redirect_url": "/sharepoint/dev/embedded/overview", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/terms-of-service.md", + "redirect_url": "/sharepoint/dev/embedded/overview", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/admin-exp/adminrole.md", + "redirect_url": "/sharepoint/dev/embedded/administration/adminrole", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/admin-exp/billing/billing.md", + "redirect_url": "/sharepoint/dev/embedded/administration/billing/billing", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/admin-exp/billing/billingmanagement.md", + "redirect_url": "/sharepoint/dev/embedded/administration/billing/billingmanagement", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/admin-exp/billing/meters.md", + "redirect_url": "/sharepoint/dev/embedded/administration/billing/meters", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/admin-exp/consuming-tenant-admin/cta.md", + "redirect_url": "/sharepoint/dev/embedded/administration/consuming-tenant-admin/cta", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/admin-exp/consuming-tenant-admin/ctaUX.md", + "redirect_url": "/sharepoint/dev/embedded/administration/consuming-tenant-admin/ctaUX", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/admin-exp/consuming-tenant-admin/ctapowershell.md ", + "redirect_url": "/sharepoint/dev/embedded/administration/consuming-tenant-admin/ctapowershell", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/admin-exp/developer-admin/dev-admin.md", + "redirect_url": "/sharepoint/dev/embedded/administration/developer-admin/dev-admin", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/security-and-compliance.md", + "redirect_url": "/sharepoint/dev/embedded/compliance/security-and-compliance", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/app-concepts/app-architecture.md", + "redirect_url": "/sharepoint/dev/embedded/development/app-architecture", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/app-concepts/auth.md", + "redirect_url": "/sharepoint/dev/embedded/development/auth", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/content-experiences/office-experience.md", + "redirect_url": "/sharepoint/dev/embedded/development/content-experiences/office-experience", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/content-experiences/search-content.md", + "redirect_url": "/sharepoint/dev/embedded/development/content-experiences/search-content", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/content-experiences/user-experiences-overview.md", + "redirect_url": "/sharepoint/dev/embedded/development/content-experiences/user-experiences-overview", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/fluid.md", + "redirect_url": "/sharepoint/dev/embedded/development/fluid", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/app-concepts/limits-calling.md", + "redirect_url": "/sharepoint/dev/embedded/development/limits-calling", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/app-concepts/sharing-and-perm.md", + "redirect_url": "/sharepoint/dev/embedded/development/sharing-and-perm", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/tutorials/doc-processing-acs.md", + "redirect_url": "/sharepoint/dev/embedded/development/tutorials/doc-processing-acs", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/tutorials/launch-experience.md", + "redirect_url": "/sharepoint/dev/embedded/development/tutorials/launch-experience", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/tutorials/metadata.md", + "redirect_url": "/sharepoint/dev/embedded/development/tutorials/metadata", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/tutorials/migrate-abs-to-spe.md", + "redirect_url": "/sharepoint/dev/embedded/development/tutorials/migrate-abs-to-spe", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/tutorials/using-file-preview.md", + "redirect_url": "/sharepoint/dev/embedded/development/tutorials/using-file-preview", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/tutorials/using-webhooks.md", + "redirect_url": "/sharepoint/dev/embedded/development/tutorials/using-webhooks", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/app-concepts/containertypes.md", + "redirect_url": "/sharepoint/dev/embedded/getting-started/containertypes", + "redirect_document_id": false + }, + { + "source_path": "docs/embedded/concepts/app-concepts/register-api-documentation.md", + "redirect_url": "/sharepoint/dev/embedded/getting-started/register-api-documentation", + "redirect_document_id": false + } + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 000000000..ed9462b7e --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "markdownlint.config": { + "MD028": false, + "MD025": { + "front_matter_title": "" + } + } +} \ No newline at end of file diff --git a/README.md b/README.md index 37a430afd..4e77f8fcb 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# Welcome to the SharePoint Framework! +# Welcome to the SharePoint Framework! The SharePoint Framework (SPFx) is a page and part model that enables client-side development for building SharePoint experiences. It facilitates easy integration with the SharePoint data, and provides support for open source tooling development. * [Official SharePoint Framework Documentation](https://aka.ms/spfx) -This repository contains the raw documents published to docs.microsoft.com site. +This repository contains the raw documents published to Microsoft Docs. ## Questions & Help @@ -14,27 +14,26 @@ You can also tweet / follow [@Microsoft365Dev](https://twitter.com/Microsoft365D ## SharePoint Framework Releases -Review all the SPFx releases here from the initial GA release in February 2017 in the docs: https://docs.microsoft.com/en-us/sharepoint/dev/spfx/roadmap +Review all the SPFx releases here from the [initial GA release in February 2017](https://learn.microsoft.com/sharepoint/dev/spfx/roadmap) ## Get Started -* [Setup your Office 365 Developer Tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant) -* [Setup your Machine](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) -* [Go build your first web part](https://docs.microsoft.com/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part) - +* [Setup your Office 365 Developer Tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant) +* [Setup your Machine](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment) +* [Go build your first web part](https://learn.microsoft.com/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part) ## Learn More -* [Background and Philosophy](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) -* [Design Great Web Parts](https://docs.microsoft.com/sharepoint/dev/design/design-guidance-overview) -* [API Docs](https://docs.microsoft.com/javascript/api/sp-application-base) +* [Background and Philosophy](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview) +* [Design Great Web Parts](https://learn.microsoft.com/sharepoint/dev/design/design-guidance-overview) +* [API Docs](https://learn.microsoft.com/javascript/api/sp-application-base) ## Updates & Feedback To keep track of improvements to the Office 365 Framework, please take a look at: * [@SharePoint](https://twitter.com/sharepoint), [@Microsoft365Dev](https://twitter.com/Microsoft365Dev) and [@m365pnp](https://twitter.com/m365pnp) on Twitter -* [Office Developer Blog](https://developer.microsoft.com/en-us/office/blogs/) +* [Office Developer Blog](https://developer.microsoft.com/office/blogs/) Provide Feedback: @@ -49,7 +48,7 @@ Please see following guidance if you are planning to submit changes on the Share * [Contribution guidance](https://github.com/SharePoint/sp-dev-docs/blob/master/.github/CONTRIBUTING.md) * [How to Create Good Pull Requests](https://github.com/SharePoint/sp-dev-docs/wiki/How-to-Create-Good-Pull-Requests) -* If you are a Microsoft contributor, please review official guidance from our [internal documentation](https://review.docs.microsoft.com/en-us/help/contribute/?branch=master) for docs.microsoft.com contributors +* If you are a Microsoft contributor, please review official guidance from our [internal documentation](https://review.learn.microsoft.com/help/contribute/?branch=main) for Microsoft Docs contributors ## Have Fun diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..e138ec5d6 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,41 @@ + + +## Security + +Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). + +If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below. + +## Reporting Security Issues + +**Please do not report security vulnerabilities through public GitHub issues.** + +Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report). + +If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey). + +You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). + +Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: + + * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) + * Full paths of source file(s) related to the manifestation of the issue + * The location of the affected source code (tag/branch/commit or direct URL) + * Any special configuration required to reproduce the issue + * Step-by-step instructions to reproduce the issue + * Proof-of-concept or exploit code (if possible) + * Impact of the issue, including how an attacker might exploit the issue + +This information will help us triage your report more quickly. + +If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs. + +## Preferred Languages + +We prefer all communications to be in English. + +## Policy + +Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd). + + diff --git a/assets/ace/URL.txt b/assets/ace/URL.txt new file mode 100644 index 000000000..7d3d66ec3 --- /dev/null +++ b/assets/ace/URL.txt @@ -0,0 +1 @@ +me/events?$select=subject,body,bodyPreview,organizer,attendees,start,end,location \ No newline at end of file diff --git a/assets/ace/calendar-top.png b/assets/ace/calendar-top.png new file mode 100644 index 000000000..d8cb719da Binary files /dev/null and b/assets/ace/calendar-top.png differ diff --git a/assets/ace/email-top.png b/assets/ace/email-top.png new file mode 100644 index 000000000..d9170e95a Binary files /dev/null and b/assets/ace/email-top.png differ diff --git a/assets/ace/events-quick-view.json b/assets/ace/events-quick-view.json new file mode 100644 index 000000000..fb16cb82b --- /dev/null +++ b/assets/ace/events-quick-view.json @@ -0,0 +1,85 @@ +{ + "type": "AdaptiveCard", + "version": "1.5", + "@odata.type": "#microsoft.graph.message", + "body": [ + { + "type": "Container", + "items": [ + { + "type": "Image", + "url": "https://raw.githubusercontent.com/SharePoint/sp-dev-docs/main/assets/ace/calendar-top.png" + }, + { + "type": "TextBlock", + "text": "This control displays the latest calendar events. You can open the event in Outlook or, if it's a meeting, you can join it simply clicking on the button next to the event.", + "wrap": true + } + ] + }, + { + "type": "Container", + "$data": "${value}", + "items": [ + { + "type": "ColumnSet", + "columns": [ + { + "type": "Column", + "width": "stretch", + "items": [ + { + "type": "TextBlock", + "text": "${subject}", + "size": "Medium" + }, + { + "type": "TextBlock", + "text": "${location.displayName}", + "spacing": "None" + }, + { + "type": "TextBlock", + "text": "${formatDateTime(substring(start.dateTime,0,19), 'dd/MM/yyyy hh:mm')}-${formatDateTime(substring(end.dateTime,0,19), 'hh:mm')}", + "spacing": "None", + "size": "Small" + } + ] + }, + { + "type": "Column", + "width": "auto", + "items": [ + { + "type": "Image", + "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAvBJREFUSEvtVUtIalEUXdeKiDDIiIY1i7CIBkqRRrNCAqFM6AsRQhMLx5VSVvTBoqwIIqTIoCYV1aBZ/4EDk4gkmgg16iP9cFQaez+89N4zrz148AZvw+XCufectddeZ68tRCKRCP5iCP8MgM/nQ39/P9bX15Gfnw+bzYb6+nokJyfH5Z8Qg0AggObmZqjVarS2tsLr9WJ4eBhjY2PQ6/UMEA6H8fT0BJlMhoyMDAiCwOsJAayuroKehYUFZGZmgmSbm5vD+fk5HA4H3t/f0d3djcnJScjlcvT29sJisTC7hADcbjd2d3cxMzPDB1AsLS3h5OQEExMTODo64kNnZ2dxe3uLnp4eLC4uQqlUQgiHwxGPx4PDw0POJFbc3NzwhunpaTQ0NODy8hKdnZ1cHnqvra2JDB8fH7mcxKy0tBTC/f19pKmpiTP8TnR1dWFwcBDp6emIahQKhUCPRqPB+Pj4Dy0+A9DNqKys/A1nb28PfX190Gq1XIqioiLk5OSIQtKGh4cHbG1tMaBOp+M3i/wZYHl5GcTm1yANiLZCoUBxcTFSUlIkydbW1qK9vf1ngJKSEmRnZ6OmpgZmsxlOpxPb29u4u7vD6ekpCgoKYDQakZaWJgIEg0Fsbm6yHpQABWl2dXUFSiymBtRQVAq73Q6r1SoeVlVVxZuysrLEtajgU1NT3IAUx8fHvPc/AJfjj0pkMpnQ2NiIlZUVzM/Pf1uDg4MDDA0Nfa3BV3cwEZHf3t7YaV9fXzE6OhrfKigTioqKCiQlJXGjkaNGnZK+nZ2dwWAw8A0qKysD2TpZD92g8vLy+GZH7rmzsyO6aCxm9I/L5YJKpcLFxQUKCwu5h/Ly8qTtOuoxpElLSwt7/efw+/1oa2vjA2M5QELzYH9/HwRAndrR0YHc3Fy8vLxgY2MDIyMjqK6uFk0vFkPJeUDDhWxiYGCAx2U0qObU5XV1dUhNTf3SmyQBojsJ6Pn5GdfX1+xXZBdS8zihEknapsQPH6Mh/FGBh+hUAAAAAElFTkSuQmCC", + "selectAction": { + "type": "Action.OpenUrl", + "url": "${onlineMeeting.joinUrl}" + }, + "$when": "${isOnlineMeeting}" + } + ] + }, + { + "type": "Column", + "width": "auto", + "items": [ + { + "type": "Image", + "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAR5JREFUSEvtljGuRFAUhv8rIdGQSHQahc4ORG8PbMICVBZgE+xBL3agU2h0RIJCQsLkSt4kM2/e3Fu8ea+hPef4zvnOjYscx3Hggw95BizLgjAM4boufN/nQmdZhqIokCQJZFl+qCHzPB9pmmIcxzOwbRvyPIdpmrBtmwtQVRWapoHneRBF8axRVRVBEID0fX/QTilAURTs+466rqFpGnRd5wJ0XYdhGGBZFgRBwDRNJ4BOdgdEUQTHcfAbisqyRBzHrwF057QDSZK++fxpHNrUuq6nAUIIXgLoeIZhcClhJbVte2p+UPS1A1YxT/ztDnhewMp5uwNWMU/8AjAtXYouRUwDzIT/OUUf+9g9X5nM+TkT7lfmn/9VcDbInXYDn/BFftWPiLMAAAAASUVORK5CYII=", + "selectAction": { + "type": "Action.OpenUrl", + "url": "${webLink}" + } + } + ] + } + ] + } + ], + "separator": true + } + ], + "$schema": "http://adaptivecards.io/schemas/adaptive-card.json" +} \ No newline at end of file diff --git a/assets/ace/messages-quick-view.json b/assets/ace/messages-quick-view.json new file mode 100644 index 000000000..74e7f40a1 --- /dev/null +++ b/assets/ace/messages-quick-view.json @@ -0,0 +1,84 @@ +{ + "type": "AdaptiveCard", + "version": "1.5", + "@odata.type": "#microsoft.graph.message", + "body": [ + { + "type": "Container", + "items": [ + { + "type": "Image", + "url": "https://raw.githubusercontent.com/SharePoint/sp-dev-docs/main/assets/ace/email-top.png" + }, + { + "type": "TextBlock", + "text": "This control displays the last email message received in your inbox. To view the message, simply click on the button. The message will open directly in Outlook, allowing you to read and respond to it as needed.", + "wrap": true + } + ] + }, + { + "type": "Container", + "$data": "${value}", + "items": [ + { + "type": "ColumnSet", + "columns": [ + { + "type": "Column", + "width": "stretch", + "items": [ + { + "type": "TextBlock", + "text": "${from.emailAddress.name}", + "size": "Medium", + "weight": "${if(isRead, 'normal', 'bolder')}" + }, + { + "type": "TextBlock", + "text": "${subject}", + "spacing": "None", + "weight": "${if(isRead, 'normal', 'bolder')}" + } + ] + }, + { + "type": "Column", + "width": "auto", + "items": [ + { + "type": "TextBlock", + "text": "${if(hasAttachments, '📎', '')} ${if(importance == 'normal', '', '❗')} ${if(flag.flagStatus == 'flagged', '🚩', '')}", + "horizontalAlignment": "Right" + }, + { + "type": "TextBlock", + "text": "{{DATE(${sentDateTime}, COMPACT)}} {{TIME(${sentDateTime})}}", + "spacing": "None", + "size": "Small" + } + ], + "verticalContentAlignment": "Center" + }, + { + "type": "Column", + "width": "auto", + "items": [ + { + "type": "Image", + "url": "${if(isRead, 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAY5JREFUSEvt1aGLwlAcB/DvQ2FNg6BFMPg3WDRZRayGLWkxKViUgUkYWgRNKy5psG52kxb/BoOwMtEwTaLwjudxntObb3onHMe9uvH97Pd9vDdCKaV44SK/Btjv9zAMAz6fD5lMBoIgeJqbOwELHo/HaLfbME3zFBqNRlGr1ZDNZrmQK3AZvFqtUKlUUCwWT0C/30e320U4HOZCN4BbcCAQcFSy3W49QWfAa/B18TyIHA4Hqus6Wq0WLqu4/mLejl5D9XoduVwOZL1eU1EUEYlE0Ol0EAqFeFl3n282G1SrVViWheFw+AnMZjMoioJSqQS/3/8UcjweoaoqZFlGMpl0AolEAqPRCOVy+SnkI7zX6yGfz2M+nzuBRqMBttFsgkeRy3A2ATuEzWbzFmBjTSYTFAoFLJfLh2qKxWLQNA3pdBqs7i+BVCoFdvctFovzqfWqsNMdj8dBCMF0OnUHvAbee+8f4Lb4RyuybRuPXnBuXbGLLxgMvh+03W5HB4MBGPCTiwGSJIH7y/wu+nLgDSewZ7NrDNFAAAAAAElFTkSuQmCC', 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAARBJREFUSEvtlS2qhUAYhl+LRbALYhMsrsAF2MXmLhRsJpugu7CJ3QW4AotgE8EiBsFimYNevJxz8Th6YZpThpnv55nvnT+OEELAsHEPgKYue4nGcSS+76NtW9pibtkVRUEUReCGYSCO46Cua6y9KIq3Ev11nqYJaZpC07St/wUURQFd1+F5HmzbhiAIt0DzPCPLMsRxjKqqYJrmJ8B1XfR9vzms7SroPfEeJ0kSkiT5BARBAMMwcBRwVNGZX1mWCMPwGLDr8i3Bat+l+FbpJcARaFmWbZrn+VMJbwHeQXmeb0PLsk4Pwb8Ad47UA6CqdSiRqqqQZZkafMWh6zo0TfNzD5g/ds+PRtsT9j8a6z14AbwnH7bn+xIdAAAAAElFTkSuQmCC')}", + "selectAction": { + "type": "Action.OpenUrl", + "url": "${webLink}" + } + } + ] + } + ] + } + ], + "separator": true + } + ], + "$schema": "http://adaptivecards.io/schemas/adaptive-card.json" +} \ No newline at end of file diff --git a/assets/bot-powered/Media/Collect-Feedback.png b/assets/bot-powered/Media/Collect-Feedback.png new file mode 100644 index 000000000..16aecc8a0 Binary files /dev/null and b/assets/bot-powered/Media/Collect-Feedback.png differ diff --git a/assets/bot-powered/Media/Ok-Feedback.png b/assets/bot-powered/Media/Ok-Feedback.png new file mode 100644 index 000000000..ea5aa3a3b Binary files /dev/null and b/assets/bot-powered/Media/Ok-Feedback.png differ diff --git a/assets/bot-powered/TeamsAppManifest/icon-color.png b/assets/bot-powered/TeamsAppManifest/icon-color.png new file mode 100644 index 000000000..b8cf81afb Binary files /dev/null and b/assets/bot-powered/TeamsAppManifest/icon-color.png differ diff --git a/assets/bot-powered/TeamsAppManifest/icon-outline.png b/assets/bot-powered/TeamsAppManifest/icon-outline.png new file mode 100644 index 000000000..2c3bf6fa6 Binary files /dev/null and b/assets/bot-powered/TeamsAppManifest/icon-outline.png differ diff --git a/assets/bot-powered/TeamsAppManifest/manifest.json b/assets/bot-powered/TeamsAppManifest/manifest.json new file mode 100644 index 000000000..7a502770d --- /dev/null +++ b/assets/bot-powered/TeamsAppManifest/manifest.json @@ -0,0 +1,65 @@ +{ + "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.14/MicrosoftTeams.schema.json", + "manifestVersion": "1.16", + "version": "1.0.0", + "id": "", + "packageName": "collectfeedback.botpoweredace", + "developer": { + "name": "", + "websiteUrl": "", + "privacyUrl": "", + "termsOfUseUrl": "", + "mpnId": "" + }, + "name": { + "short": "Collect Feedaback Bot Powered ACE", + "full": "This is a basic sample of a Bot Powered ACE for Microsoft Viva Connections Dashboard to collect user's feedback" + }, + "description": { + "short": "Basic sample of a Bot Powered ACE for Microsoft Viva Connections Dashboard to collect user's feedback", + "full": "Basic sample of how to use the latest release of the Bot Framework SDK to build a Bot Powered ACE for Microsoft Viva Connections Dashboard to collect user's feedback" + }, + "icons": { + "outline": "icon-outline.png", + "color": "icon-color.png" + }, + "accentColor": "#FFFFFF", + "bots": [ + { + "botId": "", + "needsChannelSelector": false, + "isNotificationOnly": false, + "supportsCalling": false, + "supportsVideo": false, + "supportsFiles": false, + "scopes": [ + "team", + "personal", + "groupchat" + ] + } + ], + "dashboardCards": [ + { + "id": "", + "displayName": "Collect Feedaback", + "description": "Bot Powered ACE to collect user's feedback", + "icon": { + "officeUIFabricIconName": "Feedback" + }, + "contentSource": { + "sourceType": "bot", + "botConfiguration": { + "botId": "" + } + }, + "defaultSize": "medium" + } + ], + "permissions": [ + "identity" + ], + "validDomains": [ + ".ngrok.io" + ] +} \ No newline at end of file diff --git a/assets/spfx/spfx-matrix.json b/assets/spfx/spfx-matrix.json new file mode 100644 index 000000000..66ddda059 --- /dev/null +++ b/assets/spfx/spfx-matrix.json @@ -0,0 +1,545 @@ +[ + { + "spfx": "1.21.1", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.21.1", + "node": [ + "v22" + ], + "typescript": [ + "v5.3" + ], + "react": [ + "v17.0.1" + ] + }, + { + "spfx": "1.21.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.21", + "node": [ + "v22" + ], + "typescript": [ + "v5.3" + ], + "react": [ + "v17.0.1" + ] + }, + { + "spfx": "1.20.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.20", + "node": [ + "v18" + ], + "typescript": [ + "v4.5", + "v4.7" + ], + "react": [ + "v17.0.1" + ], + "releaseDate": "2024-09-26" + }, + { + "spfx": "1.19.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.19", + "node": [ + "v18" + ], + "typescript": [ + "v4.5", + "v4.7" + ], + "react": [ + "v17.0.1" + ], + "releaseDate": "2024-05-01" + }, + { + "spfx": "1.18.2", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.18.2", + "node": [ + "v16", + "v18" + ], + "typescript": [ + "v4.5", + "v4.7" + ], + "react": [ + "v17.0.1" + ], + "releaseDate": "2023-11-21" + }, + { + "spfx": "1.18.1", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.18.1", + "node": [ + "v16", + "v18" + ], + "typescript": [ + "v4.5", + "v4.7" + ], + "react": [ + "v17.0.1" + ], + "releaseDate": "2023-11-07" + }, + { + "spfx": "1.18", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.18", + "node": [ + "v16", + "v18" + ], + "typescript": [ + "v4.5", + "v4.7" + ], + "react": [ + "v17.0.1" + ], + "releaseDate": "2023-09-12" + }, + { + "spfx": "1.17.4", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.17.4", + "node": [ + "v16.13+" + ], + "typescript": [ + "v4.5" + ], + "react": [ + "v17.0.1" + ] + }, + { + "spfx": "1.17.3", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.17.3", + "node": [ + "v16.13+" + ], + "typescript": [ + "v4.5" + ], + "react": [ + "v17.0.1" + ], + "releaseDate": "2023-06-21" + }, + { + "spfx": "1.17.2", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.17.2", + "node": [ + "v16.13+" + ], + "typescript": [ + "v4.5" + ], + "react": [ + "v17.0.1" + ], + "releaseDate": "2023-05-08" + }, + { + "spfx": "1.17.1", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.17.1", + "node": [ + "v16.13+" + ], + "typescript": [ + "v4.5" + ], + "react": [ + "v17.0.1" + ], + "releaseDate": "2023-04-12" + }, + { + "spfx": "1.17.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.17", + "node": [ + "v16.13+" + ], + "typescript": [ + "v4.5" + ], + "react": [ + "v17.0.1" + ], + "releaseDate": "2023-04-04" + }, + { + "spfx": "1.16.1", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.16.1", + "node": [ + "v16.13+" + ], + "typescript": [ + "v4.5" + ], + "react": [ + "v17.0.1" + ], + "releaseDate": "2022-11-30" + }, + { + "spfx": "1.16.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.16", + "node": [ + "v16.13+" + ], + "typescript": [ + "v4.5" + ], + "react": [ + "v17.0.1" + ], + "releaseDate": "2022-11-15" + }, + { + "spfx": "1.15.2", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.15.2", + "node": [ + "v12", + "v14", + "v16" + ], + "typescript": [ + "v4.5" + ], + "react": [ + "v16.13.1" + ], + "releaseDate": "2022-08-02" + }, + { + "spfx": "1.15.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.15", + "node": [ + "v12", + "v14", + "v16" + ], + "typescript": [ + "v4.5" + ], + "react": [ + "v16.13.1" + ], + "releaseDate": "2022-06-21" + }, + { + "spfx": "1.14.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.14", + "node": [ + "v12", + "v14" + ], + "typescript": [ + "v3.9" + ], + "react": [ + "v16.13.1" + ], + "releaseDate": "2022-02-17" + }, + { + "spfx": "1.13.1", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.13.1", + "node": [ + "v12", + "v14" + ], + "typescript": [ + "v3.9" + ], + "react": [ + "v16.13.1" + ], + "releaseDate": "2021-11-23" + }, + { + "spfx": "1.13.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.13", + "node": [ + "v12", + "v14" + ], + "typescript": [ + "v3.9" + ], + "react": [ + "v16.13.1" + ], + "releaseDate": "2021-10-21" + }, + { + "spfx": "1.12.1", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.12.1", + "node": [ + "v10", + "v12", + "v14" + ], + "typescript": [ + "v3.7" + ], + "react": [ + "v16.9.0" + ], + "releaseDate": "2021-04-28" + }, + { + "spfx": "1.12.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.12.0", + "node": [ + "v12", + "v10" + ], + "typescript": [ + "v3.7" + ], + "react": [ + "v16.9.0" + ], + "deprecated": true, + "releaseDate": "2021-03-15" + }, + { + "spfx": "1.11.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.11.0", + "node": [ + "v10" + ], + "typescript": [ + "v3.3" + ], + "react": [ + "v16.8.5" + ] + }, + { + "spfx": "1.10.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.10.0", + "node": [ + "v8", + "v10" + ], + "typescript": [ + "v3.3" + ], + "react": [ + "v16.8.5" + ], + "releaseDate": "2020-07-16" + }, + { + "spfx": "1.9.1", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.9.1", + "node": [ + "v8", + "v10" + ], + "typescript": [ + "v2.9" + ], + "react": [ + "v16.8.5" + ], + "releaseDate": "2019-08-14" + }, + { + "spfx": "1.8.2", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.8.2", + "node": [ + "v8", + "v10" + ], + "typescript": [ + "v2.9" + ], + "react": [ + "v16.7.0" + ], + "releaseDate": "2019-05-07" + }, + { + "spfx": "1.8.1", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.8.1", + "node": [ + "v8" + ], + "typescript": [ + "v2.7", + "v2.9", + "v3" + ], + "react": [ + "v16.7.0" + ], + "releaseDate": "2019-04-16" + }, + { + "spfx": "1.8.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.8.0", + "node": [ + "v8" + ], + "typescript": [ + "v2.7", + "v2.9", + "v3" + ], + "react": [ + "v16.7.0" + ], + "releaseDate": "2019-03-14" + }, + { + "spfx": "1.7.1", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.7.1", + "node": [ + "v8" + ], + "typescript": [ + "v2.4" + ], + "react": [ + "v16.3.2" + ], + "releaseDate": "2018-12-18" + }, + { + "spfx": "1.7.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.7", + "node": [ + "v8" + ], + "typescript": [ + "v2.4" + ], + "react": [ + "v16.3.2" + ], + "releaseDate": "2018-11-08" + }, + { + "spfx": "1.6.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.6", + "node": [ + "v6", + "v8" + ], + "typescript": [ + "v2.4" + ], + "react": [ + "v15" + ] + }, + { + "spfx": "1.5.1", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.5.1", + "node": [ + "v6", + "v8" + ], + "typescript": [ + "v2.4" + ], + "react": [ + "v15" + ], + "releaseDate": "2018-06-26" + }, + { + "spfx": "1.5.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.5", + "node": [ + "v6", + "v8" + ], + "typescript": [ + "v2.4" + ], + "react": [ + "v15" + ], + "releaseDate": "2018-06-05" + }, + { + "spfx": "1.4.1", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.4.1", + "node": [ + "v6", + "v8" + ], + "typescript": [ + "v2.4" + ], + "react": [ + "v15" + ], + "releaseDate": "2018-02-18" + }, + { + "spfx": "1.4.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.4", + "node": [ + "v6" + ], + "typescript": [ + "v2.4" + ], + "react": [ + "v15" + ], + "releaseDate": "2017-12-07" + }, + { + "spfx": "1.3.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.3", + "node": [ + "v6" + ], + "typescript": [ + "v2.4" + ], + "react": [ + "v15" + ], + "releaseDate": "2017-08-25" + }, + { + "spfx": "1.1.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.1", + "node": [ + "v6" + ], + "typescript": [ + "v2.4" + ], + "react": [ + "v15" + ], + "releaseDate": "2017-06-06" + }, + { + "spfx": "1.0.0", + "url": "https://learn.microsoft.com/sharepoint/dev/spfx/release-1.0.0", + "node": [ + "v6" + ], + "typescript": [ + "v2.4" + ], + "react": [ + "v15" + ], + "releaseDate": "2017-02-22" + } +] \ No newline at end of file diff --git a/assets/vc-backgrounds/01_Teal.png b/assets/vc-backgrounds/01_Teal.png new file mode 100644 index 000000000..98158b37b Binary files /dev/null and b/assets/vc-backgrounds/01_Teal.png differ diff --git a/assets/vc-backgrounds/02_Blue.png b/assets/vc-backgrounds/02_Blue.png new file mode 100644 index 000000000..a9c23fb91 Binary files /dev/null and b/assets/vc-backgrounds/02_Blue.png differ diff --git a/assets/vc-backgrounds/03_Orange.png b/assets/vc-backgrounds/03_Orange.png new file mode 100644 index 000000000..8e811de8f Binary files /dev/null and b/assets/vc-backgrounds/03_Orange.png differ diff --git a/assets/vc-backgrounds/04_Red.png b/assets/vc-backgrounds/04_Red.png new file mode 100644 index 000000000..b42888406 Binary files /dev/null and b/assets/vc-backgrounds/04_Red.png differ diff --git a/assets/vc-backgrounds/05_Purple.png b/assets/vc-backgrounds/05_Purple.png new file mode 100644 index 000000000..888e21a84 Binary files /dev/null and b/assets/vc-backgrounds/05_Purple.png differ diff --git a/assets/vc-backgrounds/06_Green.png b/assets/vc-backgrounds/06_Green.png new file mode 100644 index 000000000..494d7dd31 Binary files /dev/null and b/assets/vc-backgrounds/06_Green.png differ diff --git a/assets/vc-backgrounds/07_Gray.png b/assets/vc-backgrounds/07_Gray.png new file mode 100644 index 000000000..3ec725883 Binary files /dev/null and b/assets/vc-backgrounds/07_Gray.png differ diff --git a/assets/vc-backgrounds/08_Periwinkle.png b/assets/vc-backgrounds/08_Periwinkle.png new file mode 100644 index 000000000..23b6fa00a Binary files /dev/null and b/assets/vc-backgrounds/08_Periwinkle.png differ diff --git a/assets/vc-backgrounds/09_Black.png b/assets/vc-backgrounds/09_Black.png new file mode 100644 index 000000000..4a1837aa9 Binary files /dev/null and b/assets/vc-backgrounds/09_Black.png differ diff --git a/assets/vc-backgrounds/10_Cerulean.png b/assets/vc-backgrounds/10_Cerulean.png new file mode 100644 index 000000000..86c8be663 Binary files /dev/null and b/assets/vc-backgrounds/10_Cerulean.png differ diff --git a/assets/vc-backgrounds/11_Cobalt.png b/assets/vc-backgrounds/11_Cobalt.png new file mode 100644 index 000000000..a2f354798 Binary files /dev/null and b/assets/vc-backgrounds/11_Cobalt.png differ diff --git a/assets/vc-backgrounds/12_Dark Yellow.png b/assets/vc-backgrounds/12_Dark Yellow.png new file mode 100644 index 000000000..224126c84 Binary files /dev/null and b/assets/vc-backgrounds/12_Dark Yellow.png differ diff --git a/assets/vc-backgrounds/13_Dark Blue.png b/assets/vc-backgrounds/13_Dark Blue.png new file mode 100644 index 000000000..f38b33e1f Binary files /dev/null and b/assets/vc-backgrounds/13_Dark Blue.png differ diff --git a/assets/vc-backgrounds/14_Custom_Color.png b/assets/vc-backgrounds/14_Custom_Color.png new file mode 100644 index 000000000..624e7605d Binary files /dev/null and b/assets/vc-backgrounds/14_Custom_Color.png differ diff --git a/assets/vc-backgrounds/15_Hero_Connections_Dark.png b/assets/vc-backgrounds/15_Hero_Connections_Dark.png new file mode 100644 index 000000000..90cf818b5 Binary files /dev/null and b/assets/vc-backgrounds/15_Hero_Connections_Dark.png differ diff --git a/docs/apis/addin-management-apis.md b/docs/apis/addin-management-apis.md new file mode 100644 index 000000000..f5cab6571 --- /dev/null +++ b/docs/apis/addin-management-apis.md @@ -0,0 +1,346 @@ +--- +title: SharePoint Add-in related APIs +description: We provided some Add-in related APIs to get Add-in's installation info and uninstall the Add-in. +audience: admin +ms.date: 03/25/2023 +ms.localizationpriority: medium +--- + +# SharePoint Add-in Management APIs + +This documentation will introduce some APIs which related to SharePoint Add-ins. They could help to have a clear view +and better management of the Add-ins in tenant level, including these: + +- Get available Add-ins in sites +- Get Add-in permissions in site collections +- Get tenant ACS service principals +- Get Add-in principals in site collections +- Uninstall Add-ins +- Get uninstall Add-in job status + +For more information about SharePoint Add-in, see [SharePoint Add-ins](../sp-add-ins/sharepoint-add-ins.md). + +## Prerequisites + +- App-only mode token. [Get token example](https://github.com/pnp/pnpcore/blob/dev/docs/polyglot/Getting%20started%20-%20application%20permissions.ipynb) +- Called on the admin site. Example: https://www.contoso-admin.sharepoint.com +- For uninstall Add-in API, the app needs to have Sites.FullControl.All permission. For others, the app needs at least Sites.Read.All permission. + +## Get available Add-ins in sites + +This API will return the Add-ins that could be used on the given sites. This contains two kinds of install, one is the Add-in installed on the site. +The other is the Add-in installed on the tenant level app catalog site, and it matches the conditions to use the Add-in. +For more information, see [Tenancies and deployment scopes for SharePoint Add-ins](../sp-add-ins/tenancies-and-deployment-scopes-for-sharepoint-add-ins.md). + +This API needs the app to have at least Sites.Read.All permission. + +### HTTP request + +```HTTP +POST {adminSiteUrl}/_api/web/AvailableAddIns +``` + +### Request body + +| Name | Required | Type | Description | +|--------------------|----------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| serverRelativeUrls | no | string[] | List of the server relative url of sites that want to get the available Add-ins. Maximum size is 500. | +| urls | no | string[] | List of the url of sites that want to get the available Add-ins, both server relative url and absolute url are acceptable. Maximum size is 500. | + +When urls is not null, serverRelativeUrls will be disregarded. + +### Responses + +| Name | Type | Description | +|-----------------------------|--------------------------------|--------------------------------------------------------------------------------------| +| addins | SPAddinInstanceInfo[] | Available Add-in instance object. | +| errorsWithServerRelativeUrl | SPErrorWithServerRelativeUrl[] | Server relative urls that failed to get available add-ins and corresponding reasons. | + +#### SPAddinInstanceInfo + +| Name | Type | Description | +|-------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| title | string | Title of the Add-in. | +| appInstanceId | Guid | Id of the installation. | +| launchUrl | String | The Add-in's launch page address. | +| installedSiteId | Guid | Site collection id where the Add-in installed. | +| installedWebId | Guid | Site id where the Add-in installed. | +| installedWebName | string | Site name where the Add-in installed. | +| installedWebUrl | string | Site url where the Add-in installed. | +| currentSiteId | Guid | Site collection id of current site. | +| currentWebId | Guid | Site id of current site. | +| currentWebName | string | Site name of current site. | +| currentWebUrl | string | Site url of current site. | +| status | string | The status of current Add-in. | +| appWebFullUrl | string | The full url of the app web. The SharePoint components are generally in a special child web of the host web called the app web. The app web will be created during install the add-in. | +| appWebId | Guid | Id of the app web. | +| appWebName | string | Name of the app web. | +| installedBy | string | User name of who installed the add-in. | +| appIdentifier | string | The identifier of the app principal. It could be used to get the Add-in's permission. | +| creationTimeUtc | DateTime | Date time when installed the add-in. | +| productId | Guid | The global unique id of the add-in. It is same for all tenants. | +| assetId | string | The id of the app in the office store, this will be empty for app catalog user uploaded apps. | +| purchaserIdentity | string | The identify of person who bought the license of the add-in. | +| licensePurchaseTime | DateTime | When purchased the app license. | +| locale | string | which locale installed on the site. | +| appSource | string | Indicate where the app come from. | +| tenantAppData | string | After the Add-in installed in the tenant app catalog site. It could enable tenant level usage. This data indicates the conditions how to filter the sites. If this field is not empty, it means this Add-in installed on tenant app catalog site, deployed to tenant level, and current site matches the conditions. For more information, see [Tenancies and deployment scopes for SharePoint Add-ins](../sp-add-ins/tenancies-and-deployment-scopes-for-sharepoint-add-ins.md). | +| tenantAppDataUpdateTime | DateTime | The tenant app data update time. | + +### SPErrorWithServerRelativeUrl + +| Name | Type | Description | +|-------------------|--------|--------------------------------------------------------| +| serverRelativeUrl | string | The serverRelativeUrl or url in the request body. | +| errorMessage | string | The error message why fetch the site's Add-ins failed. | + +## Get Add-in permissions in site collections + +This API will return the permissions that were granted to the add-in. For more information, see [Add-in permissions in SharePoint](../sp-add-ins/add-in-permissions-in-sharepoint.md). + +This API needs the app to have at least Sites.Read.All permission. + +### HTTP request + +```HTTP +POST {adminSiteUrl}/_api/web/AddinPermissions +``` + +### Request body + +| Name | Required | Type | Description | +|--------|----------|----------------------------|----------------------------------------------------------------------------------| +| addins | yes | SPAddinPermissionRequest[] | List of the Add-in that want to get the permissions. Maximum Add-in size is 500. | + +#### SPAddinPermissionRequest + +| Name | Type | Description | +|-------------------|----------|-------------------------------------------------------------------------------------------| +| serverRelativeUrl | string | The server relative url of the site collection. | +| url | string | The url of the site collection, both server relative url and absolute url are acceptable. | +| appIdentifiers | string[] | The identifier list of the Add-ins. | + +The serverRelativeUrl and url can't be both null. If both serverRelativeUrl and url are provided, the url will be used. + +### Responses +| Name | Type | Description | +|------------------|-------------------------------|-----------------------------------------------------------------------| +| addinPermissions | SPAddinPermissionInfo[] | The returned permissions. | +| failedAddins | SPAddinPermissionFailedInfo[] | The Add-ins that failed to get permissions and corresponding reasons. | + +#### SPAddinPermissionInfo + +| Name | Type | Description | +|---------------------------------|----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| tenantScopedPermissions | SPTenantScopedPermissionInfo[] | This is the permissions grant in tenant scope level. | +| siteCollectionScopedPermissions | SPSiteCollectionScopedPermissionInfo[] | This is the permissions grant in site collection scope level. | +| appIdentifier | string | The identifier of the Add-in. | +| serverRelativeUrl | string | The server relative url of the site collection. | +| absoluteUrl | string | The absolute url of the site collection. | +| allowAppOnly | bool | This identifies if the Add-in allows app only mode. For more information, see [Add-in authorization policy types in SharePoint](../sp-add-ins/add-in-authorization-policy-types-in-sharepoint.md). | + +#### SPTenantScopedPermissionInfo + +| Name | Type | Description | +|---------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| feature | string | The feature name of the permissions, it should be one of these:
  • Taxonomy
  • Social
  • ProjectServer
  • Search
  • BcsConnection
  • Content
| +| scope | string | The scope of the permission. | +| right | string | The right of the permission. | +| id | Guid | The id of the resource that the Add-in have permission to. For example, it may be the id of one specific project when the feature is ProjectServer and the scope is projectserver/projects/project. | + + +#### SPSiteCollectionScopedPermissionInfo + +| Name | Type | Description | +|--------|--------|------------------------------------------------------------------------------------------------------------------------------------------------| +| siteId | Guid | The site collection id which the Add-in has access to. | +| webId | Guid | The site id which the Add-in has access to. If this field is empty, then the permission grant in site collection level. | +| listId | Guid | The list id which the Add-in has access to. If this field is empty, then the permission grant in site collection level or grant is site level. | +| right | string | Available rights: Guest, Read, Write, Manage, FullControl. | + + +#### SPAddinPermissionFailedInfo + +| Name | Type | Description | +|-------------------|--------|-----------------------------------------------------------------| +| serverRelativeUrl | string | The server relative url or absolute url of the site collection. | +| appIdentifier | string | The identifier list of the Add-in. | +| errorMessage | string | The error message why fetch the Add-in permission failed. | + +## Get tenant ACS service principals + +This API takes the app id list as input, it will filter the ones that present ACS service principals. +For more information, see [Register SharePoint Add-ins](../sp-add-ins/register-sharepoint-add-ins.md). + +This API needs the app to have at least Sites.Read.All permission. + +### HTTP request + +```HTTP +POST {adminSiteUrl}/_api/web/GetACSServicePrincipals +``` + +### Request body + +| Name | Required | Type | Description | +|--------|----------|--------|------------------------------------| +| appIds | yes | Guid[] | List app ids. Maximum size is 500. | + +### Responses + +| Name | Type | Description | +|------|-----------------------------|-------------------------------------| +| | SPACSServicePrincipalInfo[] | The SPACSServicePrincipalInfo list. | + +#### SPACSServicePrincipalInfo + +| Name | Type | Description | +|---------------|----------|-----------------------------------------------------------------------------------------------| +| appIdentifier | string | The app identifier of the Add-in. | +| appId | Guid | The app id of the Add-in. | +| title | string | A user friendly title. | +| redirectUri | string | The endpoint in your remote application or service to which ACS sends an authentication code. | +| appDomains | string[] | The host name of the remote component of the SharePoint Add-in. | + +## Get Add-in principals in site collections + +This API takes the site collections' server relative url as input, it will return the Add-in principals that have permissions in given sites. + +This API needs the app to have at least Sites.Read.All permission. + +### HTTP request + +```HTTP +POST {adminSiteUrl}/_api/web/GetAddinPrincipalsHavingPermissionsInSites +``` + +### Request body + +| Name | Required | Type | Description | +|--------------------|----------|----------|------------------------------------------------------------------------------------------------------------| +| serverRelativeUrls | no | string[] | List site collections' server relative url. Maximum size is 500. | +| urls | no | string[] | List site collections' url, both server relative url and absolute url are acceptable. Maximum size is 500. | + +When urls is not null, serverRelativeUrls will be disregarded. + +### Responses + +| Name | Type | Description | +|-----------------------------|--------------------------------|-------------| +| addinPrincipals | SPAddinPrincipalInfo[] | | +| errorsWithServerRelativeUrl | SPErrorWithServerRelativeUrl[] | | + +#### SPAddinPrincipalInfo + +| Name | Type | Description | +|-------------------|--------|-------------------------------------------------| +| title | string | The title of the Add-in. | +| appIdentifier | string | The app identifier. | +| serverRelativeUrl | string | The server relative url of the site collection. | +| absoluteUrl | string | The absolute url of the site collection. | + + +#### SPErrorWithServerRelativeUrl + +| Name | Type | Description | +|-------------------|--------|------------------------------------------------------------| +| serverRelativeUrl | string | The site collection's server relative url or absolute url. | +| errorMessage | string | The error message why fetch the Add-in principal failed. | + +## Uninstall Add-ins + +This API will trigger an async job to uninstall the Add-in. If the job triggered successfully, the job id will be returned. + +This API needs the app to have Sites.FullControl.All permission. + +### HTTP request + +```HTTP +POST {adminSiteUrl}/_api/web/UninstallAddins +``` + +### Request body + +| Name | Required | Type | Description | +|-----------------|----------|---------------------------|---------------------------------------------------------------| +| uninstallAddins | yes | SPUninstallAddinRequest[] | List of Add-ins need to uninstall. Maximum Add-in size is 50. | + +#### SPUninstallAddinRequest + +| Name | Type | Description | +|-------------------|--------|---------------------------------------------------------------------------| +| serverRelativeUrl | string | The site's server relative url. | +| url | string | The site's url, both server relative url and absolute url are acceptable. | +| appInstanceIds | Guid[] | The instance ids of the Add-ins. | + +The serverRelativeUrl and url can't be both null. If both serverRelativeUrl and url are provided, the url will be used. + +### Responses + +| Name | Type | Description | +|-----------|--------------------------------------------|---------------------------------------------------------------------------| +| executing | SPTriggeredUninstallAddinJobResponse[] | This field contains the ones that successed to trigger the uninstall job. | +| failed | SPFailToTriggerUninstallAddinJobResponse[] | This field contains the ones that failed to trigger the uninstall job. | + +#### SPTriggeredUninstallAddinJobResponse + +| Name | Type | Description | +|-------------------|--------|---------------------------------| +| appInstanceId | Guid | The instance id of the Add-in. | +| serverRelativeUrl | string | The site's server relative url. | +| absoluteUrl | string | The site's absolute url. | +| uninstallJobId | Guid | The triggered uninstall job id. | + +#### SPFailToTriggerUninstallAddinJobResponse + +| Name | Type | Description | +|-------------------|--------|---------------------------------------------------------| +| appInstanceId | Guid | The instance id of the Add-in. | +| serverRelativeUrl | string | The site's server relative url. | +| errorMessage | Guid | The error message why the uninstall job trigger failed. | + + +## Get uninstall Add-in job status + +Since the uninstall Add-in is an async process, this API will provide the ability to check if the uninstall ends successfully. +If the job ends successfully, then the job will be not found. If the job ends with failure, then it will return the error detail. + +This API needs the app to have at least Sites.Read.All permission. + +### HTTP request + +```HTTP +POST {adminSiteUrl}/_api/web/GetAddinUninstallJobDetail +``` + +### Request body + +| Name | Required | Type | Description | +|-------------------|----------|--------|----------------------------------------------------------------------------| +| jobId | yes | Guid | This uninstall job id. | +| serverRelativeUrl | no | string | The site's server relative url. | +| url | no | string | The site's url, both server relative url and absolute url are acceptable. | + +The serverRelativeUrl and url can't be both null. If both serverRelativeUrl and url are provided, the url will be used. + +### Responses + +| Name | Type | Description | +|-------------------|-------------------------------|--------------------------------------------------| +| serverRelativeUrl | string | The site's server relative url. | +| absoluteUrl | string | The site's absolute url. | +| taskStartTime | DateTime | The time when the task starts executing. | +| jobId | Guid | The uninstall job id. | +| siteId | Guid | The site collection id. | +| appInstanceId | Guid | The id of the app instance. | +| errorDetails | SPUninstallAddinErrorDetail[] | The error details for the job ends with failure. | + +#### SPUninstallAddinErrorDetail + +| Name | Type | Description | +|------------------|--------|-------------------------------------| +| detail | string | The error detail. | +| exceptionMessage | string | The exception message of the error. | +| source | string | The source of the error. | +| type | string | The type of the error. | +| correlationId | Guid | The job's correlation id. | diff --git a/docs/apis/alm-api-for-spfx-add-ins.md b/docs/apis/alm-api-for-spfx-add-ins.md index 3429dd395..41afaff9a 100644 --- a/docs/apis/alm-api-for-spfx-add-ins.md +++ b/docs/apis/alm-api-for-spfx-add-ins.md @@ -1,10 +1,10 @@ --- title: Application Lifecycle Management (ALM) APIs description: ALM APIs provide simple APIs to manage deployment of your SharePoint Framework solutions and add-ins across your tenant. -ms.date: 09/07/2020 -ms.prod: sharepoint +ms.date: 06/28/2022 +ms.subservice: migration-tool ms.assetid: fdf7ecb2-8851-425b-b058-3285fba77b68 -localization_priority: Priority +ms.localizationpriority: high --- # Application Lifecycle Management (ALM) APIs @@ -28,7 +28,7 @@ ALM APIs can be used to perform exactly the same operations that are available f ALM APIs are supported for the tenant-scoped site collections and [site collection app catalog](../general-development/site-collection-app-catalog.md). Use the corresponding app catalog's URL to target a specific app catalog. You must first enabled a site collection app catalog before targeting it with the actions documented on this page. > [!IMPORTANT] -> Tenant-scoped permissions which require [tenant administrative approval](https://docs.microsoft.com/sharepoint/dev/solution-guidance/how-to-provide-add-in-app-only-tenant-administrative-permissions-in-sharepoint-online) are not supported with the ALM APIs. +> Tenant-scoped permissions which require [tenant administrative permissions](../solution-guidance/how-to-provide-add-in-app-only-tenant-administrative-permissions-in-sharepoint-online.md) are not supported with the ALM APIs. ## Options for working with ALM APIs @@ -42,12 +42,12 @@ The app catalog must be included in all HTTP requests when using the REST API as For example: -| Scope | Endpoint | -| :-------------- | :--------------------------------------------------------------------------------------------- | -| tenant | **https://contoso.sharepoint.com/sites/AppCatalog/_api/web/tenantappcatalog/{command}** | -| site collection | **https://contoso.sharepoint.com/sites/Marketing/_api/web/sitecollectionappcatalog/{command}** | +| Scope | Endpoint | +| :-------------- | :------------------------------------------------------------------------------------------- | +| tenant | `https://contoso.sharepoint.com/sites/AppCatalog/_api/web/tenantappcatalog/{command}` | +| site collection | `https://contoso.sharepoint.com/sites/Marketing/_api/web/sitecollectionappcatalog/{command}` | -- when targeting the tenant app catalog located at **https://contoso.sharepoint.com/sites/AppCatalog**, the endpoint would be ** +- when targeting the tenant app catalog located at `https://contoso.sharepoint.com/sites/AppCatalog`, the endpoint would be ** Learn more here: [SharePoint REST API](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md) @@ -57,7 +57,7 @@ The PnP CSOM implements the ALM APIs by calling the SharePoint REST API. Before using any of the ALM APIs in PnP CSOM, you need to obtain an authenticated client context using the [Microsoft.SharePointOnline.CSOM](https://www.nuget.org/packages/Microsoft.SharePointOnline.CSOM). Then use the authenticated client context to get an instance of the PnP CSOM's **AppManager** object to call the ALM commands: -```cs +```csharp using Microsoft.SharePoint.Client; using OfficeDevPnP.Core.ALM; @@ -72,7 +72,7 @@ using (var context = new ClientContext(webURL)) { In all PnP Core methods, it's assumed the request targets the tenant app catalog in the tenant you connect to using the SharePoint CSOM `ClientContext` object. you can override the scope of all commands with an optional scope argument, for example -```cs +```csharp appManager.Install('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx', AppCatalogScope.Site); ``` @@ -128,7 +128,7 @@ Byte array of the file # [PnP CSOM](#tab/pnpcsom) -```cs +```csharp // read file var filePath = "c:\path\to\file\sharepoint-solution-package.sppkg"; // get an instance of the PnP CSOM's AppManager as shown above @@ -141,7 +141,7 @@ var result = appManager.Add(filePath); Add-PnPApp -Path ./sharepoint-solution-package.sppkg ``` -> Refer to the [PnP PowerShell documentation](/powershell/module/sharepoint-pnp/add-pnpapp) for complete details and examples on this cmdlet. +> Refer to the [PnP PowerShell documentation](https://pnp.github.io/powershell/cmdlets/Add-PnPApp.html) for complete details and examples on this cmdlet. # [CLI for Microsoft 365](#tab/o365cli) @@ -190,7 +190,7 @@ POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx- # [PnP CSOM](#tab/pnpcsom) -```cs +```csharp appManager.Deploy('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') ``` @@ -200,7 +200,7 @@ appManager.Deploy('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') Publish-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx ``` -> Refer to the [PnP PowerShell documentation](/powershell/module/sharepoint-pnp/Publish-PnPApp) for complete details and examples on this cmdlet. +> Refer to the [PnP PowerShell documentation](https://pnp.github.io/powershell/cmdlets/Publish-PnPApp.html) for complete details and examples on this cmdlet. # [CLI for Microsoft 365](#tab/o365cli) @@ -237,7 +237,7 @@ POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx- # [PnP CSOM](#tab/pnpcsom) -```cs +```csharp // get an app package appManager.Retract('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') ``` @@ -248,7 +248,7 @@ appManager.Retract('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') Unpublish-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx ``` -> Refer to the [PnP PowerShell documentation](/powershell/module/sharepoint-pnp/Unpublish-PnPApp) for complete details and examples on this cmdlet. +> Refer to the [PnP PowerShell documentation](https://pnp.github.io/powershell/cmdlets/Unpublish-PnPApp.html) for complete details and examples on this cmdlet. # [CLI for Microsoft 365](#tab/o365cli) @@ -274,7 +274,7 @@ POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx- # [PnP CSOM](#tab/pnpcsom) -```cs +```csharp appManager.Remove('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') ``` @@ -284,7 +284,7 @@ appManager.Remove('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') Remove-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx ``` -> Refer to the [PnP PowerShell documentation](/powershell/module/sharepoint-pnp/Remove-PnPApp) for complete details and examples on this cmdlet. +> Refer to the [PnP PowerShell documentation](https://pnp.github.io/powershell/cmdlets/Remove-PnPApp.html) for complete details and examples on this cmdlet. # [CLI for Microsoft 365](#tab/o365cli) @@ -357,7 +357,7 @@ GET /_api/web/{scope}appcatalog/AvailableApps # [PnP CSOM](#tab/pnpcsom) -```cs +```csharp var allAppPackages = appManager.GetAvailable(); ``` @@ -367,7 +367,7 @@ var allAppPackages = appManager.GetAvailable(); Get-PnPApp ``` -> Refer to the [PnP PowerShell documentation](/powershell/module/sharepoint-pnp/Get-PnPApp) for complete details and examples on this cmdlet. +> Refer to the [PnP PowerShell documentation](https://pnp.github.io/powershell/cmdlets/Get-PnPApp.html) for complete details and examples on this cmdlet. # [CLI for Microsoft 365](#tab/o365cli) @@ -419,7 +419,7 @@ GET /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-x # [PnP CSOM](#tab/pnpcsom) -```cs +```csharp var appPackage = appManager.GetAvailable('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx'); ``` @@ -463,7 +463,7 @@ POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx- # [PnP CSOM](#tab/pnpcsom) -```cs +```csharp // get an app package appManager.Install('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') ``` @@ -474,7 +474,7 @@ appManager.Install('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') Install-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx ``` -> Refer to the [PnP PowerShell documentation](/powershell/module/sharepoint-pnp/Install-PnPApp) for complete details and examples on this cmdlet. +> Refer to the [PnP PowerShell documentation](https://pnp.github.io/powershell/cmdlets/Install-PnPApp.html) for complete details and examples on this cmdlet. # [CLI for Microsoft 365](#tab/o365cli) @@ -508,7 +508,7 @@ POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx- # [PnP CSOM](#tab/pnpcsom) -```cs +```csharp // get an app package var appPackage = appManager.GetAvailable('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx'); if (appPackage.CanUpgrade) { @@ -522,7 +522,7 @@ if (appPackage.CanUpgrade) { Update-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx ``` -> Refer to the [PnP PowerShell documentation](/powershell/module/sharepoint-pnp/update-pnpapp) for complete details and examples on this cmdlet. +> Refer to the [PnP PowerShell documentation](https://pnp.github.io/powershell/cmdlets/Update-PnPApp.html) for complete details and examples on this cmdlet. # [CLI for Microsoft 365](#tab/o365cli) @@ -559,7 +559,7 @@ POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx- # [PnP CSOM](#tab/pnpcsom) -```cs +```csharp appManager.Uninstall('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') ``` @@ -569,7 +569,7 @@ appManager.Uninstall('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') Uninstall-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx ``` -> Refer to the [PnP PowerShell documentation](/powershell/module/sharepoint-pnp/Uninstall-PnPApp) for complete details and examples on this cmdlet. +> Refer to the [PnP PowerShell documentation](https://pnp.github.io/powershell/cmdlets/Uninstall-PnPApp.html) for complete details and examples on this cmdlet. # [CLI for Microsoft 365](#tab/o365cli) @@ -603,7 +603,7 @@ POST /_api/web/{scope}appcatalog/SyncSolutionToTeams(id=xxxxx) # [PnP CSOM](#tab/pnpcsom) -```cs +```csharp appManager.SyncToTeams('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') ``` @@ -613,7 +613,7 @@ appManager.SyncToTeams('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx') Sync-PnPAppToTeams -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx ``` -> Refer to the [PnP PowerShell documentation](/powershell/module/sharepoint-pnp/sync-pnpapptoteams) for complete details and examples on this cmdlet. +> Refer to the [PnP PowerShell documentation](https://pnp.github.io/powershell/cmdlets/Sync-PnPAppToTeams.html) for complete details and examples on this cmdlet. # [CLI for Microsoft 365](#tab/o365cli) diff --git a/docs/apis/amr-api-reference.md b/docs/apis/amr-api-reference.md new file mode 100644 index 000000000..2c3e44aa8 --- /dev/null +++ b/docs/apis/amr-api-reference.md @@ -0,0 +1,253 @@ +--- +title: "SharePoint Asynchronous Metadata Read (AMR) API Reference Guide" +description: "This article provides in-depth information on how to use the SharePoint AMR API." +ms.date: 04/18/2024 +ms.author: ranren +author: underreview +manager: dapodean +audience: ITPro +ms.subservice: migration-tool +ms.topic: article +ms.localizationpriority: high +ms.collection: + - SPMigration + - m365-collaboration +--- +# SharePoint Asynchronous Metadata Read (AMR) API Reference Guide + +Use this document as the guide when using SharePoint Asynchronous Metadata Read (AMR) API. + +AMR API aggregates SharePoint metadata into a manifest package. Use the package for incremental migration, structure creation, post-migration validation, or permission management. + +## CSOM and REST + +AMR API supports both SharePoint Client Side Object Model (CSOM) and REST. + +### Use NuGet Packages with CSOM + +To reference the SharePoint Client Side Object Model (CSOM) in your solution, use NuGet packages. + +Manage dependencies easily and ensure your solution is using the latest version of the CSOM library with NuGet packages. + +Get the latest version of the CSOM package at the [SharePoint Client-side Object Model Libraries](https://www.nuget.org/packages/Microsoft.SharePointOnline.CSOM) with the ID `Microsoft.SharePointOnline.CSOM`. + +Check [Get to know SharePoint REST service](/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service) for instructions on REST API. + +## CreateSPAsyncReadJob method + +Creates an AMR job to read all the metadata of the specified SharePoint URL and its children into the specified manifest container. + +### CreateSPAsyncReadJob syntax + +```csharp +public SPAsyncReadJobInfo CreateSPAsyncReadJob(String url, +SPAsyncReadOptions readOptions, +EncryptionOption encryptionOption, +string azureContainerManifestUri, +string azureQueueReportUri) +``` + +### CreateSPAsyncReadJob parameters + +#### url + +Required. + +A **String** value containing the full path URL of the path of the SharePoint List, files/folders, or Document Library **to read**. AMR API returns all the metadata of files, folders, and root objects, **including subfolders and any children content**. + +##### Example + +This example `url` returns all metadata of Shared Document, and its children: + +```http +https://www.contoso.com/Shared%20Document +``` + +#### readOptions + +Required. + +A `SPAsyncReadOptions` structure, with `readOption` values specifying the types of metadata to read. + +##### IncludeVersions + +Optional. + +A **Bool** value to indicate if AMR API reads multiple versions of files and List Items. + +Default value is `false`. When absent or set to `false`, AMR API only reads the latest version of items. + +##### IncludeSecurity + +Optional. + +A **Bool** value to indicate if AMR API reads Users and Groups information related to a Site. + +Default value is `false`. + +AMR API reads Users and Groups as Authors or Modifiers as part of the metadata of the objects. + +If set to `true`, AMR API reads all Users in Site Collections. When reading multiple Document Libraries under the same Site Collection, the same Users and Group might appear in the read package multiple times. + +##### IncludeDirectDescendantsOnly + +Optional. + +A **Bool** value to indicate if AMR API reads only the metadata of the direct descendants. + +Default value is `false`. + +If set to `true`, AMR API reads only the metadata of the direct descendants. + +Use this `readOption` along with `IncludeSecurity` `readOption` together to improve performance when reading metadata from a Document Library containing large number of items, as described in [Best practice](export-amr-api.md) to avoid slow performance. + +##### IncludeExtendedMetadata + +Optional. + +Default value is `false`. + +When set to `false`, AMR API reads basic metadata: + +- List +- Folder +- File +- List Item +- Roles +- Role Assignments + +When set to `true`, AMR API reads all metadata available: + +For Files: + +- Web Part +- Web Part personalization +- Links +- Version events +- Event receivers +- Attachment metadata + +For Lists: + +- Custom actions +- List shortcuts + +For List Items: + +- Comments +- Documents set links +- Activities +- List Item shortcuts + +Including extended metadata slows down the read significantly. For file share migrations, keep the default value `false`. Set to `true` only when necessary, for complex migration projects. + +##### IncludePermission + +Optional. + +A **Bool** value to indicate if permissions read is needed. Default value is `false`. + +When set to `true`, AMR API reads permission metadata in `RoleAssignments` tags in `Manifest.xml` files. The file includes all distinguished permission metadata for each read SharePoint object, along with property `ScopeId`. + +##### StartChangeToken + +Optional. + +A **Integer** value containing the changeToken item. + +By default, when no `StartChangeToken` is provided, `CreateSPAsyncReadJob` method returns all items available, based on the parameters. A `CurrentChangeToken` value is returned every time. + +To read only the items that changed since last read, set a `StartChangeToken` in subsequent calls to `CreateSPAsyncReadJob`. Use `CurrentChangeToken` returned from last call as the value of `StartChangeToken`. + +AMR API returns an error and stops the read, if it receives an invalid `StartChangeToken` value. + +Be careful when using this feature with large number of items. The read job could run for extended duration. AMR API cancels jobs that run over 10 minutes to protect the SharePoint infrastructure. + +#### encryptionOption + +Optional. + +A `EncryptionOption` object, containing the AES-256-CBC Key used to decrypt the output. + +By default, AMR API doesn't encrypt the output and event queue. If set with AES-256-CBC Key, AMR API encrypts the output with the key supplied. + +See [`EncryptionOption`](/dotnet/api/microsoft.sharepoint.client.encryptionoption) class for details. + +#### azureContainerManifestUri + +Required. + +A **String** value, which is the destination URL of the Azure Blob Storage Container containing the output manifest package. + +See [Azure](migration-azure.md) for instructions of using Azure Blob Storage Container in migration. + +#### azureQueueReportUri + +Required. + +A **String** value, which is the URL of the Azure Queue to receive read status messages. + +Share `azureQueueReportUri` among different jobs if necessary. AMR API returns `JobID` to identify individual jobs created. + +See [Azure](migration-azure.md) for instructions of using Azure Queue in migration. Check [Migration events in Azure Queue](migration-events.md) for types of events. + +### CreateSPAsyncReadJob return values + +#### Job ID + +A **Guid** value, which contains Job ID, the unique identifier of the migration job. The method returns a `null` value, if it fails to create the job. + +AMR API generates a `JobEnd` event when it estimates item count for each `url`. Check [Events](migration-events.md) for details. + +#### AzureContainerManifest + +A **Uri** value that contains the URL to access the Azure Blob Storage Container, which contains the metadata read. + +#### JobQueueUri + +A **Uri** value that contains the URL of the Azure Queue used for read status. + +#### EncryptionKey + +A **Byte Array** value that contains the AES-256-CBC Key for decrypting the manifest files and messages in the Azure Queue. + +## CreateSPAsyncReadJobWithMultiUrl method + +Creates an AMR job to read all the metadata of all SharePoint URLs specified, and their children into the specified manifest container. + +### CreateSPAsyncReadJobWithMultiUrl syntax + +```csharp +public SPAsyncReadJobInfo CreateSPAsyncReadJobWithMultiUrl( + String[] urls, + SPAsyncReadOptions readOptions, + EncryptionOption encryptionOption, + String azureContainerManifestUri, + String azureQueueReportUri) +``` + +### CreateSPAsyncReadJobWithMultiUrl parameters + +See `CreateSPAsyncReadJob` method for details of `readOptions`, `encryptionOption`, `azureContainerManifestUri`, and `azureQueueReportUri`. + +#### urls + +Required. + +A **Uri** **Array** containing the full path URLs of the root paths of the SharePoint Lists, files/folders, or Document Libraries to read. AMR API returns all the metadata of files, folders, and root objects, **including subfolders and any children content**. + +Specify multiple URLs when needed. Aggravated call with multiple URLs might improve the performance. See [Performance](export-amr-api.md#performance) for details. + +## Errors + +### -2146232832 + +The changeToken refers to a time before the start of the current change log. + +The change log is limited to 60 days immediately before the current date. AMR API returns this error code when the specified `changeToken` refers to a time outside the 60-day window. + +### -2147213196 + +Operation canceled. + +AMR API received a cancellation request from the client and cancels the read operation. diff --git a/docs/apis/csom-methods-for-applying-retention-labels.md b/docs/apis/csom-methods-for-applying-retention-labels.md new file mode 100644 index 000000000..ddde1e391 --- /dev/null +++ b/docs/apis/csom-methods-for-applying-retention-labels.md @@ -0,0 +1,143 @@ +--- +title: CSOM methods for retention labels +description: CSOM methods are available to apply (set) a retention label (ComplianceTag) on one or many items (ListItems) in SharePoint. Also includes settings of retention labels in ODB and SPO. +author: kyracatwork +ms.author: kyrachurney +ms.date: 9/30/2024 +--- + +# CSOM methods for applying retention labels and managing settings of record labels + +Retention labels let you apply retention settings for governance control at the item level, and are part of the Microsoft Purview compliance solutions. [Learn more about retention labels.](/microsoft-365/compliance/retention#retention-labels) + +Retention labels may classify contents as records, which place restrictions on what actions are allowed or blocked. [Learn more about declaring records by using retention labels](/microsoft-365/compliance/declare-records) + +CSOM methods are available to apply (set) a retention label (ComplianceTag) on one or many items (ListItems) in SharePoint, and change retention labels settings for deleting, versioning, and changing properties of records. Retention labels can be applied using this method without being published to the location by an existing label policy. + +## SetComplianceTagOnBulkItems + +This method can be used to set a ComplianceTag on one or many ListItems. It is strongly recommended to use this method for this purpose. + +```c# +public List SetComplianceTagOnBulkItems( + List itemIds, + string listUrl, + string complianceTagValue) +``` + +### Parameters + +- 'List' [Int](/en-us/dotnet/api/system.int32) +- 'ItemsIds' [String](/dotnet/api/system.string) +- 'ListURL' [String](/dotnet/api/system.string) +- 'ComplianceTagValue' [String](/dotnet/api/system.string) + +Attribute [RemoteAttribute](/dotnet/api/microsoft.sharepoint.client.remoteattribute) + +## GetAllowFilesWithKeepLabelToBeDeletedODB + +Get whether files with Keep Label can be deleted in ODB. + + +```c# + +public static bool GetAllowFilesWithKeepLabelToBeDeletedODB() +``` + +## SetAllowFilesWithKeepLabelToBeDeletedODB + +Set whether files with Keep Label can be deleted in ODB + + +```c# +public static void SetAllowFilesWithKeepLabelToBeDeletedODB(bool allowDeletion) +``` + +Parameters + +- 'allowDeletion' [Boolean](/dotnet/api/system.boolean) + +## GetAllowFilesWithKeepLabelToBeDeletedSPO +Get whether files with Keep Label can be deleted in SPO. + +```c# + +public static bool GetAllowFilesWithKeepLabelToBeDeletedSPO() +``` + +## SetAllowFilesWithKeepLabelToBeDeletedSPO + +Set whether files with Keep Label can be deleted in SPO. + +```c# +public static void SetAllowFilesWithKeepLabelToBeDeletedSPO(bool allowDeletion) +``` + +Parameters + +- 'allowDeletion' [Boolean](/dotnet/api/system.boolean) + +## GetAdvancedRecordVersioningDisabled + +Get whether advanced record versioning is disabled. + +```c# + +public static bool GetAdvancedRecordVersioningDisabled() +``` + +## SetAdvancedRecordVersioningDisabled + +Set to enable or disable the advanced record versioning. + +```c# +public static void SetAdvancedRecordVersioningDisabled(bool disabled) +``` + +Parameters + +- 'disabled' [Boolean](/dotnet/api/system.boolean) + +## GetMetadataEditBlockingEnabled + +Get whether metadata edit blocking is enabled. + +```c# + +public static bool GetMetadataEditBlockingEnabled() + +``` + +## SetMetadataEditBlockingEnabled + +Set metadata edit blocking enabled setting. + + +```c# +public static void SetMetadataEditBlockingEnabled(bool enabled) +``` + +Parameters + +- 'enabled' [Boolean](/dotnet/api/system.boolean) + +### Applies to + +|Product|Versions| +|:---|:---| +|SharePoint CSOM|latest| + +## Other + +> [!NOTE] +> It is strongly recommended to use SetComplianceTagOnBulkItems instead of these methods. + +The following methods are also available, but are no longer updated and may be subject to deprecation in the future. If you are using these methods, we strongly recommend use of the SetComplianceTagOnBulkItems method instead. + +* [SetComplianceTag](/dotnet/api/microsoft.sharepoint.client.listitem.setcompliancetag) +* [SetComplianceTagWithExplicitMetaInfo](/dotnet/api/microsoft.sharepoint.client.listitem.setcompliancetagwithexplicitmetasupdate) +* [SetComplianceTagWithExplicitMetasUpdate](/dotnet/api/microsoft.sharepoint.client.listitem.setcompliancetagwithexplicitmetasupdate) +* [SetComplianceTagWithHold](/dotnet/api/microsoft.sharepoint.client.listitem.setcompliancetagwithhold) +* [SetComplianceTagWithMetaInfo](/dotnet/api/microsoft.sharepoint.client.listitem.setcompliancetagwithmetainfo) +* [SetComplianceTagWithNoHold](/dotnet/api/microsoft.sharepoint.client.listitem.setcompliancetagwithnohold) +* [SetComplianceTagWithRecord](/dotnet/api/microsoft.sharepoint.client.listitem.setcompliancetagwithrecord) diff --git a/docs/apis/export-amr-api-permission-guide.md b/docs/apis/export-amr-api-permission-guide.md new file mode 100644 index 000000000..55a921cc2 --- /dev/null +++ b/docs/apis/export-amr-api-permission-guide.md @@ -0,0 +1,167 @@ +--- +title: "SharePoint Migration Export (Asynchronous Metadata Read) API permission guide" +description: This article targets ISVs and any third-party vendors/developers who are developing and maintaining a migration tool and explains the permission details and options in the export API. +ms.date: 08/25/2023 +ms.author: jhendr +author: JoanneHendrickson +manager: Serdars +audience: ITPro +ms.subservice: migration-tool +ms.topic: article +ms.localizationpriority: high +ms.collection: + - SPMigration + - m365-collaboration +--- + +# AMR Export Permission Guide + +The Asynchronous Metadata Read (AMR) API export permission lets you export SharePoint Online metadata permission info using a new export option. This guide will show you how to use this option and what changes have been introduced to the export result. + +## How to use AMR export permission option + +For both CSOM and RESTFul calls, add the below option to enable/disable AMR export permission: + +- For CSOM, when building `AsyncReadOptions` object, set `IncludePermission` property to `true` or `false`. + - If you cannot use `IncludePermission` property, please update your CSOM nuget package to the latest version. +- For RESTFul, add `IncludePermission` key to the request JSON payload's `readOptions` section, and set it to `true` or `false`. + - For example: `{..., "readOptions":{...,"IncludePermission":true,...}...}` + +## What changes have been introduced to the export result + +The new `IncludePermission=true` option will involve an additional tag called `` into **Manifest.xml** file in the export result, which includes all distinguished permission info for each exported SPO object with property `ScopeId`, like below: + +```xml +<...> + + + + + ... + + +<...> +``` + +The `RoleAssignments` tag is a list of `RoleAssignment` tags, each `RoleAssignment` tag represents a unique permission scope from exported SPO objects, identified by `ScopeId`. Each `RoleAssignment` tag contains multiple `Assignment` tags, representing an entity within that specific unique permission scope each, such as a user, a group, etc., with a principal ID. + +In the meantime, all involved entities will be listed in **UserGroup.xml** file in the export result, to help further user resolution. + +Here is an example of **Manifest.xml** file and **UserGroup.xml** with `IncludePermission=true` option: + +```xml + +<...> + + + +<...> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +<...> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +## Option interaction between `IncludeSecurity` and `IncludePermission` + +Before the `IncludePermission` option, the `IncludeSecurity` option has been already used to get a full list of all user & group information of the target site. It isn't necessary that you use the `IncludePermission` option with `IncludeSecurity` option. However, if you still want to get a full list of all user and group information of target sites with permission information, you can use `IncludePermission` option with `IncludeSecurity` option together, here are the 4 combinations of the two options with expected results: + +- `IncludeSecurity=true` only: get a full list of all user & group information of the target site without permission information. +- `IncludePermission=true` only: get exported items' permission information, with a list of corresponding user & group information of exported permissions. +- `IncludeSecurity=true` + `IncludePermission=true`: get exported items' permission information, with a full list of all user & group information of the target site. +- None of them is used: get no permission, nor related user & group information. diff --git a/docs/apis/export-amr-api.md b/docs/apis/export-amr-api.md index cc32b433f..fe7248b8f 100644 --- a/docs/apis/export-amr-api.md +++ b/docs/apis/export-amr-api.md @@ -1,367 +1,123 @@ --- -title: "SharePoint Migration Export (Asynchronous Metadata Read) API" -ms.date: 07/31/2020 -ms.reviewer: -ms.author: jhendr -author: JoanneHendrickson -manager: pamgreen +title: "SharePoint Asynchronous Metadata Read (AMR) API Introduction" +description: Overview how to read metadata from SharePoint, targeted to SharePoint migration tool developers. +ms.date: 07/23/2025 +ms.author: ranren +author: underreview +manager: dapodean audience: ITPro +ms.subservice: migration-tool ms.topic: article -localization_priority: Priority -ms.collection: -- SPMigration -- m365-collaboration -description: "SharePoint Migration Export (Asynchronous Metadata Read) API" +ms.localizationpriority: high +ms.collection: + - SPMigration + - m365-collaboration --- +# SharePoint Asynchronous Metadata Read (AMR) API Introduction -# SharePoint Migration Export (Asynchronous Metadata Read) API +The SharePoint Asynchronous Metadata Read (AMR) API enables the asynchronous export of metadata from SharePoint and OneDrive. -## Overview +Use AMR API to export metadata from SharePoint for incremental migration and post-migration validation. -The goal of the new Migration Asynchronous Metadata Read (AMR) API is to reduce the number of calls, reduce throttling, and improve overall migration performance for our customers. Instead of calling thousands of calls to query information from SPO, the new Migration Asynchronous Metadata Read can return the same amount of data in a single read. +AMR is designed exclusively for import scenarios. It exhibits poor scalability when handling requests for metadata, permissions, or versions. We can't provide performance assurances for AMR usage in data export scenarios, such as cross-tenant migrations. -When the new SharePoint Migration Export (Asynchronous Metadata Read) API performs a read operation of a provided URL, the Microsoft backend software aggregates all the information into a designated manifest. The ISV can read back from the manifest and parse the metadata without sending thousands of calls individually. The AMR API also has the ability to load balance the server, and supports an unlimited amount of metadata to be migrated. +## What's new -This document targets ISVs and any third-party vendors/developers who are developing and maintaining a migration tool. +### January 2024 -### Background +We reformatted this document to bring clarity and correct errors. -Currently, the SharePoint Online Migration API, [CreateMigrationJob](https://docs.microsoft.com/sharepoint/dev/apis/migration-api-overview), lets your migration tool efficiently migrate large amounts data to SharePoint Online. However, the lack of an official API to read content from SharePoint Online means that these tools must rely on CSOM/Vroom function calls to perform individual metadata read operations. +## Export steps overview -Large numbers of calls increase the likelihood of throttling, which impacts migration performance and customer experience. Ineffective call usage results in large SQL round trip per function calls that can potentially bring down the database and impact its reliability. +Export metadata from SharePoint in three steps: -A migration performance study identified four areas where a high number of calls are heavily used: +### Provision the destination containers and the queue -- **Incremental migration** relies on calls to retrieve the SharePoint online (SPO) content. It compares it with the source location to determine if there have been any changes to the content and whether to proceed with migration. -- **Structure creation** leverages calls for site, web part and navigation creation. -- **After migration verification** is done when migration is completed and is used to ensure the source and destination file metadata matches. -- **Permission settings** function calls are made to get user permission information. +> [!IMPORTANT] +> Use [GetMigrationJobProgress API](migration-job-progress-api-reference.md) to retrieve migration job status. +> +> Provisioning Azure Queues for migration job status tracking is no longer required. Deprecation of Azure Queues is planned for the second half of 2026. Until then, Azure Queues will remain available for status retrieval. -## SharePoint Migration Export (Asynchronous Metadata Read) API +Use `ProvisionMigrationContainers` method to provision the containers. Check [Use Azure Blob Storage Containers and Azure Queues with Migration API](migration-azure.md) for details. You can also use your own containers and queues if needed. -The SharePoint Migration Export (Asynchronous Metadata Read) API aims to reduce the calls in areas: incremental migration, after migration verification and permission settings. +### Use `CreateSPAsyncReadJob` method to start the export ->[!Note] ->The first version of the SharePoint Migration Export (Asynchronous Metadata Read) API supports files, folders, lists, list items, and the document library. Permissions are expected to be covered in a subsequent version. +Use `CreateSPAsyncReadJob` method to export metadata from a single URL, or `CreateSPAsyncReadJobWithMultiUrl` from multiple URLs if needed. Check [AMR API Reference](amr-api-reference.md) for details. -Key supported features: +Get incremental updates with `ChangeToken` feature. -- Ability to aggregate small metadata requests calls (for example, CSOM) into a single AMR call with the multiple URL feature -- Ability to read unlimited items with a single API call. -- Incremental migration feature support returning of item changed since last query with *changeToken* feature -- Ability to include a rich set of metadata per item -- Ability to return only top-level structure without subfolders or children. +Both methods return the Job ID, which can be used to track the export status. -More detailed information about the features and the API description is covered in the section below. +Check [AMR API Reference](amr-api-reference.md) for details. +### Checking status -The Migration Asynchronous Read APIs are: +> [!IMPORTANT] +> Use [GetMigrationJobProgress API](migration-job-progress-api-reference.md) to retrieve migration job status. +> +> Provisioning Azure Queues for migration job status tracking is no longer required. Deprecation of Azure Queues is planned for the second half of 2026. Until then, Azure Queues will remain available for status retrieval. -Single +Check Azure Queue supplied for export status. Monitor events as listed in [Events](migration-events.md) for details. -```cs - public SPAsyncReadJobInfo CreateSPAsyncReadJob( - Uri url, - SPAsyncReadOptions readOptions, - EncryptionOption encryptionOption, - string azureContainerManifestUri, - string azureQueueReportUri) -``` +AMR API exports metadata in the manifest container supplied, under a folder named by `JobID`. Check [Manifest files](migration-manifest.md) for the format and validation of the metadata. -Multiple +AMR API splits manifest packages larger than 25 MB into multiple manifest files per request. -```cs - public SPAsyncReadJobInfo CreateSPAsyncReadJobWithMultiUrl( - Uri[] urls, - SPAsyncReadOptions readOptions, - EncryptionOption encryptionOption, - string azureContainerManifestUri, - string azureQueueReportUri) -``` +## Best practice -The API is made up of five input parameters and one output structure field. +AMR API is powerful. Ensure good performance to achieve the scale for large migration projects. -## Input Parameters +### Export security and permissions on top level if possible -### URL - -The full path URL lets your migration tool to specify the root URL path of the SharePoint list, files/folder document library to be read. By default, the server-side code will read and return all the metadata of files, folders, and root objects including subfolders and their children content. +Exporting security with `IncludeSecurity` consumes more resources and slows down the export. It's faster to export this metadata at the upper-level folder first, then export the children without them. -*Example:* -This document library URL, `https://www.contoso.com/Shared%20Document`, will be read back for metadata of any files or folders that live under the root URL. `https://www.contoso.com/Shared%20Documents/FolderA/` will be read back for children metadata in FolderA. +### Metadata export on a single item -#### Multiple URLs +Use Microsoft Graph instead of AMR. -With the latest API update in Q1 2020, AMR will now support multiple URL inputs. This means the user can input multiple root URLs or subfolder URLs and aggregate them into a single call. +### Folders with less than 10,000 items -As there is a fixed overhead, AMR is most effective when there is a large number of reads when processing AMR. There are cases when the migration software may not want to read the whole root level URL. The multiple URL feature lets the software to aggregate multiple requests into a single request to improve performance while reducing number of calls. +Use `CreateSPAsyncReadJobWithMultiUrl` to combine the URLs of multiple folders into a single export job. -(For more information regarding the size recommendation, see the performance section) +### Folders with 10,000 to 1 million items -*Example:* The document library URL, `https://www.contoso.com/Shared%20Document`, has folders A through J . The customer only wants to migrate folders A, B, C, D, and E. Instead of issuing a single read at the root level and returning large unnecessary content, or issuing AMR per individual folder, which is not effective, the software can issue URI [A, B, C, D, E] in the input parameters returning only required metadata. +Use `CreateSPAsyncReadJob`, and set **readOption** `IncludeDirectDescendantsOnly` to `false`. This value is the default setting. -Currently there is a maximum of 5000 URL aggregation limits per call. +### Nested folders with over 1 million items -#### readOptions Flag +Plan carefully when dividing folders into jobs. Object count in export jobs is the major factor of export performance. -The read asynchronous function will include the SPAsyncReadOptions structure, which covers the optional flags to allow the user to specify version and security setting on the site level more is described below. +This example shows how to export metadata from nested folders with over 1 million items. AMR API has the highest performance when the item count is large. -```c# -IncludeVersions{ get; set; } -``` +- Use `CreateSPAsyncReadJob` method at the root URL, for example: `www.contoso.com/my-resource-document`, and set **readOption** `IncludeDirectDescendantsOnly` to `true`. +- Utilize `SMTotalFileCount` attribute to get the file count in folders. +- Continue to use `createSPAsyncReadJob` method at subfolder level, on each of the subfolders, if the folder has more than 10,000 items. +- Use `CreateSPAsyncReadJobWithMultiUrl` method, combining subfolders with less than 10,000 items. -If set, this indicates all the files and list item version history is to be included in the export operation. If absent, only the most recent version is provided. +## Performance -```c# -IncludeSecurity{ get; set; } -``` +AMR API processes jobs through a queue mechanism with preconfigured workload management settings. AMR API processes the jobs on a best-effort basis, without Service Level Agreement (SLA) or guaranteed performance. -This flag indicates whether to include all user or group information from a site. By default, users and groups that are part of the object metadata will be returned, such as author or modifier. +### Lab-tested performance baseline -If you use this flag, all users in the site collection will be included. If you are issuing AMR calls for different document libraries that are under the same site collection, the same set of users will be included each time, unless there has been a change. - ->[!Important] ->Using this option can result in very slow performance. Use it only as described in the steps below. +We tested the performance in a lab setting. AMR API exported about 400 items per second for every 250-K objects, in the average case. The peak performance reached 700 items per second. -If you have a large number of objects in a document library, it is faster to do the following two calls to read the security setting and its child folders: - -1. To get user/group info, call the AMR job on the top root folder with security on using this setting: -("IncludeSecurity=true" & "IncludeDirectDescendantsOnly=true"). -
-2. For the rest of the structure, call the AMR job with the security off: -"IncludeSecurity=false" +Multiple factors affect real-life performance. These factors include: +- The number of items that are being exported +- The way AMR API is implemented +- Throttling -```c# -public bool IncludeDirectDescendantsOnly { get; set;} -``` +### Optimize migration performance -If specified only the top-level metadata item is read back. Example: The root URL contains file A and folder B. If this flag is specified, the manifest returns only file A and folder B metadata. It will not return any metadata included inside folder B. +In order to ensure optimal performance for your migration projects, it's important to plan carefully, especially when dealing with large-scale migrations. For more information on how to estimate timespans and optimize performance, see our [performance guide](/sharepointmigration/sharepoint-online-and-onedrive-migration-speed). -The use case for this function: The ISV can issue a default read to retrieve the top-level items and then issue multiple `CreateSPAsyncReadJob` to read back all the sub folder content in parallel to improve throughput. +### I'm seeing throttling messages -```c# -public bool IncludeExtendedMetadata { get; set; } -``` +To ensure good user experiences for all Microsoft 365 customers, SharePoint uses throttling to protect the SharePoint infrastructure. Avoid getting throttled by following [throttling guidance](https://aka.ms/spo429). -This flag indicates whether to return the extended set of metadata content of object query. By default this option is off and only basic content is provided (for example, names, URL, author, modifier, dates) . Turning on this flag provides all the metadata content; however, it will also impact the performance as query will take longer. +### Tenant-to-Tenant migrations -Recommendation is to keep the default for file share migration, but consider setting this flag on for SharePoint on-premises or other more complex migration. +AMR isn't intended for scenarios where contents from a SharePoint tenant are moved to another. This type of migration requires the use of many resource-heavy read options. The long processing time of these read options slows down the overall migration significantly. -```c# -public string StartChangeToken { get; set; } -``` - -This option applies to input URL of list or document library only. - -One of the key calls contributor is incremental migration. ChangeToken idea is introduced to reduce the unnecessary calls. If StartChangeToken is not specified, the CreateSPAsyncReadJob will query and read back all the items specified by the API function. Once specified with the ChangeToken value, only the item changed since last query is returned. - -During incremental migration, instead of query everything again, by populating StartChangeToken with the change token received from the CurrentChangeToken output in returning job info, createSPAsyncReadJob then returns only the items that got changed since the specified StartChangeToken, reducing the overall calls. - -Below is a sample of how the `startChangeToken` might work. This example uses the optional feature setting for initial call and the parameter setting for incremental passes. - -![Export API process](../images/async-read-api-flow.png) - -#### Invalid Value - -If an invalid value is detected, other than NULL, an error will be generated, and the operation will be terminated. - -#### encryptionOption - -This is an optional parameter. If it is specified, the AES256CBCKey is used to encrypt output files and queue messages. Otherwise, there is no encryption. - -For more information, see [EncryptionOption Class](https://docs.microsoft.com/dotnet/api/microsoft.sharepoint.client.encryptionoption). - -#### azureContainerManifestUri - -The valid URL including SAS token for accessing the Azure Blob Storage Container, which contains the block blobs for the manifest and other package describing XML files. This location will also be used for the log output response. The SAS token must have been created with only Read and Write permissions or the asynchronous metadata read job will fail. The SAS token should at least have a lifetime that starts at from no later than when the job was submitted, until a reasonable time for successful import to have concluded. - -#### azureQueueReportUri - -The valid URL including SAS token for accessing the user provided Azure Queue used for returning notifications of asynchronous metadata read job progress. If this value is not null and proper access is granted in the SAS token in this URI, it will be used for real-time status update. The SAS token must have been created with Add permissions or the migration job will be unable to add events to the queue. - -Once accepted, the job ID will be written to the notification queue if it was provided and access is valid. The notification queue can be used for multiple migration jobs at the same time, as each job will identify itself in values sent back to the notification queue. - -## Output Parameters - -### CurrentChangeToken - -```c# -public string CurrentChangeToken { get; set; } -``` - -This function returns the changeToken associates with this query. By specifying this changeToken in the input field with subsequent read, the API will return only items changed since this last query. - -#### Manifest Output - -After the *asyncMigrationRead* function prepares execution, the final manifest will be placed in the container specified, under a folder named **JobId**. The manifest export package structure will be like the *createMigration* Import Package structure. The general output structure is summarized in table below. - ->[!Note] ->Once the AMR manifest package reaches 25MB, it will split into multiple packages per request. - -Below is an example on how to query the folder: - -```c# -CloudBlobDirectory folder = blobContainerObj.GetDirectoryReference(jobid); -CloudBlockBlob blob = folder.GetBlockBlobReference(manifestFileName); -``` - -|**XML file**|**Schema File**|**Description**| -|:-----|:-----|:-----| -|ExportSettings.XML|DeploymentExportSettings Schema|ExportSettings.XML does the following:

- Contains the export settings specified by using the SPExportSettings class and other classes that are part of the content migration object model.

- Ensures that the subsequent export process (at the migration target site) enforces the directives specified in the export settings.

- Maintains a catalog of all objects exported to the migration package.| -|LookupListMap.XML|DeploymentLookupListMap Schema|Provides validation for the LookupListMap.XML file exported into the content migration package. LookupListMap.XML maintains a simple lookup list that records SharePoint list item (list item to list item) references.| -|Manifest.XML|DeploymentManifest Schema|Provides validation for the Manifest.xml file that is exported into the content migration package. Provides a comprehensive manifest containing listings of both the contents and the structure of the destination site (for example, SPO) . | -|Requirements.XML|DeploymentRequirements Schema|"Provides validation for the Requirements.xml file exported into the content migration package. Requirements.xml maintains list of deployment requirements in the form of installation requirements on the migration target, such as feature definitions, template versions, Web Part assemblies, and language packs."| -|RootObjectMap.XML|DeploymentRootObjectMap Schema|"Provides validation for the RootObjectMap.xml file exported into the content migration package.RootObjectMap.xml maintains a list of mappings of secondary (dependent) objects, which allows the import phase of the migration operation to correctly place the dependent objects relative to the locations of the root object mappings."| -|SystemData.XML|DeploymentSystemData Schema|Provides validation for the SystemData.xml file exported into the content migration package.SystemData.xml does the following: Collects a variety of low-level system data. Records the number and names of Manifest.xml files (in cases where the migration uses multiple manifests).| -|UserGroupMap.XML|DeploymentUserGroupMap Schema|Provides validation for the UserGroup.xml file exported into the content migration package. UserGroup.xml maintains a list of users and user security groups with respect to access security and permissions.| -|ViewFormsList.XML|DeploymentViewFormsList Schema|Provides validation for the ViewFormsList.xml file exported into the content migration package.ViewFormsList.xml maintains a list of Web Parts and tracks whether each is a view or form.| - -#### How to retrieve the manifest from the Azure blob - -The following example code demonstrates how to get the Azure blob of a manifest file and decipher it: - -```c# -// Get Azure blob of a manifest file -CloudBlockBlob blob = folder.GetBlockBlobReference(blobName); -blob.FetchAttributes(); - -using (Stream stmTemp = new MemoryStream()) -{ - // Download current manifest file - blob.DownloadToStream(stmTemp); - - // Get IV and decrypt the content into output dir - byte[] IV = Convert.FromBase64String(blob.Metadata[“IV”]); - - using (Stream targetStream = System.IO.File.Open(outputFileFullPath, FileMode.Append)) - { - using (Aes alg = new AesCryptoServiceProvider()) - { - stmTemp.Seek(0, SeekOrigin.Begin); - using (CryptoStream csDecrypt = new CryptoStream( - stmTemp, - alg.CreateDecryptor(key, IV), - CryptoStreamMode.Read)) - { - csDecrypt.CopyTo(targetStream); - } - } - } -} -``` - -#### JobQueueUri - -```c# -public Uri JobQueueUri { get; set; } -``` - -The reporting features are the same as they are for `CreateMigrationJob`. Logging is provided to track the status of the asynchronous metadata read. After a scan of the database and an estimate of your tools, the log provides an estimate of the number of items to be read per URL. By default, blob queue permissions and settings are set to "all access", the same as when the ISV calls `ProvisionMigrationContainer` during the `CreateMigrationJob`. - -In addition to the events supported by the Import API (CreationMigrationJob), a new job event called `FinishManifestFileUpload` will be added to the status queue in real time. This is added after the manifest file is generated and uploaded. - -As it’s a real time event, ISVs and developers can also immediately download and parse the manifest files once `FinishManifestFileUpload` is generated. Use the field `ManifestFileName` to parse this event to get every manifest file name, including systemdata.xml, usergroup.xml, etc. - -The new event will look like this: - -```json -{"Event", "FinishManifestFileUpload"}, -{"JobId", “f8d7d577-676e-47ce-ab69-ae7803979883”}, -{"Time", “2019-09-03T19:11:33.903”}, -{"ManifestFileName", “f8d7d577-676e-47ce-ab69-ae7803979883/ExportSettings.xml”} -``` - -#### EncryptionKey - -public byte[] EncryptionKey { get; set; }

-It returns the AES256CBC encryption key used to decrypt the message in azureManifest container and azureReport Queue. - -|**Output parameter**|**Description**| -|:-----|:-----| -|JobID/GUID|Return a unique Job ID associated with this asynchronous read| -|AzureContainerManifest|Return the URL for accessing the async read manifest| -|JobQueueUri|URL for accessing Azure queue used for returning notification of migration job process| -|EncryptionKey|AES256CBC encryption key used to decrypt messages from job/manifest queue| - -## Set up Guidelines - -The following provides high-level guidelines for implementing the asynchronous metadata migration function. This documentation does not go into details on how to interact with SharePoint RESTful service. It is assumed that the ISV has prior knowledge and will be able to access the target website with proper permission. - -For more information on how to access the SharePoint website, refer to [Get to Know the SharePoint Rest Service](https://docs.microsoft.com/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service). - -1. Install and update the latest Microsoft.SharePointOnline.CSOM version. The minimum version requirement is V16.1.9119.1200 or later. -1. ISVs figure out the folder, document library or files of interested to be query and issued with CreateSPAsyncReadJob function. -1. Once successfully created, query the job status using the *jobQueueUri*. It provides the job process status and any error logging. After job completion, parse the manifest to retrieve the metadata. - -### SharePoint Migration Export (Asynchronous Metadata Read) API Example - -#### Scenario: Large file share (> 1 million) with nested files/folders - -Suggestion: -1. Issue CreateSPAsyncReadJob - - URL = root URL (for example, `www.contoso.com/my-resource-document`) - - Optional Flag: `IncludeDirectDescendantsOnly(true)` - - For each of the sub folders, issue createSPAsyncReadJob if the folder has > 10K - - **Sample source code** - - ```console - $site = get-spsite https://test.sharepoint.com # get site - $web = get-spweb https://test.sharepoint.com # get web - $list = $web.GetList("Shared Documents") # get the document library under this web - - # Get the Doclib root folder - $rootFolder = $web.GetFolder($list.Rootfolder.ServerRelativeUrl) - - # You can call 1 AMR job here, to get metadata of the direct children of the root folder only - CreateAMRJob($rootFolder) - - # Create parallel AMR jobs for the direct level subfolders - Foreach ($folder in $rootFolder.SubFolders) - { - // Create 1 AMR job per folder tree - CreateAMRJob($folder) - } - ``` - - The ISV can optimize the recursive highlight part by leveraging the $ folder.item["SMTotalFileCount"] that will return the cumulative file count in the folder tree for a given folder item. Follow the recommendations in the performance section on type of AMR jobs to issue - -1. object, issued in multiple URLs if < 10K objects - ->[!IMPORTANT] ->This scenario is only recommended for top level folders or if the sub-folder contains greater than one million objects. The performance of the AMR API is *not as effective* when reading a small set of items. - - -#### Scenario: Incremental Migration of FileShare for a sub folder - -1. Issue CreateSPAsyncReadJob:
- 1. URL = root URL (for example, `www.contoso.com/my-resource-document/a`) - 1. Remembered the `CurrentChangeToken` - -1. After some time, the software wishes to perform incremental migration. Issue CreateSPAsyncReadJob with following term:
- 1. URL = root URL (for example, `www.contoso.com/my-resource-document/a`) - 1. Optional Flag: `StartChangeToken(CurrentChangeToken)` - -## Limitations - - - -Asynchronous Metadata Read (Export API) now supports unlimited list, document library, file, and folder metadata export. - -## Performance Expectation - -The preliminary performance test provides a rough estimate of more than 400 items per second throughput for every 250K of objects read. We have seen over 700 items per second throughput in a testing environment. However, this is highly dependent on the number of items that are being read plus the implementation of the AMR API. This does not account for any potential throttle over the network. If the asynchronous read function fails to reach the server due to throttling, then performance will be impacted. - -This measure of throughput assumes the software package has a sufficient number of items per read. Microsoft recommends the following: - -|**Folder size**|**Recommendation**| -|:-----|:-----| -|Less than 10,000 items|Combine the URLs of multiple folders into a single call| -|Greater than 10,000 items but less than 1,000,000|Run AMR at the root folder level| -|Greater than 1,000,000|Use the recursive call logic to explore that folder's direct level children until there are no more folders.| - -For a single read query, it is faster to use the Graph API or a RESTful/CSOM query. - -One of the key performance benefits of using the asynchronous metadata read is the ability to balance the server-side load and the backend query. It is much more efficient than using individual CSOM load reducing to lessen your chance of throttling. +Microsoft provides no performance guarantee in this scenario. Use Graph or CSOM as needed. diff --git a/docs/apis/migrate-webparts-with-migrationapi.md b/docs/apis/migrate-webparts-with-migrationapi.md index 7702e6bd4..25114eea9 100644 --- a/docs/apis/migrate-webparts-with-migrationapi.md +++ b/docs/apis/migrate-webparts-with-migrationapi.md @@ -1,17 +1,18 @@ --- title: "Migrating web parts using the Migration API" -ms.reviewer: +description: "Migrating web parts using the Migration API" ms.author: jhendr author: JoanneHendrickson manager: pamgreen audience: ITPro +ms.date: 06/28/2022 +ms.subservice: migration-tool ms.topic: conceptual -localization_priority: Normal +ms.localizationpriority: medium search.appverid: MET150 -msCollection: +msCollection: - SPMigration - M365-collaboration -description: "Migrating web parts using the Migration API" --- # Migrating web parts using the Migration API @@ -24,151 +25,145 @@ An advantage in using the Migration API for your web part migration is the abili There are two attributes that are handled in a unique way that requires using the WebPart User Properties Serializer DLL. There is a technical challenge to generate the property values for *AllUsersProperties* and *PerUserProperties* when building the PRIME package. This challenge is because the property values are BASE64 encoded blob, which is serialized web part properties and web part connection info. - To get the Serializer .dll, perform following steps: - 1. Install the SPMT Client on your local computer: [Install SPMT](https://aka.ms/spmt-GA-page). -2. Browse to the install location of SPMT -3. Locate and copy the *microsoft.sharepoint.migration.webpart.serializer.dll* and you can copy it into your project. +1. Browse to the install location of SPMT +1. Locate and copy the *microsoft.sharepoint.migration.webpart.serializer.dll* and you can copy it into your project. For a complete list of the supported web parts, see: -- [SPMT & Migration API supported SharePoint web parts](https://docs.microsoft.com/sharepointmigration/spmt-supported-webparts) - - +- [SPMT & Migration API supported SharePoint web parts](/sharepointmigration/spmt-supported-webparts) ## Schema: For an explanation of the **SPWebPart** fields see: -- [SPWebPart](https://docs.microsoft.com/openspecs/sharepoint_protocols/ms-primepf/25cfceeb-7769-4331-9936-ce3b9ced87ad) - - +- [SPWebPart](/openspecs/sharepoint_protocols/ms-primepf/25cfceeb-7769-4331-9936-ce3b9ced87ad) ### PRIME Web Part Schema example ```xml - - - - - - - - - - - …… - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + +…… + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ``` ## Security controls Due to the security control design on the server side, the following behavior: - + - If the NoScript is off, then go on migrating all web part as currently - If NoScript is on, then first check web part level safety - - If SafeAgainstScript is false, do not import it - - If SafeAgainstScript is true, then check the web part property level safety - - If the web part has any property with ‘RequiresDesignerPermission’, then ignore this web part (or ignore this property if feasible) - - Otherwise, go on migrating this web part - - + - If SafeAgainstScript is false, do not import it + - If SafeAgainstScript is true, then check the web part property level safety + - If the web part has any property with ‘RequiresDesignerPermission’, then ignore this web part (or ignore this property if feasible) + - Otherwise, go on migrating this web part + + Here is the list of web parts that will be ignored by server-side code (treated as untrusted webpart) when NoScript is turned ON: - XsltListViewWebPart @@ -195,141 +190,138 @@ Here is the list of web parts that will be ignored by server-side code (treated ## FAQ *Question:* How do I fetch the web part properties as the input for serialization API? -*Answer:* The web part properties can be found in element in the response of operation ‘GetWebPartProperties2’ in ‘WebPartPagesWebService’. Find the payload details in WSDL ‘/_vti_bin/WebPartPage.asmx?WSDL’. +*Answer:* The web part properties can be found in \ element in the response of operation ‘GetWebPartProperties2’ in ‘WebPartPagesWebService’. Find the payload details in WSDL ‘/_vti_bin/WebPartPage.asmx?WSDL’. *Question:* How to fetch the web part connection info as the input for serialization API? -*Answer:* The web part connections could be found in elements from the web part page in the response of operation ‘GetWebPartPage’ in ‘WebPartPagesWebService’. +*Answer:* The web part connections could be found in \ elements from the web part page in the response of operation ‘GetWebPartPage’ in ‘WebPartPagesWebService’. -View flags: refer to this https://docs.microsoft.com/openspecs/sharepoint_protocols/ms-wssfob/252d2086-6571-430f-863d-bcaf9d267e62, for example, all the view flags https://docs.microsoft.com/openspecs/sharepoint_protocols/ms-wssfob/16a9d8ca-185d-40ec-956e-bb6bf3488cf7. You will need to convert all flag values to PRIME element ‘flags’. +View flags: refer to [this](/openspecs/sharepoint_protocols/ms-wssfob/252d2086-6571-430f-863d-bcaf9d267e62), for example, all the [view flags](/openspecs/sharepoint_protocols/ms-wssfob/16a9d8ca-185d-40ec-956e-bb6bf3488cf7). You will need to convert all flag values to PRIME element ‘flags’. ## Appendix -### Sample Web Part Properties v2 XmlNode Element +### Sample Web Part Properties v2 XmlNode Element ```xml - - - Content Editor - Default - Allows authors to enter rich text content. - true - wpz - 0 - Normal - - - true - true - true - true - true - true - true - - - Modeless - Default - - - /_layouts/15/images/mscontl.gif - - true - 00000000-0000-0000-0000-000000000000 - g_d6def51c_7a91_40fe_9f59_de9ceed5c347 - Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c - Microsoft.SharePoint.WebPartPages.ContentEditorWebPart - - - - + + Content Editor + Default + Allows authors to enter rich text content. + true + wpz + 0 + Normal + + + true + true + true + true + true + true + true + + + Modeless + Default + + + /_layouts/15/images/mscontl.gif + + true + 00000000-0000-0000-0000-000000000000 + g_d6def51c_7a91_40fe_9f59_de9ceed5c347 + Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c + Microsoft.SharePoint.WebPartPages.ContentEditorWebPart + + + + ``` ### Sample Web Part Properties v3 XmlNode Element ```xml - - - - - - - - - False - - - True - - - False - - a316c9a6-e664-426b-9069-77cabd22429c - /Lists/TestPromotedLinks - False - NotSet - False - Html, TabularView, Hidden, Ordered - True - {A316C9A6-E664-426B-9069-77CABD22429C} - - True - Normal - True - - - All - False - True - True - - Modeless - - True - 86400 - Default - - - /_layouts/15/images/itgen.png?rev=23 - - True - - -1 - True - - - False - - PAGE_NORMALVIEW - - True - False - 00000000-0000-0000-0000-000000000000 - - main.xsl - True - - False - <View Name="{2B37E456-6FD3-4708-AC83-5D7B0D13E9B4}" Type="HTML" Hidden="TRUE" OrderedView="TRUE" DisplayName="" Url="/SitePages/TestPage.aspx" Level="1" BaseViewID="3" ContentTypeID="0x" ><Query><OrderBy><FieldRef Name="TileOrder" Ascending="TRUE"/><FieldRef Name="Modified" Ascending="FALSE"/></OrderBy></Query><ViewFields><FieldRef Name="Title"/><FieldRef Name="BackgroundImageLocation"/><FieldRef Name="Description"/><FieldRef Name="LinkLocation"/><FieldRef Name="LaunchBehavior"/><FieldRef Name="TileOrder"/></ViewFields><RowLimit Paged="TRUE">30</RowLimit><JSLink>clienttemplates.js</JSLink><XslLink Default="TRUE">main.xsl</XslLink><Toolbar Type="Standard"/></View> - False - True - <ParameterBinding Name="dvt_sortdir" Location="Postback;Connection" /><ParameterBinding Name="dvt_sortfield" Location="Postback;Connection" /><ParameterBinding Name="dvt_startposition" Location="Postback" DefaultValue="" /><ParameterBinding Name="dvt_firstrow" Location="Postback;Connection" /><ParameterBinding Name="OpenMenuKeyAccessible" Location="Resource(wss,OpenMenuKeyAccessible)" /><ParameterBinding Name="open_menu" Location="Resource(wss,open_menu)" /><ParameterBinding Name="select_deselect_all" Location="Resource(wss,select_deselect_all)" /><ParameterBinding Name="idPresEnabled" Location="Resource(wss,idPresEnabled)" /><ParameterBinding Name="NoAnnouncements" Location="Resource(wss,noXinviewofY_LIST)" /><ParameterBinding Name="NoAnnouncementsHowTo" Location="Resource(wss,noXinviewofY_DEFAULT)" /> - List - 60 - False - - Cannot import this Web Part. - - - - - + + + + + + + + False + + + True + + + False + + a316c9a6-e664-426b-9069-77cabd22429c + /Lists/TestPromotedLinks + False + NotSet + False + Html, TabularView, Hidden, Ordered + True + {A316C9A6-E664-426B-9069-77CABD22429C} + + True + Normal + True + + + All + False + True + True + + Modeless + + True + 86400 + Default + + + /_layouts/15/images/itgen.png?rev=23 + + True + + -1 + True + + + False + + PAGE_NORMALVIEW + + True + False + 00000000-0000-0000-0000-000000000000 + + main.xsl + True + + False + <View Name="{2B37E456-6FD3-4708-AC83-5D7B0D13E9B4}" Type="HTML" Hidden="TRUE" OrderedView="TRUE" DisplayName="" Url="/SitePages/TestPage.aspx" Level="1" BaseViewID="3" ContentTypeID="0x" ><Query><OrderBy><FieldRef Name="TileOrder" Ascending="TRUE"/><FieldRef Name="Modified" Ascending="FALSE"/></OrderBy></Query><ViewFields><FieldRef Name="Title"/><FieldRef Name="BackgroundImageLocation"/><FieldRef Name="Description"/><FieldRef Name="LinkLocation"/><FieldRef Name="LaunchBehavior"/><FieldRef Name="TileOrder"/></ViewFields><RowLimit Paged="TRUE">30</RowLimit><JSLink>clienttemplates.js</JSLink><XslLink Default="TRUE">main.xsl</XslLink><Toolbar Type="Standard"/></View> + False + True + <ParameterBinding Name="dvt_sortdir" Location="Postback;Connection" /><ParameterBinding Name="dvt_sortfield" Location="Postback;Connection" /><ParameterBinding Name="dvt_startposition" Location="Postback" DefaultValue="" /><ParameterBinding Name="dvt_firstrow" Location="Postback;Connection" /><ParameterBinding Name="OpenMenuKeyAccessible" Location="Resource(wss,OpenMenuKeyAccessible)" /><ParameterBinding Name="open_menu" Location="Resource(wss,open_menu)" /><ParameterBinding Name="select_deselect_all" Location="Resource(wss,select_deselect_all)" /><ParameterBinding Name="idPresEnabled" Location="Resource(wss,idPresEnabled)" /><ParameterBinding Name="NoAnnouncements" Location="Resource(wss,noXinviewofY_LIST)" /><ParameterBinding Name="NoAnnouncementsHowTo" Location="Resource(wss,noXinviewofY_DEFAULT)" /> + List + 60 + False + + Cannot import this Web Part. + + + + + ``` -4 - Sample Web Part Connection XmlNode Element +### Sample Web Part Connection XmlNode Element ```xml - ``` diff --git a/docs/apis/migration-api-azure-container-and-queue.md b/docs/apis/migration-api-azure-container-and-queue.md index d330e2135..1dff25363 100644 --- a/docs/apis/migration-api-azure-container-and-queue.md +++ b/docs/apis/migration-api-azure-container-and-queue.md @@ -1,16 +1,16 @@ --- title: SPO provided Migration Azure container and queue +description: "One of the Main requirement for using our Migration API is the usage of an Azure container as a temporary storage. We now provide a default container that can be used for using the migration API." +ms.date: 07/08/2022 ms.author: jhendr author: JoanneHendrickson manager: pamgreen -ms.date: 04/23/2020 -description: "One of the Main requirement for using our Migration API is the usage of an Azure container as a temporary storage. We now provide a default container that can be used for using the migration API." -localization_priority: Normal +ms.subservice: migration-tool +ms.localizationpriority: medium --- - # SPO provided Migration Azure container and queue -Microsoft’s Migration API requires the use of an Azure container for temporary storage. To simplify the process, you are now provided with a default container while using the migration API. If you choose, you can still provide your own Azure container. +Microsoft’s Migration API requires the use of an Azure container for temporary storage. To simplify the process, you are now provided with a default container while using the migration API. To use the provided container you will need to [decorate your traffic correctly](/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online#how-to-decorate-your-http-traffic) to avoid throttling. If you choose, you can still provide your own Azure container. ## Encryption is required @@ -18,13 +18,13 @@ For the Migration API to accept a Migration Job coming from a SPO provided Azure ## Advantages -|Advantage|Description| -|:-----|:-----| -|Cost of Azure container goes to SPO|Since we are providing the containers, those containers are now part of the basic SharePoint online Offering. Every tenant who signs up for SharePoint Online will get this for free).| -|Containers and queues are unique per request and not reused|Once a container is given to a customer this container will not be reused or shared.| -|Containers and queue are automatically deleted|As per the standard SharePoint Online Compliance, we will destroy the container within 30 to 90 days automatically.| -|Containers and queues are in the customer’s datacenter location|We make sure to provision containers that are in the same physical location than their SharePoint online tenant.| -|They are obtainable programmatically|There is no need to interact with Azure unless the user chooses. +| Advantage | Description | +| :-------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Cost of Azure container goes to SPO | Since we are providing the containers, those containers are now part of the basic SharePoint online Offering. Every tenant who signs up for SharePoint Online will get this for free). | +| Containers and queues are unique per request and not reused | Once a container is given to a customer this container will not be reused or shared. | +| Containers and queue are automatically deleted | As per the standard SharePoint Online Compliance, we will destroy the container within 30 to 90 days automatically. | +| Containers and queues are in the customer’s datacenter location | We make sure to provision containers that are in the same physical location than their SharePoint online tenant. | +| They are obtainable programmatically | There is no need to interact with Azure unless the user chooses. | ## How to use it @@ -34,16 +34,16 @@ For the Migration API to accept a Migration Job coming from a SPO provided Azure public SPProvisionedMigrationContainersInfo ProvisionMigrationContainers() ``` -The call will return an object that contains two strings containing two SAS tokens for accessing the two required containers and a byte array for the AES256CBC encryption. +The call will return an object that contains two strings containing two SAS tokens for accessing the two required containers and a byte array for the AES256CBC encryption. This key will need to be used when encrypting the data. We forget the key once we give it out, therefore you must keep it to pass it again for the Submit Migration Job call. ```csharp -Uri DataContainerUri +Uri DataContainerUri Uri MetadataContainer Uri -byte[] EncryptionKey +byte[] EncryptionKey ``` ### Getting Queue @@ -66,10 +66,9 @@ Once those calls have been made, the rest of the flow remains the same for using ### Required endpoints for goverment cloud -If your tenant is hosted in a government cloud (GCC), you must have the proper endpoints set when calling the API. -*Example:* usgovcloudapi.net +If your tenant is hosted in a government cloud (GCC), you must have the proper endpoints set when calling the API. For example: `usgovcloudapi.net`. -|**Required Endpoint**|**Why**| -|:-----|:-----| -|https://*.blob.core.usgovcloudapi.net|Migration API Azure Government requirement| -|https://*.queue.core.usgovcloudapi.net|Migration API Azure Government requirement| +| **Required Endpoint** | **Why** | +| :--------------------------------------- | :----------------------------------------- | +| `https://*.blob.core.usgovcloudapi.net` | Migration API Azure Government requirement | +| `https://*.queue.core.usgovcloudapi.net` | Migration API Azure Government requirement | diff --git a/docs/apis/migration-api-encryption.md b/docs/apis/migration-api-encryption.md index 830964a73..c46879621 100644 --- a/docs/apis/migration-api-encryption.md +++ b/docs/apis/migration-api-encryption.md @@ -1,11 +1,12 @@ --- title: OneDrive for Business and SharePoint Online Migration API – Encryption +description: "How to pass encrypted content at rest to the API securely." +ms.date: 6/20/2022 ms.author: jhendr author: JoanneHendrickson manager: pamgreen -ms.date: 6/20/2018 -description: "How to pass encrypted content at rest to the API securely." -localization_priority: Normal +ms.subservice: migration-tool +ms.localizationpriority: medium --- # OneDrive for Business and SharePoint Online Migration API encryption @@ -20,18 +21,19 @@ Content - Files - Manifest - - Metadata - - Permissions - - List items - - Taxonomy - - Logs (created by SharePoint Online to report back on the migration results) + - Metadata + - Permissions + - List items + - Taxonomy + - Logs (created by SharePoint Online to report back on the migration results) - Queue - - Real time reportig on the progress + - Real time reportig on the progress ## What is the encryption feature? -When using the encryption parameter, everything listed above will be encrypted at rest and the key will need to be preserved in order to read the logs and the real time progress. -The main benefits is making the content useless for a malicious user who would manage to breach into the Azure container. +When using the encryption parameter, everything listed above will be encrypted at rest and the key will need to be preserved in order to read the logs and the real time progress. + +The main benefits is making the content useless for a malicious user who would manage to breach into the Azure container. This comes with a small cost of performance. This feature is optional when using the API and it is recommended to only use it for the most confidential information since it does reduce the speed of the migration by a small portion. Microsoft destroys the key once the migration job is finished and there is no way to recover the key if lost, not even from support. @@ -58,10 +60,10 @@ Example: ## Extra requirement -For the encryption, each file must be encrypted and have an IV assigned to it. The encryption method should follow the AES CBC 256 Standard. A unique, cryptographically-random IV must be generated for every file including the manifests in the package and should be stored as a property on each files. Use the AesCryptoServiceProvider.GenerateIV method to generate a unique random IV for each file. +For the encryption, each file must be encrypted and have an IV assigned to it. The encryption method should follow the AES CBC 256 Standard. A unique, cryptographically-random IV must be generated for every file including the manifests in the package and should be stored as a property on each files. Use the AesCryptoServiceProvider.GenerateIV method to generate a unique random IV for each file. -- Name = [IV] -- Value = [Base64encoded byte array of the IV] +- **Name**: [IV] +- **Value**: [Base64encoded byte array of the IV] ## Reading the queue when encrypted @@ -72,13 +74,13 @@ It is important to remember the Job ID. Without the specific key used for the jo Here is the JSON content in the queue message ```json -{"Label", "Encrypted"}, -{"JobId", "[JobId value]"}, -{"IV", "[IV value in base64format]"}, -{"Content", "[encrypted message in base64string]"} +{"Label": "Encrypted"}, +{"JobId": "[JobId value]"}, +{"IV": "[IV value in base64format]"}, +{"Content": "[encrypted message in base64string]"} ``` Once the messages are decrypted, they will be the same as the API without encryption. ->[!NOTE] ->The **Migration** is not available for users of Office 365 operated by 21Vianet in China. It is also not available for users of Office 365 with the German cloud using the data trustee, *German Telekom*. However, it is supported for users in Germany whose data location is not in the German data center. +> [!NOTE] +> The **Migration** is not available for users of Office 365 operated by 21Vianet in China. It is also not available for users of Office 365 with the German cloud using the data trustee, *German Telekom*. However, it is supported for users in Germany whose data location is not in the German data center. diff --git a/docs/apis/migration-api-overview.md b/docs/apis/migration-api-overview.md index e4db36b37..d09416b7e 100644 --- a/docs/apis/migration-api-overview.md +++ b/docs/apis/migration-api-overview.md @@ -1,1566 +1,131 @@ --- -title: "SharePoint Online Import Migration API" -ms.prod: sharepoint -ms.date: 03/17/2021 -ms.author: jhendr -author: JoanneHendrickson -manager: serdars -search.appverid: MET150 -description: "This article provides in depth information on how to use the SPO Migration API." -localization_priority: Priority +title: "SharePoint Import Migration API" +description: "This article provides an overview of how to use the SharePoint Migration API." +ms.date: 07/16/2025 +ms.author: ranren +author: underreview +manager: dapodean +audience: ITPro +ms.subservice: migration-tool +ms.topic: article +ms.localizationpriority: high +ms.collection: + - SPMigration + - m365-collaboration --- -# SharePoint Import Migration API (CreationMigrationJob) +# SharePoint Migration API Introduction -## API Documention +The SharePoint Migration API imports content into SharePoint at scale. It processes content and manifest packages as jobs in a queue. The API provides process status and logs, making it easy to monitor the progress of each migration job. -The following API description is based upon use of the SharePoint Client Side Object Model (CSOM). We do recommend using NuGet packages when you reference CSOM in your solution. +Use Migration API to migrate content from file shares, SharePoint Server, and other cloud-based services. -You can find latest version of the SharePoint Online Client Side Object Model (CSOM) package from the [NuGet gallery](https://www.nuget.org/packages/Microsoft.SharePointOnline.CSOM/). Use the ID `Microsoft.SharePointOnline.CSOM`. +## What's new ->[!Important] -> Files larger than 15 GB must now create the required checksum using [QuickXorHash](https://docs.microsoft.com/onedrive/developer/code-snippets/quickxorhash). We have provided an example [here](#what-is-stored-in-those-azure-blob-containers). -> ->The QuickXorHash/Checksum has to be computed for the original file **before** encryption (if the file is being encrypted). This is different from the MD5hash requirementt. -> ->The previous method of MD5Hash is still required for files smaller than 2 GB; however this requirement will be removed at some point in the future. - - -## Methods - -### CreateMigrationJob - -This method creates a new migration import job and queues it up for later processing by a separate timer job. The job will consume a well formed (pre-defined format) import package that is located in the Azure Blob Storage Containers specified in this method. The SLA for migration job processing is be controlled through pre-configured queue and work load throttling settings, and there is no guaranteed SLA or return time for a submitted job. - -#### Syntax - -```csharp -public Guid CreateMigrationJob( - Guid gWebId, - string azureContainerSourceUri, - string azureContainerManifestUri, - string azureQueueReportUri) -``` - -#### Parameters - -##### gWebID - -The unique identifier of the destination web targeted for the package import. Additional information and identifiers for the import are specified within the import package itself. This identifier can be found programmatically by querying the target web using CSOM calls. - -##### azureContainerSourceUri - -The valid URL including SAS token for accessing the Azure Blob Storage Container which contains the binary files of type block. The SAS token must have been created with only Read and List permissions or the migration job will fail. The SAS token should at least have a lifetime that starts no later than when the job was submitted, until a reasonable time for successful import to have concluded.
- -The required permissions are as follows in the Azure Storage API: - -```csharp -(SharedAccessBlobPermissions.Read | SharedAccessBlobPermissions.List) -``` - -**Note:** The change to enforce Read and List permissions on the SAS token is coming in a future build. Until then it will not be enforced. However, it is a best practice to use these values. - -All files in the container must have at least a single snapshot applied to them to ensure that no file modification is made by the customer during the import. Any file that does not have a snapshot will be skipped during import and have an error thrown, although the job will attempt to continue the import. The import pipeline will use the latest snapshot of the file available at the time of import. The following is an example of the code that might be used to create a snapshot on a file after it is uploaded to Azure Blob Storage: - -```csharp -CloudBlockBlob blob = blobContainerObj.GetBlockBlobReference(file); -blob.UploadFromStream(stm); -blob.CreateSnapshot(); -``` - -> [!NOTE] -> The change to require and use the latest SnapShots on all files is coming in a future build, and until then will be ignored. - -##### azureContainerManifestUri - -The valid URL including SAS token for accessing the Azure Blob Storage Container which contains the block blobs for the manifest and other package describing XML files. This location will also be used for the log output. This container cannot be the same as the one used for the azureContainerSourceUri. The SAS token must have been created with only Read, List and Write permissions or the migration job will fail. The SAS token should at least have a lifetime that starts no later than when the job was submitted, until a reasonable time for successful import to have concluded. - -> [!NOTE] -> The change to enforce Read, List and Write permissions on the SAS token is coming in a future build, and until then will be not be enforced, however it is best practice to use these values. If an issue arises using a current build, try removing the List permission as a temporary workaround, noting that it will become required soon. - -All files in the container must have at least a single snapshot applied to them to ensure that no file modification is made by the customer during the import. Any file that does not have a snapshot will cause failures during the import and have errors thrown, potentially failing the entire migration job. - -> [!NOTE] -> The change to require and use the latest SnapShots on all files is coming in a future build. Until then they will be ignored. - -##### azureQueueReportUri - -The valid URL including SAS token for accessing the user provided Azure Queue used for returning notifications of migration job progress. This value can be null if no notification queue will be used during the import. If this value is not null and proper access is granted in the SAS token in this URI, it will be used for real time status update. The SAS token must have been created with only Add, Read and Update permissions or the migration job will be unable to add events to the queue. The required permissions are as follows in the Azure Storage API: - -``` -(SharedAccessQueuePermissions.Add | SharedAccessQueuePermissions.Read | SharedAccessQueuePermissions.Update) -``` - -Once accepted, the job ID will be written to the notification queue if it was provided and access is valid. The notification queue can be used for multiple migration jobs at the same time, as each job will identify itself in values sent back to the notification queue. - -The following are examples of all event types logged into the Azure reporting queue: - -**Event:JobQueued** -JobId:845daca4-5529-4b0e-85ab-a603efee5b12 -Time:09/29/2020 19:56:02.883 -SiteId:48917234-de43-474a-9f1b-8d98ffa08425 -DbId:8fd09323-b23f-430d-8957-213586ce3861 -TotalRetryCount:0 -MigrationType:None -MigrationDirection:Import -CorrelationId:c8d97e9f-802f-0000-ceac-44663834d510 - -**Event:JobPostponed** -JobId:845daca4-5529-4b0e-85ab-a603efee5b12 -Time:09/29/2020 19:56:57.598 -NextPickupTime:09/29/2020 20:16:57.519 -SiteId:48917234-de43-474a-9f1b-8d98ffa08425 -DbId:8fd09323-b23f-430d-8957-213586ce3861 -JobsInQueue: -TotalRetryCount:0 -MigrationType:None -MigrationDirection:Import -CorrelationId:d5d97e9f-702c-0000-ceb9-354fefa5e9f6 - -**Event:JobLogFileCreate** -JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecd -Time:09/29/2020 19:56:29.053 -FileName:Import-071f9aad-36e6-4bef-9f09-40b5c7498ecd-1.log -CorrelationId:22ca20ec-23de-468b-add3-4e52e90d3a68 - -**Event:JobStart** -JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecd -Time:09/29/2020 19:56:29.100 -SiteId:48917234-de43-474a-9f1b-8d98ffa08425 -WebId:36b66979-4a43-4b93-9b92-909c7186ff98 -DBId:8fd09323-b23f-430d-8957-213586ce3861 -FarmId:211e600c-f48d-4319-ba92-61150c8e8e8c -ServerId:cfd27448-822a-420b-bcc8-4f39629b01bc -SubscriptionId:51812136-3cba-482d-9696-532cddceab31 -TotalRetryCount:0 -MigrationType:None -MigrationDirection:Import -CorrelationId:c308c0ea-a7f5-4be9-acd4-1ebd39867434 - -**Event:JobProgress** -JobId:845daca4-5529-4b0e-85ab-a603efee5b12 -Time:09/29/2020 19:56:32.265 -FilesCreated:15 -BytesProcessed:45 -ObjectsProcessed:217 -TotalExpectedSPObjects:403 -TotalErrors:0 -TotalWarnings:0 -TotalRetryCount:0 -MigrationType:None -MigrationDirection:Import -WaitTimeOnSqlThrottlingMilliseconds:0 -TotalDurationInMs:0 -CpuDurationInMs:0 -SqlDurationInMs:0 -SqlQueryCount:0 -CreatedOrUpdatedFileStatsBySize:{"0-1K":{"Count":15,"TotalSize":45,"TotalDownloadTime":251,"TotalCreationTime":6754}} -ObjectsStatsByType:{"SPUser":{"Count":1,"TotalTime":289,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPFolder":{"Count":2,"TotalTime":144,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPDocumentLibrary":{"Count":1,"TotalTime":173,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPFile":{"Count":200,"TotalTime":6765,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPListItem":{"Count":14,"TotalTime":2111,"AccumulatedVersions":0,"ObjectsWithVersions":0}} -TotalExpectedBytes:0 -CorrelationId:ccd97e9f-a0cc-0000-ceb9-37a900bec68d - -**Event:JobEnd** -JobId:16d658cf-ecd3-485f-9c9e-1ca268565e24 -Time:09/29/2020 20:29:38.180 -FilesCreated:200 -BytesProcessed:600 -ObjectsProcessed:403 -TotalExpectedSPObjects:403 -TotalErrors:0 -TotalWarnings:0 -TotalRetryCount:0 -MigrationType:None -MigrationDirection:Import -WaitTimeOnSqlThrottlingMilliseconds:0 -TotalDurationInMs:372294.0861 -CpuDurationInMs:17351 -SqlDurationInMs:98359 -SqlQueryCount:1998 -CreatedOrUpdatedFileStatsBySize:{"0-1K":{"Count":200,"TotalSize":600,"TotalDownloadTime":15448,"TotalCreationTime":275662}} -ObjectsStatsByType:{"SPUser":{"Count":1,"TotalTime":44,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPFolder":{"Count":2,"TotalTime":108,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPDocumentLibrary":{"Count":1,"TotalTime":50,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPFile":{"Count":200,"TotalTime":293628,"AccumulatedVersions":0,"ObjectsWithVersions":0},"SPListItem":{"Count":200,"TotalTime":76541,"AccumulatedVersions":0,"ObjectsWithVersions":0}} -TotalExpectedBytes:0 -CorrelationId:59db7e9f-a003-0000-ceb9-300001119ee3 - -**Event:JobDeleted** -JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecd -Time:09/29/2020 19:56:29.053 -CorrelationId:22ca20ec-23de-468b-add3-4e52e90d3a68 - -**Event:JobCancelled** -JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecd -Time:09/29/2020 19:58:29.053 -TotalRetryCount:0 -CancelledByUser:false -MigrationType:None -MigrationDirection:Import -CorrelationId:22ca20ec-23de-468b-add3-4e52e90d3a68 - -**Event:JobError** -JobId:b427d8d7-2b91-4da0-aee5-4b5a5a5d867e -Time: 02/05/2019 06:56:09.732 -TotalRetryCount:0 -MigrationType:None -MigrationDirection:Import -ObjectType:File -Url:Shared Documents/file.pdf -Id:fae7b4b0-2912-11e9-b0f3-7b554a52d6ab -ErrorCode:-2147024816 -ErrorType:Microsoft.SharePoint.SPException -Message:ErrorMessage -CorrelationId:d8e9bc9e-20e2-8000-aa83-48a62fc5ce75 - -**Event:JobWarning** -JobId:b427d8d7-2b91-4da0-aee5-4b5a5a5d867e -Time: 02/05/2019 06:56:09.732 -TotalRetryCount:0 -MigrationType:None -MigrationDirection:Import -ObjectType:File -Url:Shared Documents/file.pdf -Id:fae7b4b0-2912-11e9-b0f3-7b554a52d6ab -ErrorCode:-2147024816 -ErrorType:Microsoft.SharePoint.SPException -Message:ErrorMessage -CorrelationId:d8e9bc9e-20e2-8000-aa83-48a62fc5ce75 - -**Event:FinishManifestFileUpload** -JobId:b427d8d7-2b91-4da0-aee5-4b5a5a5d867e -Time:02/05/2019 06:56:09.732 -ManifestFileName:Filename -CorrelationId:d8e9bc9e-20e2-8000-aa83-48a62fc5ce75 - - -#### Return values - -The unique identifier for the migration job is returned if the job is successfully queued, or if unsuccessful, a null value will be returned. The migration job unique identifier can be used to query the migration job status while it is in the queue or being processed by using the GetMigrationJobStatus method. - -**Example:** - -```csharp -Guid MigrationJobId = TargetSite.CreateMigrationJob( - TargetWebId, - azureContainerSourceUri, - azureContainerManifestUri, - azureQueueReportUri); -``` - -### GetMigrationJobStatus - -This method queries the queue status for the specified migration job. It is an optional check after calling the CreateMigrationJob method. Once the migration job has completed, it will no longer show up in the queue and the notification queue and/or log output should be checked for detailed status. - -#### Syntax - -```xml -[ClientNS.ClientCallableMethod] -public SPMigrationJobState GetMigrationJobStatus(Guid MigrationJobId) -``` - -#### Parameters - -##### Id - -The unique identifier of the migration job returned from CreateMigrationJob method. - -#### Return values - -The migration job status is returned using a SPMigrationJobState object if the job is found in the queue, or if unsuccessful, a value of none (0) will be returned. - -**Example** - -```csharp -SPMigrationJobState CurrentJobState = TargetSite.GetMigrationJobStatus(MigrationJobId); -``` - -## Enumerations - -### SPMigrationJobState - -SPMigrationJobState is an enumeration that tracks possible major states in the import queue. - -#### Members - -| Member name | Description | -| ----------- | --------------------------------------------------------------------------------------------------------------------------- | -| None | Migration job is currently unknown to the queue, either through completion and removal, or invalid job identifier. Value=0. | -| Queued | Migration job is currently known by the queue and not being processed. Value=2. | -| Processing | Migration job is currently known by the queue and is being actively processed. Value=4. | - -## Import Package Structure - -Package structure is based on a constrained version of the Content Deployment package schema. Documentation for the original full schema can be found at [docs.microsoft.com](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). Until published on docs.microsoft.com, the constrained structure can be found in this document in the appendix. - -| XML file | Schema File | Description | -| ------------------ | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| ExportSettings.xml | DeploymentExportSettings Schema | Provides validation for the ExportSettings.XML file exported into the content migration package. ExportSettings.XML does the following:
- Contains the export settings specified by using the SPExportSettings class and other classes that are part of the content migration object model.
- Ensures that the subsequent import process (at the migration target site) enforces the directives specified in the export settings.
- Maintains a catalog of all objects exported to the migration package. | -| LookupListMap.xml | DeploymentLookupListMap Schema | Provides validation for the LookupListMap.XML file exported into the content migration package. LookupListMap.XML maintains a simple lookup list that records SharePoint list item (list item to list item) references. | -| Manifest.xml | DeploymentManifest Schema | Provides validation for the Manifest.xml file that is exported into the content migration package. Provides a comprehensive manifest containing listings of both the contents and the structure of the source site. The migration operation uses the manifest file to reconstitute the source site and its components when it is imported to the destination site. | -| Requirements.xml | DeploymentRequirements Schema | Provides validation for the Requirements.xml file exported into the content migration package. Requirements.xml maintains list of deployment requirements in the form of installation requirements on the migration target, such as feature definitions, template versions, Web Part assemblies, language packs, and so forth. | -| RootObjectMap.xml | DeploymentRootObjectMap Schema | Provides validation for the RootObjectMap.xml file exported into the content migration package.RootObjectMap.xml maintains a list of mappings of secondary (dependent) objects, which allows the import phase of the migration operation to correctly place the dependent objects relative to the locations of the root object mappings. | -| SystemData.xml | DeploymentSystemData Schema | Provides validation for the SystemData.xml file exported into the content migration package.SystemData.xml does the following: Collects a variety of low-level system data. Records the number and names of Manifest.xml files (in cases where the migration uses multiple manifests). | -| UserGroupMap.xml | DeploymentUserGroupMap Schema | Provides validation for the UserGroup.xml file exported into the content migration package. UserGroup.xml maintains a list of users and user security groups with respect to access security and permissions. | -| ViewFormsList.xml | DeploymentViewFormsList Schema | Provides validation for the ViewFormsList.xml file exported into the content migration package.ViewFormsList.xml maintains a list of Web Parts and tracks whether each is a view or form. | - -### Content structure - -File content that is referenced within the manifest of the package structure must be stored in either a flat or hierarchical structure within the Azure Blob Store Container defined by the CreateMigrationJob’s `azureContainerSourceUri` parameter. For example, import packages generated form a legacy version export will not be hierarchical, and will instead have all files stored at the root level with a pattern like ########.dat where the # symbols are hexadecimal characters starting at 0 and no file names are repeated within a package. Alternately, a package generated from a file share can have the source folder hierarchy and file names preserved in the same hierarchy. - -The main requirement for the structure is that the FileValue references in the **Manifest.XML** file must refer to the exact name and physical hierarchy that the content is stored in within the Azure Blob Store location for import. The destination file names and folder hierarchy from the import operation are not directly related to the physical naming and hierarchy and are instead defined through the **Manifest.XML** file. - -### ExportSettings.XML - -The **ExportSettings.XML** file is expected to be at the root of the Azure Blob Store Container defined by the CreateMigrationJob’s `azureContainerManifestUri` parameter. This required file is validated using the constrained DeploymentExportSettings.XSD, which has some limited changes from current published [full 2013 package schema](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). - -The main requirement is that the ExportSettings `SiteUrl` value must be populated with a URL consistent with the source URL used for the rest of the import package. In the case of file shares as a source, the URL would be pre-specified to be the source URL in the rest of the package, whereas a package generated through an export operation at a source site would be its original source site collection URL. - -### LookupListMap.XML - -The **LookupListMap.XML** file, if included, is expected to be at the root of the Azure Blob Store Container defined by the CreateMigrationJob’s azureContainerManifestUri parameter. This optional file is validated using the constrained **DeploymentLookupListMap.XSD**, which has no change from current published [full 2013 package schema](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). - -Since an import package for the pipeline does not include defining fields or views on a list or document library, the **LookupListMap.XML** file will normally include no child nodes under the root and as such can also be excluded from the package if not required, although a warning may be logged in this case. - -### Manifest.XML - -All instances of the **Manifest.XML** file for a package are expected to be at the root of the Azure Blob Store Container defined by the CreateMigrationJob’s `azureContainerManifestUri` parameter. This required file is validated using the constrained **DeploymentManifest.XSD**, which has multiple major changes and significant reduction in types from current published [full 2013 package schema](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). - -The **Manifest.XML** is the primary descriptor for metadata within the package, and provides the list/folder/item hierarchy, along with metadata for the items including references back to users and groups defined in the **UserGroupMap.XML** file. There may be more than one **Manifest.XML** file (which can be identified using different file names to uniquely identify them), and all are found by the import pipeline through references within the **SystemData.XML** file’s ManifestFile entries. - -The main requirements for **Manifest.XML** to be able to successfully import through the pipeline is that the Web Id and Document Library ID/List ID be consistent with the target location. If a Web ID is used which doesn’t match the target location, errors will occur because the parent web for the import operation cannot be found. - -Likewise, an incorrect Document Library ID/List ID will prevent the importation into the target Document Library or List. IDs should never be reused within the same site collection, so same packages should not be imported to the same target site collection regardless of the destination web. - -For individual files and folders within the document library or list, their identifiers should be consistent between import events to the same location. Specifically, performing an import of a package generated from a file share would initially require generating new GUIDs for each file and folder, along with matching GUIDs for the list items that represent them. Therefore, performing a second import against the same target using the same package would keep the same IDs, but performing a second import against the same target using a new package for the same content would result in ID conflicts and import errors for all items in conflict. - -The package generated initially from a file share is effectively a form of record for the original generated IDs and can potentially be used as a reference for follow up package generation to prevent ID collisions when unintended, and to allow like IDs to ensure correct overwrite, deletion or move activities. - -### Requirements.XML - -The **Requirements.XML** file is expected to be at the root of the Azure Blob Store Container defined by the CreateMigrationJob’s azureContainerManifestUri parameter. This optional file is validated using the constrained DeploymentRequirements.XSD, which has no change from current published [full 2013 package schema](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). - -For file shares this is expected to normally include no child nodes under the root and as such can also be excluded from the package if not required, although a warning will be logged in this case. - -### RootObjectMap.XML - -The **RootObjectMap.XML** file is expected to be at the root of the Azure Blob Store Container defined by the CreateMigrationJob’s `azureContainerManifestUri` parameter. This required file is validated using the constrained **DeploymentRootObjectMap.XSD**, which has some limited changes from current published [full 2013 package schema](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). The most common `RootObject` that will be included will be a single object of type List. The Id for this item should be the List Id for the target list, and the `ParentWebID` should match the Id of the parent target web containing this list in order for migration to be successful. The Id, WebUrl and Url values of this object must also match the related structure laid out in the **Manifest.XML** file. - -### SystemData.XML - -The **SystemData.XML** file is expected to be at the root of the Azure Blob Store Container defined by the CreateMigrationJob’s `azureContainerManifestUri` parameter. This required file is validated using the constrained **DeploymentSystemData.XSD**, which has no change from current published [full 2013 package schema](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). - -The `SchemaVersion` information is expected to reference the current Build and DatabaseVersion of the target farm, a Version of “15.0.0.0”, and the `SiteVersion` value is expected to always match the target site collection `UIVersion` (i.e. most commonly this will be “15”). Each **Manifest.XML** file for the package is expected to be listed in this file within the `ManifestFile` entries. - -The SystemObjects that define dependent objects that should remain immutable by the migration code should also be listed here to ensure correct behavior of the import operation. The following is an example of the common objects in the **SystemObjects.XML** file from a file share based import, noting that the IDs are expected to be different for each package, and the URLs may be different. - -#### Table 1: Example SystemData.XML file - -```xml - - - - - - - - - - - - - - -``` - -### UserGroupMap.XML - -The **UserGroupMap.XML** file is expected to be at the root of the Azure Blob Store Container defined by the CreateMigrationJob’s `azureContainerManifestUri` parameter. This required file is validated using the constrained **DeploymentUserGroupMap.XSD**, which has no change from current published full 2013 package schema. - -The **UserGroupMap.XML** file may not contain any User or Group entries but doing so will prevent author or security information from being populated during import and warnings will be logged in this case. Login and SID values for users must be either adjusted to match the values in SharePoint Online, or if the account no longer should exist can be listed as `IsDeleted = “true”` to prevent lookup failures and additional slowdown during the import operation. - -### ViewFormsList.XML - -The **ViewForms.XML** file, if included, is expected to be at the root of the Azure Blob Store Container defined by the CreateMigrationJob’s `azureContainerManifestUri` parameter. This optional file is validated using the constrained **DeploymentViewFormsList.XSD**, which has no change from current published full 2013 package schema. - -Since an import package for the pipeline does not include defining fields or views on a list or document library, the **ViewFormsList.XML** file will normally include no child nodes under the root and as such can also be excluded from the package if not required, although a warning may be logged in this case. - -## Logging - -The logs that the import pipeline creates must be easily parsed by machine with a goal of being able to pinpoint when and where failures occur, including errors and warnings, and will tell the consumer or the ISV where and why the failure occurred. - -Upon completion, these logs will be copied to the `azureContainerManifestUri` location as the SAS token specified in the URI allows write access. The same output logs are also placed at the *“_catalogs/Maintenance Logs”* location of the target site collection as a text file. The logs will only be copied to the destination locations once the job has finished and removed from the queue. - -Several log types can be included such as the full import log, along with warning and error files that contain only the subset of import warnings or errors respectively. Log files have unique `datetime` and `job id` stamps to allow each attempted import event to have a unique log for better debugging purposes. - -## Changes for those using the "Ship Disk" option - -To use the Migration API, you must have a temporary storage container in Azure. When uploading files into the temporary storage, a checksum is required as a property on every file. For files larger than 15GB, this is done using QuickXorHash (see example below). For files 2 GB or smaller, MD5 is required as a property on every file. - -However, when shipping the data on hard drives this property doesn’t get assigned automatically. As a work around, we have adapted the Migration API to allow the checksum to be passed for every file as part of the manifest. This also applies for IV values when encrypting the data. - -Since the MD5 is generated at the source instead of at the upload time in Azure, Microsoft can confirm the integrity of the file directly against the source MD5. - -## What is stored in those Azure Blob Containers? - -The Migration API requires the Azure Container for content passing and also for log and queue reporting. It can be split down as a summary as follows:
- -| Content | Manifest | -| ----------------- | --------- | -| Files and folders | XML files | - -There are two new optional parameters in manifest.xml: - -- QuickXorHash -- MD5Hash - -### Preparing the package -The method for calling the migration job doesn’t change; only the package generation needs to be changed. - -In the Manifest container one file is named Manifest.xml. There are 2 optional attributes added to the file node: *QuickXorHash* and *MD5Hash*.
- -**Example for files over 15 GB:** - -```xml - - - - - - - - - - - - - - - - - - - - ``` - -**Example for files under 2 GB:** - -```xml - -``` - -## Best Practices and Special Mentions - -### Package size - -Even if the API support 15GB files, we recommend package sizes of up to 250 MB OR 250 items (depending which one comes first). If you have a file larger than that recommended size limit then you should send it in its own package. The same applies to versions; each version counts against the size limit and item count. Additionally, all the versions of a file should be in the same package. - -### File size - ->[!Note] ->The Migration API supports individual files over **15 GB**. The maximum size is current to that set by SharePoint Online. - -### Only un-compressed packages are supported +### December 2024 -The import pipeline does not support compressed packages. The file content must be stored in a different Azure Storage container from the manifest and related descriptive XML files. This decision was made to prevent the overhead of processing time on both ends of the migration (to compress and decompress), and also to ease package creation and modification. Compression of individual files such as into zip archives is supported as long as they are referenced in the import package as the archive itself, not the contents. +We applied quota on *Share with Me* items per user. Check [ShareWithMe event quota](/sharepoint/dev/apis/migration-api-shared#quota) for more detail. -### API supports import of multiple file versions +### November 2024 -Import packages can have references to multiple versions of a file, major and minor, up to regular limits imposed within SharePoint. It is important that each version of that file be included in the package even if some of the versions already exist in SPO. +We enabled logging all file-level events during migration, such as file deletion, to support auditing. -### API supports preservation of identifiers +### July 2024 -The identifiers used within the import package explicitly are used during import to identify content. This allows preservation of existing identifiers for document library contents from a source environment. However, it also imposes a complexity during import package creation or transformation that mandates that the package explicitly reference the target web and list identifiers. Content type identifiers, file/folder item GUIDs, and list item integer identifiers are all preserved during import. If incorrect identifiers are specified in the package, import will fail. +We started enforcing HTTPS connections to SharePoint-provided Azure Blob Storage Containers by adding a `spr=https` field in SAS tokens. This enforcement will be fully effective on July 21, 2024. Check [Use Azure Blob Storage Containers and Azure Queues with SharePoint Migration API](migration-azure.md) for details. -Additionally, due to identifier preservation, import events can potentially be done in successive iterations using different packages, allowing items to potentially move in location if their identifiers have not changed. +### April 2024 -### This is an overwrite API +We added new fields in `JobEnd` events to indicate the count and bytes imported for files. Check [Migration events in Azure Queue](migration-events.md#jobend-import) for details. -The import pipeline does support import of versioning data on files and list item metadata, but as of now if you submit a file and then resubmit the same file with changes the import process will delete and replace the original and all versions with the ones included in the ones in the current package being imported. +### January 2024 -### We do not support Active-Active scenario +We reformatted this document to bring clarity and correct errors. -This means we expect that the target site will remain non-active for users until the migration is over. The source may be kept in a read write state until the final migration event, as a method of reducing downtime for end users, but once the migration is complete there should be a switch for the users to start using their new SPO destinations and stop using the previous repository. +## Migration steps overview -### Permissions in Azure +Start a migration job with three steps. Check the guidance in each of the steps in this section. -To ensure immutability of source blobs, the import pipeline will accept a SAS key with only the Read and List access flags set for the File container. Likewise, the import pipeline requires a SAS key with Read, List and Write access for the Manifest container so that we can write back log files at the end of the import operation. If these criteria are not met, the pipeline will reject it during job creation. +### Provision the destination containers and the queue -### All files in Azure must have snapshot created to import successfully - -To prevent unintended file modification of the source blobs, the import pipeline will only import files if they have a snapshot created for them within Azure. If they do not, then the import pipeline will skip the files in this state and throw errors. The import pipeline will use the latest snapshot of the file available at the time of import. - -### Security and encryption - -The import pipeline is using Azure Blob Storage security model as is. This means we will not do any special treatment for those azure containers that would differentiate from any other azure containers. Additionally, the import pipeline currently does not accept encryption keys for content from the customer. Any encrypted content will be treated as opaque files that SharePoint may list, but be unable to index, the same as if encrypted files were uploaded through the UI to the environment. - -### Events and event handlers - -The import pipeline allows event handlers to be referenced on list items but doesn’t allow defining event handlers at the list level at this time. The import pipeline does not fire events as items are imported, so existing event handlers will not fire due to the import event. - -### Resolving Users - -If the Migration API was unable to resolve a user using the login provided in the UserGroup.xml and no System ID is provided, then: - -1. This user will be replaced by “System Account” in the associated metadata within the package ( author, editor etc.). -1. A warning will be reported in the ImportLogs – “Failed to ensure user 'user@contoso.com'” - -If the migration API was unable to resolve a user using the login provided in the UserGroup.xml and the System ID is provided (which is the SID for the user in the on-premises AD), then: - -1. A new deleted user with the provided login and SystemId is created and is used in the associated metadata within the package. -1. A warning will be reported in the ImportLogs- “Failed to retrieve user 'user@contoso.com' attributes from the SiteUsers; falling back to passed in values” - -## Appendices - -### Acronyms Defined - -| Acronym | Definition | -| ------- | --------------------------------------------------------- | -| BOT | SharePoint server running timer jobs | -| CDB | Content database, containing site collections and content | -| CFE | Content farm front end server | -| SPO | SharePoint Online | -| ABS | Azure Blob Storage | - -### Helpful Resources - -- [SharePoint Online Client Components SDK](https://www.microsoft.com/download/details.aspx?id=42038) -- [Azure Windows Azure SDK for .NET - 2.4](https://www.microsoft.com/download/details.aspx?id=43709) -- [Bulk Creation of OneDrive for Business sites](https://msdn.microsoft.com/library/office/jj163783(v=office.15).aspx) -- [Restrictions and limitations when you sync SharePoint libraries to your computer through OneDrive for Business](https://support.office.com/article/restrictions-and-limitations-when-you-sync-files-and-folders-7787566e-c352-4bd4-9409-fd100a0165f6) -- [Types of files that cannot be added to a list or library](https://support.office.com/Article/Types-of-files-that-cannot-be-added-to-a-list-or-library-30be234d-e551-4c2a-8de8-f8546ffbf5b3?ui=en-US&rs=en-US&ad=US) - -## Working with import package security structures - -This section covers a brief overview of what is contained within an export package that includes security with regard to permissions. This can allow the system to determine user and group membership along with roles, and specific assignments (unique permissions set at the object level and its children unless overridden at a deeper child object). - -### How to interpret the security identifiers in the package files - -UserGroup.xml file defines all users and groups within the exported web(s). The items within this file do the following: - -- User objects include the information about specific users, including identification of a specific security principle as a domain group or not, login, and the base 64 encoded SystemId (SID) of the security principle. -- Group objects include the information about specific groups and the direct membership list of that group. -- Owner values on group objects and UserId values on member objects within group objects map to other Id values of other user or group objects respectively. - -#### Table 2: Users and Groups annotated in UserGroupMap - -```xml - - - - - … - - - - - - - - - - … - - -``` - -**Manifest.xml** contains the metadata about all the content within the exported web(s). The items within this file do the following: - -- Roles objects include the list of defined roles on the web. -- Role objects define the individual role, including ID, internal permissions rights mask flags and display information. - - RoleId values define the identifiers of the Role objects. - - PermMask values contain the rights mask flags. -- RoleAssignments objects include the list of unique permissions (RoleAssignment objects). -- RoleAssignment objects include the list of distinct Assignment objects (if any). -- Individual RoleAssignment objects contain the actual membership of one distinct user or group and their actual Role. - - RoleId values map to the RoleId values of the Role objects. - - PrincipalId values map to Id values of user or group objects respectively in UserGroups.xml. - -#### Table 3: Roles and RoleAssignments annotated in manifest - -```xml - - … - - - - - - - - - - - - - - … - - - … - -``` - -## Constrained XSD structures - -Included below are the XSD files used for package validation in the import pipeline, when different than the original 2013 full schema which can be found at [official SharePoint documentation](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). - -### DeploymentExportSettings.XSD - -#### Table 4: Constrained DeploymentExportSettings.XSD - -```xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` - -### DeploymentLookupListMap.XSD -There is no change from current published full 2013 package schema. - -### DeploymentManifest.XSD - -##### Table 5: Constrained DeploymentManifest.XSD - -```xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +> [!IMPORTANT] +> Use [GetMigrationJobProgress API](migration-job-progress-api-reference.md) to retrieve migration job status. +> +> Provisioning Azure Queues for migration job status tracking is no longer required. Deprecation is planned for the second half of 2026. Until then, Azure Queues will remain available for status retrieval. - - +Use the `ProvisionMigrationContainers` method to provision the containers. Check [Use Azure Blob Storage Containers and Azure Queues with Migration API](migration-azure.md) for details. You can also use your own containers and queues if needed. - - +### Prepare the content - - - - - - - - - +Package the contents in the defined format and upload them to Azure Blob Storage Containers as the content package. - - - - - - - +Check [Content package](migration-content-package.md) to see the detailed requirements. - - +### Create the manifest files - - - - - - +Based on the contents, create manifest files in XML format, and upload them to Azure Blob Storage Containers as the manifest package. - - - - +Check [Manifest files](migration-manifest.md) to see the detailed requirements. - - - - - - - - - - - - +### Use Migration API to start the migration and get status - - +The `CreateMigrationJob` method creates a migration job, which is queued up for processing. Migration API manages the queue and returns status and logs. Use the `CreateMigrationEncrypted` method to migrate encrypted contents. Check [SharePoint Migration API Reference](migration-api-reference.md) for details. - - - - +> [!IMPORTANT] +> Use GetMigrationJobProgress API to track migration job status. - +Upon creation of a new migration job, Migration API returns the Job ID. Track the status of the import with [GetMigrationJobProgress API](migration-job-progress-api-reference.md). - - +Migration API generates logs in the manifest container. Check the log entries for migration results. - - +Migration API also generates logs of file-level activities performed by migration. The supported file-level activities include FileUploaded, FileDeleted, FileRenamed, FileMoved. Check M365 Admin Center for activity details when needed. - - +## Best Practice - - - - - +### Use app-based authentication - - - -``` +Migration generates workload to the SharePoint backend differently from end user-generated traffic. To properly allocate resources with our elastic capability, only use app-based authentication in your migration solution. -### DeploymentRequirements.XSD +Don't use user mode in your migration solution. Running migration in user mode triggers increased throttling, resulting in poor performance. -There is no change from current published [full 2013 package schema](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). +To learn more about how to register an app ID and how to implement app-based authentication, check [How to register an app ID](/azure/active-directory/develop/active-directory-v2-registration-portal) and [Microsoft Graph Auth guidance](/graph/auth). -### DeploymentRootObjectMap.XSD +### Microsoft Entra ID Permissions -#### Table 6: Constrained DeploymentRootObjectMap.XSD +Microsoft Entra ID provides two types of permission: Delegated Permission and Application Permissions. Check[ +Permissions and consent in the Azure Active Directory v1.0 endpoint](/azure/active-directory/develop/v1-permissions-and-consent) for details. -```xml - - +For SharePoint and OneDrive migration scenarios, follow the Microsoft Entra ID permission specification. - - - - +For migration tools that rely on end-user sign-in and presence, use Delegated permission. - - - - - - - - +For service-based migration tools that run without a signed-in user present, such as applications that run as background services, use Application permission. - - - - - - - - +### App IDs - - - - - +You can choose to share a single App ID to cover multiple migration solutions created or create an individual App ID for each of the products. Make sure to register App IDs. Sharing App IDs doesn't affect performance or throttling. - - -``` +### Keep destination SharePoint Site unactivated -### DeploymentSystemData.XSD +To avoid migration issues, deactivate the target site for users until migration completion. The source could remain active, allowing read and write access to keep productivity. Switch users to the new SharePoint destination sites after migration completion. -There is no change from current published [full 2013 package schema](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). +## Performance -### DeploymentUserGroupMap.XSD +Migration API processes jobs through a queue mechanism with preconfigured workload management settings. Migration API processes the jobs on a best-effort basis, without Service Level Agreement (SLA) or guaranteed performance. -There is no change from current published full 2013 [full 2013 package schema](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). +### Optimize migration performance -### DeploymentViewFormsList.XSD +In order to ensure optimal performance for your migration projects, it's important to plan carefully, especially when dealing with large-scale migrations. For more information on how to estimate timespans and optimize performance, see our [performance guide](/sharepointmigration/sharepoint-online-and-onedrive-migration-speed). -There is no change from current published [full 2013 package schema](https://docs.microsoft.com/sharepoint/dev/schema/content-migration-schemas). +### I'm seeing throttling messages -## Sample: Using REST to call the API +To ensure good user experiences for all Microsoft 365 customers, SharePoint uses throttling to protect the SharePoint infrastructure. Avoid getting throttled by following [throttling guidance](https://aka.ms/spo429). -```http -https://{site_url}/_api/site/CreateMigrationJobEncrypted +## Special articles -{ - "options": { - "AES256CBCKey": "000000000000000000000000000000000000000000000000000000=" - }, - "gWebId": "00000000-0000-0000-0000-000000000000", - "azureContainerSourceUri": "https://tenant.blob.core.windows.net:443/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000=rw", - "azureContainerManifestUri": "https://tenant.blob.core.windows.net:443/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000=rw" -} -``` +### Migrating sharing events of files and folders -For the container: +Check [Sharing events](/sharepoint/dev/apis/migration-api-shared) article for instructions when migrating shared events metadata with files and folders. -```http -https://{site_url}/_api/site/ProvisionMigrationContainers -``` +### Web Parts -> [!NOTE] -> The **Migration API** is not available for users of Office 365 operated by 21Vianet in China. It is also not available for users of Office 365 with the German cloud using the data trustee, *German Telekom*. However, it is supported for users in Germany whose data location is not in the German data center. +Use SharePoint Migration Tool (SPMT)'s Web Part serializer DLL to migrate Web Parts into SharePoint. Check [Migrate Web Parts](/sharepoint/dev/apis/migrate-webparts-with-migrationapi) for instructions. diff --git a/docs/apis/migration-api-reference.md b/docs/apis/migration-api-reference.md new file mode 100644 index 000000000..0db09f400 --- /dev/null +++ b/docs/apis/migration-api-reference.md @@ -0,0 +1,232 @@ +--- +title: "SharePoint Migration API Reference Guide" +description: "This article provides in-depth information on how to use the SharePoint Migration API." +ms.date: 07/16/2025 +ms.author: ranren +author: underreview +manager: dapodean +audience: ITPro +ms.subservice: migration-tool +ms.topic: article +ms.localizationpriority: high +ms.collection: + - SPMigration + - m365-collaboration +--- + +# SharePoint Migration API Reference Guide + +This guide describes the usage of SharePoint Migration API, which imports content into SharePoint, based on manifest files. + +## CSOM and REST + +Migration API supports both SharePoint Client Side Object Model (CSOM) and REST. + +### Use NuGet Packages with CSOM + +To reference the SharePoint Client Side Object Model (CSOM) in your solution, use NuGet packages. + +Manage dependencies easily and ensure your solution is using the latest version of the CSOM library with NuGet packages. + +Get the latest version of the CSOM package at the [SharePoint Client-side Object Model Libraries](https://www.nuget.org/packages/Microsoft.SharePointOnline.CSOM) with the ID `Microsoft.SharePointOnline.CSOM`. + +Check [Get to know SharePoint REST service](/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service) for instructions on REST API. + +## CreateMigrationJob method + +Creates a new migration import job with the import package specified in `azureContainerSourceUri` parameter. + +### CreateMigrationJob syntax + +```csharp +public Guid CreateMigrationJobEncrypted( +Guid gWebId, +string azureContainerSourceUri, +string azureContainerManifestUri, +string azureQueueReportUri, +EncryptionOption AES256CBCKey +) +``` + +```rest +POST https://{site_url}/_api/site/CreateMigrationJobEncrypted +{ + "options": { + "AES256CBCKey": "000000000000000000000000000000000000000000000000000000=" + }, + "gWebId": "00000000-0000-0000-0000-000000000000", + "azureContainerSourceUri": "https://tenant.blob.core.windows.net:443/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000=rw", + "azureContainerManifestUri": "https://tenant.blob.core.windows.net:443/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000=rw" +} +``` + +### CreateMigrationJob parameters + +#### gWebID + +Required. + +A **String** value that contains the unique identifier of the destination web targeted for the package import. The import package itself specifies additional information and identifiers for the import. You can programmatically find this identifier by querying the target web using CSOM calls. + +#### azureContainerSourceUri + +Required. + +A **String** value that contains the valid URI, including the SAS token, to access the Azure Blob Storage Container that contains the binary files of type block. + +See [Use Azure Blob Storage Containers and Azure Queues with SharePoint Migration API](migration-azure.md) for instructions on using Azure Blob Storage Containers in migration. + +When using content containers not provided by this method, Migration API requires `Read`, and `List` permissions only. Ensure that the start time of the SAS token is set at or before the job submission. Also, when setting the expiration time, allow a reasonable duration for the import process to complete. + +Migration API doesn't require `List` permission from containers provisioned with `ProvisionMigrationContainers` method. + +#### azureContainerManifestUri + +Required. + +A **String** value that contains the valid URI, including the SAS token, to access the Azure Blob Storage Container, which contains the block blobs for the manifest and other packages describing XML files. Migration API writes log to this container. This container can't be the same as the one used for the `azureContainerSourceUri`. + +See [Use Azure Blob Storage Containers and Azure Queues with SharePoint Migration API](migration-azure.md) for instructions on using Azure Blob Storage Containers in migration. + +When using content containers not provided by this method, Migration API requires `Read`, `List`, and `Write` permissions only. Ensure that the start time of the SAS token is set at or before the job submission. Also, when setting the expiration time, allow a reasonable duration for the import process to complete. + +#### azureQueueReportUri + +Optional. + +A **String** value that contains the valid URL, including the SAS token, to access the user-provided Azure Queue for migration job progress. Use `null` if receiving import status updates isn't necessary. + +If this value isn't `null`, and the SAS token contains the correct permissions, Migration API writes import status updates to the queue at the URL provided. + +Share the notification queue among multiple migration jobs. Migration API identifies each job with unique Job ID values in the notification queue. + +See [Azure](migration-azure.md) for instructions on using Azure Queue in migration. Check [Migration events in Azure Queue](migration-events.md) for types of events. + +Requires `Add`, `Read`, and `Update` permissions only. If the SAS token has other permissions, the migration job will be unable to add events to the queue. + +### CreateMigrationJob return value + +#### Job ID + +A **Guid** value, which contains Job ID, the unique identifier of the migration job. The method returns a `null` value, if it fails to create the job. Use Job ID to query the status of migration jobs with `GetMigrationJobStatus` method. + +### Example + +```csharp +Guid MigrationJobId = TargetSite.CreateMigrationJob( +TargetWebId, +azureContainerSourceUri, +azureContainerManifestUri, +azureQueueReportUri); +``` + +## CreateMigrationJobEncrypted method + +Creates a new migration import job with an encrypted PRIME package. + +Check the encryption instructions in [Azure](migration-azure.md) for Azure Blob Storage Container and Azure Queue encryption used. + +### CreateMigrationJobEncrypted syntax + +```csharp +public Guid CreateMigrationJobEncrypted( +Guid gWebId, +string azureContainerSourceUri, +string azureContainerManifestUri, +string azureQueueReportUri, +EncryptionOption AES256CBCKey +) +``` + +```rest +POST https://{site_url}/_api/site/CreateMigrationJobEncrypted +{ + "options": { + "AES256CBCKey": "000000000000000000000000000000000000000000000000000000=" + }, + "gWebId": "00000000-0000-0000-0000-000000000000", + "azureContainerSourceUri": "https://tenant.blob.core.windows.net:443/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000=rw", + "azureContainerManifestUri": "https://tenant.blob.core.windows.net:443/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000=rw" +} +``` + +### CreateMigrationJobEncrypted parameters + +`gWebID`, `azureContainerSourceUri`, `azureContainerManifestUri`, and `azureQueueReportUri` parameters have the same requirements as in `CreateMigrationJob` method. + +Provide `EncryptionOption` parameter as instructed below. + +#### EncryptionOption + +Required. + +A `EncryptionOption` object, containing the AES256CBCKey used to decrypt the output. + +Migration API encrypts the output with the AES256CBCKey key supplied. + +See `[EncryptionOption](https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.encryptionoption)` class for details. + +### CreateMigrationJobEncrypted return value + +See Return value in `CreateMigrationJob` method. + +## GetMigrationJobStatus method + +> [!IMPORTANT] +> Use [GetMigrationJobProgress API](migration-job-progress-api-reference.md) to retrieve migration job status. Deprecation of GetMigrationJobStatus API is planned for the second half of 2026. Until then, it will remain available for status retrieval. + +Retrieves the processing status for a designated migration job. + +Migration API removes completed migration jobs from the timer job queue. Check the notification queue and/or log outputs for import results. + +### GetMigrationJobStatus syntax + +```csharp +[ClientNS.ClientCallableMethod] +public SPMigrationJobState GetMigrationJobStatus(Guid MigrationJobId) +``` + +### GetMigrationJobStatus parameters + +#### ID + +Required. + +A **Guid** value, which contains the migration Job ID, is returned from `CreateMigrationJob`. + +### GetMigrationJobStatus return value + +A `SPMigrationJobState` object, which contains the status of the migration job. + +### GetMigrationJobStatus example + +```csharp +SPMigrationJobState CurrentJobState = TargetSite.GetMigrationJobStatus(MigrationJobId); +``` + +## SPMigrationJobState enumeration + +Contains members representing the status of migration jobs in the import queue. + +### SPMigrationJobState members + +#### None + +Value: 0 + +The queue doesn't contain the migration job with the Job ID. The possible reasons are: + +- Migration API has completed the job and removed it from the queue. +- The Job ID is invalid. + +#### Queued + +Value: 2 + +The queue contains the migration job. Migration API isn't processing the job. + +#### Processing + +Value: 4 + +The queue contains the migration job. Migration API is processing the job. diff --git a/docs/apis/migration-api-shared.md b/docs/apis/migration-api-shared.md index 4256f0086..dfcc26fd9 100644 --- a/docs/apis/migration-api-shared.md +++ b/docs/apis/migration-api-shared.md @@ -1,74 +1,84 @@ --- title: "SPO Migration API: Migrating shared files and folders" -ms.author: jhendr -author: JoanneHendrickson -manager: pamgreen -ms.topic: article description: "Migrating shared files and folders using item references." ---- - - +ms.date: 06/28/2022 +ms.author: jihongzuo +author: shiongzuo +manager: Dan.Podeanu +ms.topic: article +ms.subservice: migration-tool +--- # Migrating shared files and folders ## Implementation As documented in the Migration PRIME API, apply sharing metadata by using **item references**. The older method of using the *Shared With* column should not be used any further. -For an item that is shared with a user, add the **SharedWithEvents** block within its *ListItem* block. The **SharedWithEvents** block represents an occurrence when the item was shared, including the user who did the sharing (SharingInitatiorId and SharedById), as well as the time of sharing (SharedTime). +For an item that is shared with a user, add the **SharedWithEvents** block within its *ListItem* block. The **SharedWithEvents** block represents an occurrence when the item was shared, including the user who did the sharing (SharingInitatiorId and SharedById), as well as the time of sharing (SharedTime). Add a SharedWithMember block for each person that the item was shared with during that occurrence. All user ids must be valid entries in the UserGroup.xml. ```XML - - - - - - - - - - - + + + + + + + + + + ``` + ## Best Practices + ### The basics + For each file or folder that was shared with a user in the source, create an item reference for that item in the recipient’s OneDrive. Every item reference created will appear in the user’s *Shared with Me* view in OneDrive. Remember to give the user permission to access the item as well. ### Inheritance -Be sure to use inheritance correctly for sharing. When creating an item reference for a file or folder, check if its parent folder (or higher) already has an item reference created for it. If so, do not create another one for the child item. This will prevent users from seeing duplicate items in their *Shared with Me* view and reduce migration and service load as well. -**Example:** When a folder is shared and the recipient can access all of the folder’s contents, an item reference should *only* be created for the shared folder -- not for its contents. The only item that should appear in the recipients *Shared with Me* is the shared folder. +Be sure to use inheritance correctly for sharing. When creating an item reference for a file or folder, check if its parent folder (or higher) already has an item reference created for it. If so, do not create another one for the child item. This will prevent users from seeing duplicate items in their *Shared with Me* view and reduce migration and service load as well. + +**Example:** When a folder is shared and the recipient can access all of the folder’s contents, an item reference should *only* be created for the shared folder -- not for its contents. The only item that should appear in the recipient's *Shared with Me* is the shared folder. -This same guidance should also be used for permissions (ACLs). Only apply permissions on a child item where the required permissions are different than its parent item. Make sure not to exceed 5000 unique ACLs on a site. It may be useful to check how many ACLs you create and warn the user prior to migration. There is also a hard limit of 50,000 unique ACL's that will be enforced. If you are close to reaching the 5000 limits, we recommend that the permission model be simplified on the source before migration. +This same guidance should also be used for permissions (*access control lists, also known as ACLs*). Only apply permissions on a child item where the required permissions are different than its parent item. Make sure not to exceed 5000 unique ACLs on a site. It may be useful to check how many ACLs you create and warn the user prior to migration. There is also a hard limit of 50,000 unique ACLs that will be enforced. If you are close to reaching the 5000 limits, we recommend that the permission model be simplified on the source before migration. ### Sharing with groups + For items shared with a group of individuals in the source, the content may be migrated into a shared library (eg. a team site) in which all of those individuals are given access. ### Anonymous sharing links + Do not migrate anonymous sharing links from the source; this is not useful as it’s not possible to know which users used that link in the source. Users should evaluate whether anonymous links are still needed and create new ones on the destination if so. ### Sharing with external users -Before starting migration, you must ensure all users are provisioned in the customer tenant. For users external to the tenant (ie. from a different organization), provision them as B2B collaboration users in Azure Active Directory. This is done in the Azure portal following these steps: -- [Add Azure Active Directory B2B collaboration users in the Azure portal](https://docs.microsoft.com/azure/active-directory/b2b/add-users-administrator). +Before starting migration, you must ensure all users are provisioned in the customer tenant. For users external to the tenant (ie. from a different organization), provision them as B2B collaboration users in Azure Active Directory. This is done in the Azure portal following these steps: + +- [Add Azure Active Directory B2B collaboration users in the Azure portal](/azure/active-directory/b2b/add-users-administrator). Once the external users are provisioned, share files and folders with them during migration the same way as internal users. ### Permission and Sharing -The per user sharing model in SharePoint relies on both permissions and “Shared With” data references for an object to be considered shared with an individual. If a user has access to content, but no “Shared With” references, they will not see the content show up in their Shared With Me view within their OneDrive For Business site. + +The per-user sharing model in SharePoint relies on both permissions and “Shared With” data references for an object to be considered shared with an individual. If a user has access to content, but no “Shared With” references, they will not see the content show up in their Shared With Me view within their OneDrive For Business site. However, if they are indicated in “Shared With” references but do not have any access to the content, they will either never see the content show up in their Shared With Me view within their OneDrive For Business site or when they try to use a link from there it will be denied access. To preserve sharing information, both the permissions and “Shared With” references will need to be correctly set. The permissions can be set at different levels of the content hierarchy using scopes (unique ACLs), that apply to that object and any of its children unless they themselves have unique permissions. -Using PRIME, content can be migrated by using SPFile/SPFolder objects with a document library followed by SPListItem objects that reference the imported File/Folder objects. During the ListItem import, the “Shared With” references data can be imported, and then the security can be applied afterward within the same migration package, by setting up scopes (ACLs) and role assignments (ACEs) for the content hierarchy as needed. +Using PRIME, content can be migrated by using SPFile/SPFolder objects with a document library followed by SPListItem objects that reference the imported File/Folder objects. During the ListItem import, the “Shared With” references data can be imported, and then the security can be applied afterward within the same migration package, by setting up scopes (ACLs) and role assignments (ACEs) for the content hierarchy as needed. Permissions migration is performed using the DeploymentRoleAssignments object with RoleAssignment entries representing specific scopes and Assignment entries representing assignments of specific roles to specific principals. Since this code ends up breaking inheritance for content and applying the specified role assignments, it has the same limitations as using other object model approaches to setting permissions in SharePoint. +> [!NOTE] +> The **Migration API** is not available for users of Office 365 operated by 21Vianet in China. + +### Quota ->[!NOTE] ->The **Migration API** is not available for users of Office 365 operated by 21Vianet in China. It is also not available for users of Office 365 with the German cloud using the data trustee, *German Telekom*. However, it is supported for users in Germany whose data location is not in the German data center. +Do not migrate more than 1,000 *Share with Me* events for any receiver within 24 hours. If a receiver already has 1,000 *Share with Me* events being imported within 24 hours, they will NOT receive any additional *Share with Me* events during the time window. And Import API will send back warning messages indicating some *Share with Me* events have been throttled. diff --git a/docs/apis/migration-api-video-transcripts.md b/docs/apis/migration-api-video-transcripts.md new file mode 100644 index 000000000..324d77d57 --- /dev/null +++ b/docs/apis/migration-api-video-transcripts.md @@ -0,0 +1,66 @@ +--- +title: "Exporting video transcripts when using the SharePoint Import Migration API" +description: "Learn how to export videos that contains a transcript as an alternate content stream." +ms.date: 06/30/2023 +ms.author: jhendr +author: JoanneHendrickson +manager: serdars +search.appverid: MET150 +ms.subservice: migration-tool +--- + +# How to export video transcripts using the SharePoint Important Migration API + +Transcripts of video files, like those in Teams meeting recordings, are stored in a format similar to a zip file. If you are migrating videos from one source to another, you must use a new flag to ensure the entire zip file is migrated to the destination. Otherwise, you will inadvertently leave behind the alternate content stream, the transcript. + +## Step 1: Check if the file contains alternate content streams + +1. Check to see if the SPFile object has the property **SPFile.HasAlternateContentStreams**. Use the [REST or CSOM API](/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest) to fetch this property value. +3. If set to **True**, the file contains alternate content streams. + + +***Example:*** + +```powershell + +GET https://{site_url}/_api/web/GetFileByServerRelativeUrl(‘/serverrelativeurl’)/HasAlternateContentStreams + +``` + +## Step 2: Download the file with alternate content streams + +A zip formatted stream including primary and alternate streams can be downloaded if the file request includes **SPOpenBinaryOptions.GetAsZipWithAltStreamsIfAvailable**. + +1. Use [REST or CSOM API](/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest) to download the zip formatted content stream. +2. You must include **SPOpenBinaryOptions.GetAsZipWithAltStreamsIfAvailable**. If this is not specified, only the primary file content stream is returned. + +***Example:*** + +```powershell + +GET https://{site_url}/_api/web/GetFileByServerRelativeUrl(‘/serverrelativeurl’)/OpenBinaryStreamWithOptions(openOptions=1048576) + +``` +Note: In the example above, "1048576" corresponds to the integer value of enum *SPOpenBinaryOptions.GetAsZipWithAltStreamsIfAvailable*. + +## Step 3: Import the file with alternate content streams + +Use the Migration API to import the zip formatted stream for a file with alternate content streams to SPO. The main steps involved are: + + +1. Upload the zip formatted stream downloaded with *SPOpenBinaryOptions.GetAsZipWithAltStreamsIfAvailable* as the primary file to the Azure location. +2. When preparing the migration Manifest .xml file, add the property **vti_hasAlternateContentStreams** to the SPFile object with the value of **TRUE**. +3. Call the Migration API as normal. Internally, SPO will unzip the provided content stream and set the primary file stream and associated alternate content streams correctly. +4. After the import, verify the property **SPFile.HasAlternateContentStreams** to confirm if it’s set to **True**. + +***Example:*** + +```powershell + + + + + + + +``` diff --git a/docs/apis/migration-api-whats-new.md b/docs/apis/migration-api-whats-new.md new file mode 100644 index 000000000..aec43a338 --- /dev/null +++ b/docs/apis/migration-api-whats-new.md @@ -0,0 +1,73 @@ +--- +title: "Migration API What's new" +description: "Learn about the new features and updates to the Migration API." +ms.date: 09/26/2023 +ms.reviewer: jhendr +author: JoanneHendrickson +ms.author: jhendr +manager: serdars +audience: ITPro +ms.topic: article +ms.subservice: migration-tool +localization_priority: Priority +ms.custom: admindeeplinkSPO +--- +# What's new in the Migration API + +Check here to see what features or updates have been added to the Migration API. Here's a summary of what's included. + +## Encoding invalid XML characters + +When invalid XML characters are detected in relevant fields, they're encoded. For any attribute that is XML encoded, decoding is needed for the value. Encoded fields are included in `EncodedAttributes`, in a comma-separated attribute list. + +**Example** + +In this example, these attributes are encoded: URL, ParentWebURL, Name, and Version. + +```xml + +``` + +>[!Warning] +>If XSD is replied on to parse manifest files, parsing may fail when **EncodedAttributes** is used. + + +## Updated reason code and descriptions + +We have updated Migration API to provide detailed reasons in case a job is postponed. We encourage ISVs take appropriate actions, based on the reasons. + +|Possible reasons |Code|Description| +|:-----|:-----|:-----| +|JobInQueue:Resource|1，2，3，4, 5, 6, 12|The job is now in a queue for resource allocation. It is expected to start in [P75] time.| +|JobInQueue:DBMaint|7|The destination tenant's database is currently in maintenance. The job is in a queue to be executed when the maintenance is completed. We expect the maintenance to be completed at [P75] time.| +|JobFailure:TenantBlock|10|Migration is blocked at the destination tenant. The job is cancelled. Please check tenant status before resubmitting.| +|JobCancelled:Unknown|11|The migration job is canceled for unknown reason.| + + +## New: Speed up small file migration + +The migration package includes multiple files, which are each uploaded/downloaded individually. If you have a large number of small-sized files, migration speed drops dramatically. By using the new **ArchivedFiles.XML** file in your prime package you can transfer files in batch resulting in a faster migration. [Learn more about using the ArchivedFiles.XML](/sharepoint/dev/apis/migration-api-overview#archivedfilessxml) + +## SourceType field required + +Beginning April 1, 2023, the SourceType field is mandatory when calling the Migration API. Starting October 1st, 2022, a warning message will be sent if the field is missing. + +To learn more, including examples, see: **[SharePoint Import Migration API - ExportSettings.xml](/sharepoint/dev/apis/migration-api-overview#exportsettingsxml)** + +## Fixes + +- **Changes to how Import API handles users**. As a response to issues arising from broken OneDrive scenarios when importing duplicate users, the API now blocks and detect duplicate user entries in UserGroup.xml. For details see: [Entering user identifiers in UserGroup.xml](/sharepoint/dev/apis/migration-api-overview#entering-user-identifiers-in-usergroup.xml). diff --git a/docs/apis/migration-azure.md b/docs/apis/migration-azure.md new file mode 100644 index 000000000..3dddc87b8 --- /dev/null +++ b/docs/apis/migration-azure.md @@ -0,0 +1,149 @@ +--- +title: "Use Azure Blob Storage Containers and Azure Queues with SharePoint Migration API" +description: "This article provides in-depth information on how to use the SharePoint Migration API with Azure Containers and Queues." +ms.date: 07/03/2024 +ms.author: ranren +author: underreview +manager: dapodean +audience: ITPro +ms.subservice: migration-tool +ms.topic: article +ms.localizationpriority: high +ms.collection: + - SPMigration + - m365-collaboration +--- + +# Use Azure Blob Storage Containers and Azure Queues with SharePoint Migration API + +Use Azure Blob Storage Containers to store contents, manifest files, and logs. Access migration status updates with Azure Queues. + +This guide provides provisioning, permission, and other requirements with SharePoint-provided Azure resources. + +## Azure Blob Storage Containers + +Migration API uses Azure Blob Storage Containers for temporary storage of content and manifest. SharePoint provides default containers for migration. Alternatively, you can provide your own containers. + +### Using SharePoint-provided containers + +SharePoint-provided containers have no extra cost to the customer. Provision SharePoint-provided containers with `ProvisionMigrationContainers` method, without the need to manually set up in the Azure admin console. + +Migration API provisions the containers in the same datacenter of the SharePoint instance. Migration API uses a container exclusively once for each request, to ensure security. + +Migration API destroys Used containers 30-90 days after completing migration jobs. + +#### Avoid throttling by decorating the traffic + +Avoid throttling by [decorating your HTTP traffic](/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online#how-to-decorate-your-http-traffic). + +#### Encryption + +The contents stored in SharePoint-provided containers are encrypted at rest with AES256CBC algorithm. This practice is mandatory. Migration API rejects migration jobs generated from unencrypted SharePoint-provided containers. + +This encryption requirement doesn't apply to user-provided containers. + +When using `CreateMigrationJobEncrypted` method, encrypt each file with AES CBC 256 standard as the encryption algorithm. + +Use the `AesCryptoServiceProvider.GenerateIV` method to generate a unique cryptographically random IV for each file, including the manifests in the package. Store the IV as a property on each file. + +##### Name + +IV + +##### Value + +A `BASE64` encoded **Byte Array** of the generated IV + +#### ProvisionMigrationContainers method + +Provisions new SharePoint-provided migration containers for content and manifest. + +##### Syntax + +```csharp +public SPProvisionedMigrationContainersInfo ProvisionMigrationContainers() +``` + +##### Return values + +An `SPProvisionedMigrationContainersInfo` object, containing the URI, access tokens, and encryption key of the provisioned containers. + +###### DataContainerUri value + +A **Uri** value containing the URI of the newly created container for storing migration **content**, along with the SAS access token. + +Pass this value to `CreateMigrationJob` method as `azureContainerSourceUri` parameter. + +The SAS access token contains `Read` and `Write` permissions only. It doesn't contain `List`. + +SharePoint enforces HTTPS connections to containers by setting `spr=https` field in SAS tokens. + +###### MetadataContainer value + +A **Uri** value containing the URI of the newly created container for storing **manifest** files, along with the SAS access token. + +Pass this value to `CreateMigrationJob` method as `azureContainerManifestUri` parameter. + +The SAS access token contains `Read` and `Write` permissions only. It doesn't contain `List`. + +SharePoint enforces HTTPS connections to containers by setting `spr=https` field in SAS tokens. + +###### EncryptionKey + +A **Byte Array** value containing the AES256CBC encryption key for both containers provisioned. + +### Use your own containers + +You can also provide your own Azure Blob Storage Containers. Provide the URI with SAS access tokens as required in the Migration API reference. + +## Azure Queues + +SharePoint-provided Azure Queues have no extra cost to the customer. Provision the queue with `ProvisionMigrationQueue` method, without the need to manually set up in Azure admin console. + +Migration API provisions Azure Queues in the same datacenter of the SharePoint instance. + +Alternatively, use user-provided Azure Queues if desired. Check the requirement in the Migration API Reference document. + +### Azure Queue Encryption + +`CreateMigrationJobEncrypted` method encrypts the messages written to the Azure Queue. + +To decrypt the messages, make sure you preserve `JobId` and the `IV` values returned by `CreateMigrationJobEncrypted` method. + +#### Encrypted message sample + +```json +{"Label": "Encrypted"}, +{"JobId": "[JobId value]"}, +{"IV": "[IV value, encoded in BASE64]"}, +{"Content": "[encrypted message, encoded in BASE64]"} +``` + +### ProvisionMigrationQueue method + +Provisions a new instance of Azure Queue for migration use. + +#### ProvisionMigrationQueue Syntax + +```csharp +public SPProvisionedMigrationQueueInfo ProvisionMigrationQueue() +``` + +#### Return value + +A `SPProvisionedMigrationQueueInfo` object containing the information of the newly created Azure Queue. + +##### JobQueueUri value + +A `Uri` value containing the URI and SAS access token of the newly created Azure Queue. + +Pass this value to `CreateMigrationJob` method's `azureQueueReportUri` parameter. + +## Use endpoints in Azure Government + +Use Azure Government endpoints for Microsoft 365 Government. + +### Required endpoints in Azure Government + +- `https://*.blob.core.usgovcloudapi.net` +- `https://*.queue.core.usgovcloudapi.net` diff --git a/docs/apis/migration-content-package.md b/docs/apis/migration-content-package.md new file mode 100644 index 000000000..6de44cbfe --- /dev/null +++ b/docs/apis/migration-content-package.md @@ -0,0 +1,113 @@ +--- +title: "Preparing the content for Migration API" +description: "This article provides in-depth information on how to use create and use content packages with SharePoint Migration API" +ms.date: 04/18/2024 +ms.author: ranren +author: underreview +manager: dapodean +audience: ITPro +ms.subservice: migration-tool +ms.topic: article +ms.localizationpriority: high +ms.collection: + - SPMigration + - m365-collaboration +--- + +# Preparing the content for Migration API + +Use this document to prepare the contents to migrate with SharePoint Migration API. + +## Files and folders + +### File and package size limits + +Migration API supports importing files with sizes up to 15 GB (the limit set by SharePoint). + +For the best performance, keep the package size under 250 MB or 250 items. + +For larger files, create a package for the individual file. + +### File versions + +Migration API supports importing multiple versions of a file, including major and minor, up to the limit set by SharePoint. + +Each version of the file counts against the file size limit and item count limit. + +Include each version of the file, even if some of the versions already exist in SharePoint. + +### File overwriting + +Migration API deletes the original file along with all the versions, then replaces it with all versions of the resubmitted file, when a file is resubmitted. + +### No decryption + +Migration API doesn't decrypt contents. It treats any encrypted content as opaque files. While SharePoint lists these files, it doesn't index them. This behavior is the same as when a user uploads encrypted files through the SharePoint UI. + +### File compression + +Migration API doesn't decompress packages by default. Don't compress content and manifest packages together. Make sure you store the content package and the manifest package in different Azure Storage Blob Containers. + +Migration API imports **\*.zip** files as compressed archive files if referenced in the import package as the archive itself. To import the individual files within the **\*.zip** file, see [Archive Small Files](#archive-small-files-for-performance). + +### Archive small files for performance + +Migrate small files in batches for improved performance. Migration API **optionally** uncompresses a compressed **\*.zip** archive to improve the performance, based on manifest in **ArchivedFiles.xml**. + +Include `QuickXorHash` value of the archive when using this feature. Compute it with [QuickXorHash Algorithm](/onedrive/developer/code-snippets/quickxorhash). + +Migration API processes non-archived files in **Manifest.xml** without manifest in **ArchiveFiles.xml** as usual. + +This feature requires all the following prerequisites: + +#### Archive file size limit + +10 MB maximum. + +#### Archive file per package + +Two maximum. + +#### Archive file encryption + +Required. + +#### Individual file size + +Less than 100 kb after encryption. + +#### Don't compress individual files + +**Don't compress** the individual files, only compress the archive. + +## SharePoint Events and Event Handlers + +Migration API allows referencing Event Handlers on List Items. However, Migration API doesn't support defining new Event Handlers at the List level. + +Migration API doesn't generate Events when importing items. Therefore, existing Event Handlers don't fire during import. + +## Azure Containers + +### Azure Blob Storage Security Model + +Migration API uses Azure Blob Storage security model. There's no special treatment for Azure Blob Storage Containers used for Migration API that would differentiate from a standard container. + +### Snapshot + +Each file in the container must have at least one snapshot created. Avoid modifying the file during the import. Any file without a snapshot fails to import with errors. Migration API uses the latest snapshot of the file available at the time of import. + +To create a snapshot of a file after uploading to the Azure Blob Storage, use the following code: + +```csharp +CloudBlockBlob blob = blobContainerObj.GetBlockBlobReference(file); +blob.UploadFromStream(stm); +blob.CreateSnapshot(); +``` + +### Permissions + +To ensure the immutability of source blobs, Migration API accepts an SAS key with only `Read` and `List` access flags set for the content package container. + +Likewise, Migration API accepts a SAS key with only `Read`, `List`, and `Write` access for the Manifest container. Migration API requires the `Write` access for writing backlog files at the end of the import. + +Migration API checks SAS keys for these required access flags. Migration API rejects attempts to create migration jobs with incorrect access flags on SAS keys. diff --git a/docs/apis/migration-events.md b/docs/apis/migration-events.md new file mode 100644 index 000000000..dcd8c2209 --- /dev/null +++ b/docs/apis/migration-events.md @@ -0,0 +1,269 @@ +--- +title: "Migration events in Azure Queue" +description: "This article provides in-depth information on how to use Azure Queue events in migration." +ms.date: 04/18/2024 +ms.author: ranren +author: underreview +manager: dapodean +audience: ITPro +ms.subservice: migration-tool +ms.topic: article +ms.localizationpriority: high +ms.collection: + - SPMigration + - m365-collaboration +--- +# Migration events in Azure Queue + +This document lists all types of events Migration API and AMR API written to the Azure Queue. Use these events to get status updates on migration jobs. + +## JobQueued + +```log +JobId:845daca4-5529-4b0e-85ab-a603efee5b12 +Time:09/29/2020 19:56:02.883 +SiteId:48917234-de43-474a-9f1b-8d98ffa08425 +DbId:8fd09323-b23f-430d-8957-213586ce3861 +TotalRetryCount:0 +MigrationType:None +MigrationDirection:Import +CorrelationId:c8d97e9f-802f-0000-ceac-44663834d510 +``` + +## JobPostponed + +```log +JobId:845daca4-5529-4b0e-85ab-a603efee5b12 +Time:09/29/2020 19:56:57.598 +NextPickupTime:09/29/2020 20:16:57.519 +SiteId:48917234-de43-474a-9f1b-8d98ffa08425 +DbId:8fd09323-b23f-430d-8957-213586ce3861 +JobsInQueue:TotalRetryCount:0 +MigrationType:None +MigrationDirection:Import +CorrelationId:d5d97e9f-702c-0000-ceb9-354fefa5e9f6 +``` + +## JobLogFileCreate + +```log +JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecdTime:09/29/2020 19:56:29053 +FileName:Import-071f9aad-36e6-4bef-9f09-40b5c7498ecd-1.log +CorrelationId:22ca20ec-23de-468b-add3-4e52e90d3a68 +JobStart +JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecdTime:09/29/2020 19:56:29:100 +SiteId:48917234-de43-474a-9f1b-8d98ffa08425 +WebId:36b66979-4a43-4b93-9b92-909c7186ff98 +DBId:8fd09323-b23f-430d-8957-213586ce3861 +FarmId:211e600c-f48d-4319-ba92-61150c8e8e8c +ServerId:cfd27448-822a-420b-bcc8-4f39629b01bc +SubscriptionId:51812136-3cba-482d-9696-532cddceab31 +TotalRetryCount:0 +MigrationType:None +MigrationDirection:Import +CorrelationId:c308c0ea-a7f5-4be9-acd4-1ebd39867434 +``` + +## JobProgress + +```log +JobId:845daca4-5529-4b0e-85ab-a603efee5b12 +Time:09/29/2020 19:56:32.265 +FilesCreated:15 +BytesProcessed:45 +ObjectsProcessed:217 +TotalExpectedSPObjects:403 +TotalErrors:0 +TotalWarnings:0 +TotalRetryCount:0 +MigrationType:None +MigrationDirection:Import +WaitTimeOnSqlThrottlingMilliseconds:0 +TotalDurationInMs:0 +CpuDurationInMs:0 +SqlDurationInMs:0 +SqlQueryCount:0 +CreatedOrUpdatedFileStatsBySize: +{ + "0-1K": { + "Count": 15, + "TotalSize": 45, + "TotalDownloadTime": 251, + "TotalCreationTime": 6754 + } +} +ObjectsStatsByType: +{ + "SPUser": { + "Count": 1, + "TotalTime": 289, + "AccumulatedVersions": 0, + "ObjectsWithVersions": 0 + }, + "SPFolder": { + "Count": 2, + "TotalTime": 144, + "AccumulatedVersions": 0, + "ObjectsWithVersions": 0 + }, + "SPDocumentLibrary": { + "Count": 1, + "TotalTime": 173, + "AccumulatedVersions": 0, + "ObjectsWithVersions": 0 + }, + "SPFile": { + "Count": 200, + "TotalTime": 6765, + "AccumulatedVersions": 0, + "ObjectsWithVersions": 0 + }, + "SPListItem": { + "Count": 14, + "TotalTime": 2111, + "AccumulatedVersions": 0, + "ObjectsWithVersions": 0 + } +} +TotalExpectedBytes:0 +CorrelationId:ccd97e9f-a0cc-0000-ceb9-37a900bec68d +``` + +## JobEnd (Import) + +```json +{ +"Event": "JobEnd", +"JobId": "aed28dcc-efc3-46c3-89f2-b5df71ccfe85", +"Time": "04/11/2024 14:51:53.531", +"FilesCreated": "5", +"BytesProcessed": "260999", +"ObjectsProcessed": "6", +"TotalErrors": "2", +"TotalWarnings": "0", +"FilesCreatedIrrespectiveOfVersions": "1", +"BytesProcessedOnlyCurrentVersion": "111001" +} +``` + +### **FilesCreatedIrrespectiveOfVersions** property + +An integer. + +The number of files created, exclusive of file versions. If a file has multiple versions, this count increases by 1 only when all the versions are migrated. + +List items aren't counted in this property. + +### **BytesProcessedOnlyCurrentVersion** property + +An integer. The bytes are processed with the last version of the file. If a file has multiple versions, this byte count increases only when all the versions are migrated. + +List items aren't counted in this property. + +## JobEnd (AMR) + +AMR API generates `JobEnd` event with estimation of item counts in `TotalExpectedSPObjects` field: + +```log +Event:JobEnd +JobId:e915f93a-b377-476e-995c-952fd28c0a12 +Time:11/28/2023 13:41:06.109 +FilesCreated:182 +BytesProcessed:441084014 +ObjectsProcessed:425 +TotalExpectedSPObjects:425 +TotalErrors:2 +TotalWarnings:0 +TotalRetryCount:0 +MigrationType:AsyncRead +MigrationDirection:Export +``` + +## JobDeleted + +```log +JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecd +Time:09/29/2020 19:56:29.053 +CorrelationId:22ca20ec-23de-468b-add3-4e52e90d3a68 +``` + +### JobCancelled + +```log +JobId:071f9aad-36e6-4bef-9f09-40b5c7498ecd +Time:09/29/2020 19:58:29053 +TotalRetryCount:0 +CancelledByUser:false +MigrationType:None +MigrationDirection:Import +CorrelationId:22ca20ec-23de-468b-add3-4e52e90d3a68 +``` + +## JobError + +```log +JobId:b427d8d7-2b91-4da0-aee5-4b5a5a5d867e +Time: 02/05/2019 06:56:09.732 +TotalRetryCount:0 +MigrationType:None +MigrationDirection:Import +ObjectType:File +Url:Shared Documents/file.pdf +Id:fae7b4b0-2912-11e9-b0f3-7b554a52d6ab +ErrorCode:-2147024816 +ErrorType:Microsoft.SharePoint.SPException +Message:ErrorMessage +CorrelationId:d8e9bc9e-20e2-8000-aa83-48a62fc5ce75 +``` + +## JobFatalError + +```log +JobId:8f728c13-95d0-4d54-96bc-4ee912bd32ce +Time: 02/05/2019 06:57:20.523 +TotalRetryCount:0 +MigrationType:None +MigrationDirection:Import +ObjectType: +Url: +Id: +ErrorCode:-2147213196 +ErrorType:Microsoft.SharePoint.SPException +Message:ErrorMessage +CorrelationId:b370d5a0-105d-4000-241f-9b2d70449d7b +``` + +## JobWarning + +```log +JobId:b427d8d7-2b91-4da0-aee5-4b5a5a5d867e +Time: 02/05/2019 06:56:09.732 +TotalRetryCount:0 +MigrationType:None +MigrationDirection:Import +ObjectType:File +Url:Shared Documents/file.pdf +Id:fae7b4b0-2912-11e9-b0f3-7b554a52d6ab +ErrorCode:-2147024816 +ErrorType:Microsoft.SharePointSPException +Message:ErrorMessage +CorrelationId:d8e9bc9e-20e2-8000-aa83-48a62fc5ce75 +FinishManifestFileUpload +JobId:b427d8d7-2b91-4da0-aee5-4b5a5a5d867e +Time:02/05/2019 06:56:09.732 +ManifestFileName:Filename +CorrelationId:d8e9bc9e-20e2-8000-aa83-48a62fc5ce75 +``` + +## FinishManifestFileUpload + +Indicates that AMR API exported metadata. Find exported manifest files in the Azure Blob Storage Container supplied. The event also contains the location and file names of the exported files. + +### Example + +```json +{"Event", "FinishManifestFileUpload"}, +{"JobId", “f8d7d577-676e-47ce-ab69-ae7803979883”}, +{"Time", “2019-09-03T19:11:33.903”}, +{"ManifestFileName", “f8d7d577-676e-47ce-ab69-ae7803979883/ExportSettings.xml”} +``` diff --git a/docs/apis/migration-isv-guidance.md b/docs/apis/migration-isv-guidance.md index f0195aeb1..142300d3b 100644 --- a/docs/apis/migration-isv-guidance.md +++ b/docs/apis/migration-isv-guidance.md @@ -1,97 +1,99 @@ --- title: "Migration guide for ISVs" -ms.date: 02/04/2021 -ms.reviewer: +description: "Learn about using the SharePoint Migration API." +ms.date: 06/28/2021 ms.author: jhendr author: JoanneHendrickson manager: pamgreen audience: Dev ms.topic: article -ms.prod: sharepoint-server-itpro -localization_priority: Priority -ms.collection: -- SPMigration -- M365-collaboration +ms.subservice: migration-tool +ms.localizationpriority: high +ms.collection: + - SPMigration + - M365-collaboration search.appverid: MET150 -description: "Learn about using the SharePoint Migration API." --- # Migration guidance for ISVs -This document guides ISVs in delivering a fast and reliable migration experience to customers. It contains the latest Microsoft migration practices and concerns or questions raised by ISVs. +This document guides ISVs in delivering a fast and reliable migration experience to customers. It contains the latest Microsoft migration practices and concerns or questions raised by ISVs. ## Use app-based authentication -There are different usage patterns between end user traffic and an application doing background activities such as migration. It is important to identify user traffic versus application traffic. -To provide a stable platform and more reliable service, Microsoft is requesting that ISVs transition from using a user-based authentication to app-based authentication to provide greater reliability to our end users and partners. +There are different usage patterns between end user traffic and an application doing background activities such as migration. It is important to identify user traffic versus application traffic. -Migration is a background task application and should **not** be run in user mode. By transitioning to app-based authentication, you will benefit from the elastic capability of off-peak time to have more resources. +To provide a stable platform and more reliable service, Microsoft is requesting that ISVs transition from using a user-based authentication to app-based authentication to provide greater reliability to our end users and partners. -> [!Note] ->Microsoft will start enforcing the proper usage roles in Q1 2020. Vendors who continue to run migration in user roles can expect to experience increasing throttling and poor performance. +Migration is a background task application and should **not** be run in user mode. By transitioning to app-based authentication, you will benefit from the elastic capability of off-peak time to have more resources. + +> [!NOTE] +> Microsoft will start enforcing the proper usage roles in Q1 2020. Vendors who continue to run migration in user roles can expect to experience increasing throttling and poor performance. To learn more on how to register an app ID and how to implement app-based authentication see: -- [How to register an app ID](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdocs.microsoft.com%2Fen-us%2Fazure%2Factive-directory%2Fdevelop%2Factive-directory-v2-registration-portal&data=04%7C01%7CWan.Wu%40microsoft.com%7C7c98484b20de4fc80fb308d6da3e3509%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636936358039977299%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C-1&sdata=L%2BObRVyCBKPwvvY7MUUsWX%2B8yEIbzqaTkBjcmNjc1vk%3D&reserved=0) -- [Microsoft Graph Auth guidance](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdocs.microsoft.com%2Fen-us%2Fgraph%2Fauth%2F&data=04%7C01%7CWan.Wu%40microsoft.com%7C7c98484b20de4fc80fb308d6da3e3509%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636936358039977299%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C-1&sdata=ZrFqXsLT3BtT8ynnlLQH9w7JZIOw07zu2X3EYbBmfD4%3D&reserved=0): Includes an informative video, basics, how to register your app and getting access scenarios +- [How to register an app ID](/azure/active-directory/develop/active-directory-v2-registration-portal) +- [Microsoft Graph Auth guidance](/graph/auth): Includes an informative video, basics, how to register your app and getting access scenarios - [Don’t get throttled! SharePoint and OneDrive guide to staying below the limits](https://www.youtube.com/watch?v=_pBHfGGdMfE) ### App-based authentication migration guidance #### Permission settings + Azure Active Directory (AAD) provides two type of permission : delegated permission and application permissions. For official AAD guidance please see: -- [Permissions and consent in the Azure Active Directory v1.0 endpoint](https://docs.microsoft.com/azure/active-directory/develop/v1-permissions-and-consent). +- [Permissions and consent in the Azure Active Directory v1.0 endpoint](/azure/active-directory/develop/v1-permissions-and-consent). -For SharePoint and OneDrive migration scenarios, the guidance is to follow the AAD permission specification. +For SharePoint and OneDrive migration scenarios, the guidance is to follow the AAD permission specification. -For migration tool that relies on end user signed in and presence, delegated permission is recommended. +For migration tool that relies on end user signed in and presence, delegated permission is recommended. For service-based migration tool that run without a signed-in user present such as app that runs as background service, application permission is recommended. #### Number of App IDs -Questions have been raised by ISV on whether to have a single App ID covering all migration offering products or having multiple App ID per software offering. There is no specific guidance where the ISVs can identify all of their App IDs. Please contact Microsoft for any corner case scenarios. +Questions have been raised by ISV on whether to have a single App ID covering all migration offering products or having multiple App ID per software offering. There is no specific guidance where the ISVs can identify all of their App IDs. Please contact Microsoft for any corner case scenarios. ->[!Note] +> [!Note] > Please register all your migration app IDs with Microsoft to ensure that you receive adequate throughput for your migration jobs. +## Use the Migration API -## Use the Migration API For migration jobs, the first guidance is to use existing published migration APIs. ### Import API (CreateMigrationJob) -The *CreateMigrationJob* helps the ISVs to import to SharePoint and OneDrive faster and more reliably. +The *CreateMigrationJob* helps the ISVs to import to SharePoint and OneDrive faster and more reliably. -- [Create Migration Job (Import API)](https://docs.microsoft.com/sharepoint/dev/apis/migration-api-overview) +- [SharePoint Import Migration API (CreationMigrationJob)](migration-api-overview.md) The latest supported features are: -- [Migrate web parts using the Migration API](https://docs.microsoft.com/sharepoint/dev/apis/migrate-webparts-with-migrationapi) - +- [Migrating web parts using the Migration API](migrate-webparts-with-migrationapi.md) ### Export API (Asynchronous Metadata Read) A new migration API, Asynchronous Metadata Read API (Export API) is available to ISVs. The *AsynchronousMetadataRead* helps ISVs export content from SharePoint and OneDrive with fast and reduced calls. For example, the new API can export all the files and lists related metadata from the root level of document library in a single call. This reduces the number of calls needed, the chance of being throttled, and improves performance. -To learn more, see [Asynchronous Metadata Read (Export API)](https://docs.microsoft.com/sharepoint/dev/apis/export-amr-api) +To learn more, see [SharePoint Migration Export (Asynchronous Metadata Read) API](export-amr-api.md) -## Switch to the Microsoft Graph API -If a feature is not supported by the migration API, we recommend that you use the Graph API. If the Graph API does not support the needed migration feature, then use CSOM. However, using CSOM increases the likelihood of being throttled. +## Switch to the Microsoft Graph API -- [Graph Guidance: Best practices for discovering files and detecting changes at scale](https://docs.microsoft.com/onedrive/developer/rest-api/concepts/scan-guidance) +If a feature is not supported by the migration API, we recommend that you use the Graph API. If the Graph API does not support the needed migration feature, then use CSOM. However, using CSOM increases the likelihood of being throttled. + +- [Graph Guidance: Best practices for discovering files and detecting changes at scale](/onedrive/developer/rest-api/concepts/scan-guidance) ### CSOM Guidance (fallback only) The following provides guidance on specific CSOM implementation scenarios to help improve migration performance with SharePoint and OneDrive. -#### Enumeration Query Ordering guidance +#### Enumeration Query Ordering guidance + There are two kinds of enumeration queries, assuming the client intends to read every item with no server-side filtering. To query for every item in the list, recursively – in other words, the order does not depend on which folder(s) the items are contained in – the query should sort by ID. `` - + To query for every item in a specific folder, the query should sort by the filename, **FileLeafRef**. `` @@ -100,22 +102,20 @@ To query for every item in a specific folder, the query should sort by the filen You need to be aware of three key numbers as you plan your migration to OneDrive or SharePoint especially when you have a hierarchy of deeply nested folders. They are: (1) the number of SharePoint unique permission scopes, (2) the number of role assignments, and (3) the total number of items in a list or library. Read the full guidance: -- [Migration permission guidance](https://docs.microsoft.com/sharepoint/dev/apis/migration-perm-guidance) +- [Migration guidance for ISVs](migration-isv-guidance.md) +## For migrations over 100TB -## For migrations over 100TB +For customers migrating greater than 100TB of data, please follow the instructions on how to create a support ticket to help the product team to prepare the backend for the customers. -For customers migrating greater than 100TB of data, please follow the instructions on how to create a support ticket to help the product team to prepare the backend for the customers. +- [Best practices for improving SharePoint and OneDrive migration performance](/sharepointmigration/sharepoint-online-and-onedrive-migration-speed). -• [Best practices for improving SharePoint and OneDrive migration performance](https://docs.microsoft.com/sharepointmigration/sharepoint-online-and-onedrive-migration-speed). - ## Escalation and throttling - + The primary reason speed is impacted, and throttling occurs, is due to the load that gets generated by calling CSOM and REST APIs. As a result of this load, throttling rules fire that impact the speed, reliability and predictability of the migration. Throttling is used to protect the database and to ensure a good user experience for our customers. - + To read the official throttling guidance, see: - [Avoid getting throttled or blocked in SharePoint Online](https://aka.ms/spo429) -We continue to work to identify issues and improve the API. The asynchronous metadata read API is a direct result of ISV feedback. As an ISV/partner, we value your feedback. Please contact Microsoft if you have further questions. - +We continue to work to identify issues and improve the API. The asynchronous metadata read API is a direct result of ISV feedback. As an ISV/partner, we value your feedback. Please contact Microsoft if you have further questions. diff --git a/docs/apis/migration-job-progress-api-reference.md b/docs/apis/migration-job-progress-api-reference.md new file mode 100644 index 000000000..d6f6eff66 --- /dev/null +++ b/docs/apis/migration-job-progress-api-reference.md @@ -0,0 +1,171 @@ +--- +title: "SharePoint Migration Job Progress API" +description: "This article explains how to retrieve migration job status with GetMigrationJobProgress API." +ms.date: 06/15/2025 +ms.author: jihongzuo +author: shiongzuo +manager: dapodean +audience: ISV +ms.subservice: migration-tool +ms.topic: article +ms.localizationpriority: high +ms.collection: + - SPMigration + - m365-collaboration +--- +# SharePoint GetMigrationJobProgress API + +After submitting a migration job—whether an import job or an Asynchronous Metadata Read (AMR) job—you can use the GetMigrationJobProgress API to track its progress. The API is available via both SDK and REST interfaces. + +It returns a sequence of job status events, including: JobQueued, JobStart, JobProgress, JobError, and JobEnd. + +## Permissions + +Use application-based authentication when submitting a migration job. Ensure the application is granted the Sites.Read.All permission or higher. + +## GetMigrationJobProgress Method (SDK) + +### Syntax + +```csharp +public ClientResult Site.GetMigrationJobProgress( + Guid jobId, + String nextToken +) +``` + +### Method Parameters + +| Name | Type | Required | Description | +| :--------- | :------- | :------- | :----------------------------------------------------- | +| jobId | Guid | Yes | Unique identifier of the migration job | +| nextToken | String | Yes | Token for paging position. Use "0" for initial request | + +For a completed job, requests using nextToken are idempotent—repeating the same request will consistently return the same result. + +### Return Values + +| Name | Type | Description | +| :--------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------ | +| Logs | IList | Returns a collection of job status events when new progress is available, or an empty collection if there are no updates. | +| NextToken | String | Returns an updated string value when new progress is available, or the same value as the nextToken parameter if there are no updates. | + +### Method Usage Example + +```csharp +ClientResult result = context.Site.GetMigrationJobProgress(jobId, nextToken ?? "0"); +context.ExecuteQuery(); +IList logs = result.Value.Logs; +string newNextToken = result.Value.NextToken; +``` + +## GetMigrationJobProgress REST API + +### HTTP Request + +```http +GET https://{site_url}/_api/site/GetMigrationJobProgress(jobId='{jobId}',nextToken=0) +``` + +### URI Parameters + +| Name | Type | Required | Description | +| :--------- | :------- | :------- | :----------------------------------------------------- | +| jobId | Guid | Yes | Unique identifier of the migration job | +| nextToken | String | Yes | Token for paging position. Use "0" for initial request | + +### Request Headers + +| Header | Required | +| :------------------------------------- | :------- | +| Authorization: Bearer {token} | Yes | +| Accept: application/json;odata=verbose | Yes | + +### Response + +A JSON object when the HTTP status code is 200. + +An empty JSON object when the HTTP status code is other than 200. + +### Error Handling + +| Status Code | Meaning | Action | +| :---------- | :------------- | :---------------------------------------------------------------------- | +| 403 | Unauthorized | Ensure the app/user has at least Sites.Read.All permissions. | +| 429 | Too Many Requests | Parse Retry-After header and retry after the specified delay. | +| 500 | Internal Server Error | Parse error responses to identify internal errors. Do Not Retry. | +| 503 | Service Unavailable | Parse Retry-After header and retry after the specified delay. | + +| Internal Error Code | Meaning | +| :------------------ | :---------------------------------------------- | +| -2147213145 | Job not found | +| -2147213146 | Job status expired (valid for less than 5 days) | + +### API Usage Example + +#### Request Sample + +```http +GET https://contoso.sharepoint.com/_api/site/GetMigrationJobProgress(jobId=' 3e280efa-78a3-4ba1-bac6-e447aa538ca5', nextToken=0) +``` + +#### Successful Response Sample + +Status code: 200 +Response body: + +```json +{ + "d": { + "GetMigrationJobProgress": { + "Logs": { + "__metadata": { + "type": "Collection(Edm.String)" + }, + "results": [ + "{\"MigrationType\":\"None\",\"MigrationDirection\":\"Import\",\"SiteId\":\"48f1898f-77d9-4a1b-bddc-1f49bb6dc134\",\"DbId\":\"de6b85cd-726e-4b13-ae04-629798fddbf3\",\"TotalRetryCount\":\"0\",\"JobId\":\"3e280efa-78a3-4ba1-bac6-e447aa538ca5\",\"Time\":\"05/20/2025 09:18:48.132\",\"CorrelationId\":\"91884a0c-5ee8-4e1f-a23f-e4f7ec170182\",\"Event\":\"JobQueued\"}", + "{\"MigrationType\":\"None\",\"MigrationDirection\":\"Import\",\"SiteId\":\"48f1898f-77d9-4a1b-bddc-1f49bb6dc134\",\"WebId\":\"7206fc09-e4af-48b3-8730-ed7321396d7a\",\"DbId\":\"de6b85cd-726e-4b13-ae04-629798fddbf3\",\"FarmId\":\"f77d7b6c-ef43-4609-8fce-0e93142ce8a0\",\"ServerId\":\"44af885c-393b-4236-9417-bae7a9edc44e\",\"SubscriptionId\":\"82abb045-250e-4186-ba83-b9295930f272\",\"TotalRetryCount\":\"0\",\"JobId\":\"3e280efa-78a3-4ba1-bac6-e447aa538ca5\",\"Time\":\"05/20/2025 09:20:51.129\",\"CorrelationId\":\"7d3e7a8e-4445-4ce0-adb1-078e78cbf686\",\"Event\":\"JobStart\"}", + "{\"MigrationType\":\"None\",\"MigrationDirection\":\"Import\",\"TotalRetryCount\":\"0\",\"ObjectType\":\"ListItem\",\"Url\":\"\",\"Id\":\"cb471d5f-593f-4a63-b59e-8eae3e35b08a\",\"SourceListItemIntId\":\"3\",\"TargetListItemIntId\":\"3\",\"ErrorCode\":\"-2147286782\",\"ErrorType\":\"Microsoft.SharePoint.SPException\",\"Message\":\"Attempted to use an object that has ceased to exist. (Exception from HRESULT: 0x80030102 (STG_E_REVERTED)) \",\"JobId\":\"3e280efa-78a3-4ba1-bac6-e447aa538ca5\",\"Time\":\"05/20/2025 09:20:55.490\",\"CorrelationId\":\"7d3e7a8e-4445-4ce0-adb1-078e78cbf686\",\"Event\":\"JobError\"}", + "{\"MigrationType\":\"None\",\"MigrationDirection\":\"Import\",\"TotalRetryCount\":\"0\",\"FilesCreated\":\"0\",\"BytesProcessed\":\"0\",\"ObjectsProcessed\":\"4\",\"TotalExpectedSPObjects\":\"15\",\"TotalErrors\":\"3\",\"TotalWarnings\":\"0\",\"WaitTimeOnSqlThrottlingMilliseconds\":\"0\",\"TotalDurationInMs\":\"0\",\"CpuDurationInMs\":\"0\",\"SqlDurationInMs\":\"0\",\"SqlQueryCount\":\"0\",\"IsShallowCopy\":\"False\",\"CreatedOrUpdatedFileStatsBySize\":\"{}\",\"ObjectsStatsByType\":\"{\\\"SPUser\\\":{\\\"Count\\\":1,\\\"TotalTime\\\":124,\\\"AccumulatedVersions\\\":0,\\\"ObjectsWithVersions\\\":0},\\\"SPFolder\\\":{\\\"Count\\\":1,\\\"TotalTime\\\":153,\\\"AccumulatedVersions\\\":0,\\\"ObjectsWithVersions\\\":0},\\\"SPDocumentLibrary\\\":{\\\"Count\\\":1,\\\"TotalTime\\\":404,\\\"AccumulatedVersions\\\":0,\\\"ObjectsWithVersions\\\":0},\\\"SPFile\\\":{\\\"Count\\\":1,\\\"TotalTime\\\":0,\\\"AccumulatedVersions\\\":0,\\\"ObjectsWithVersions\\\":0},\\\"SPListItem\\\":{\\\"Count\\\":1,\\\"TotalTime\\\":1880,\\\"AccumulatedVersions\\\":0,\\\"ObjectsWithVersions\\\":0}}\",\"TotalExpectedBytes\":\"0\",\"FilesCreatedIrrespectiveOfVersions\":\"0\",\"BytesProcessedOnlyCurrentVersion\":\"0\",\"JobId\":\"3e280efa-78a3-4ba1-bac6-e447aa538ca5\",\"Time\":\"05/20/2025 09:20:57.380\",\"CorrelationId\":\"7d3e7a8e-4445-4ce0-adb1-078e78cbf686\",\"Event\":\"JobEnd\"}" + ] + }, + "NextToken": "1764", + "__metadata": { + "type": "SP.MigrationJobProgress" + } + } + } +} +``` + +#### Error Response Sample + +Status code: 500 +Response body: + +```json +{ + "error": { + "code": "-2147213145, Microsoft.SharePoint.SPException", + "innererror": { + "message": "Job not found", + "stacktrace": "STACK_TRACE" + }, + "message": { + "lang": "en-US", + "value": "Job not found" + } + } +} +``` + +## Best Practice + +Begin with `nextToken=0`, store the returned token, and poll at certain intervals. This method is well-suited for long-running jobs and helps ensure no updates are missed. + +Since migration jobs typically take several minutes or more, polling every minute is advised, while adhering to the [guideline](https://aka.ms/spo429) to avoid throttling. + +## See Also + +- [SharePoint Migration API](migration-api-overview.md) +- [Migration Events](migration-events.md) diff --git a/docs/apis/migration-manifest.md b/docs/apis/migration-manifest.md new file mode 100644 index 000000000..770fd670b --- /dev/null +++ b/docs/apis/migration-manifest.md @@ -0,0 +1,405 @@ +--- +title: "Preparing the manifest for Migration API" +description: "This article provides in-depth information on how to use create and use manifest packages with SharePoint Migration API" +ms.date: 04/18/2024 +ms.author: ranren +author: underreview +manager: dapodean +audience: ITPro +ms.subservice: migration-tool +ms.topic: article +ms.localizationpriority: high +ms.collection: + - SPMigration + - m365-collaboration +--- + +# XML manifest files + +Migration API relies on XML manifest files to process the content import correctly. Create manifest files in a well-defined format. AMR API also exports metadata in this format. + +## XML Validation + +The package structure for Manifest files is based on a constrained version of [SharePoint Content Migration Schemas](/sharepoint/dev/schema/content-migration-schemas). + +## Encoding invalid XML characters + +AMR API encodes invalid XML characters in fields. Decode the attributes listed in `EncodedAttributes`. + +Migration API doesn't support invalid XML character encoding. + +### Example + +In this example, these attributes are encoded: URL, ParentWebURL, Name, and Version. + +```xml + +``` + +## Location + +Placed all manifest files at the root level of the Azure Blob Storage Container for manifest files. + +## ArchivedFiles.xml + +Optional. + +Used to process archived small files in batch. + +### ArchivedFiles.xml Example + +```xml + + + + + + + + + + + + + + + + + + + +``` + +## ExportSettings.xml + +Required. + +An XML file contains the export settings specified with the `SPExportSettings` and other classes. It also specifies the export settings, used in the subsequent import process at the migration target site. It also maintains a catalog of all objects exported to the migration package. + +### Ignore Web Parts + +Migration API checks and processes SharePoint Web Parts in certain types of files. For sources other than SharePoint Server and SharePoint Online, bypass these checks by setting `IgnoreWebParts` to `true`. This practice improves the performance of migration tasks when not migrating Web Parts. + +### Specify content source + +Migration API requires a `SourceType` value, containing the source of the content. It should contain a value from the following list: + +#### Accepted `SourceType` values + +- `AmazonS3` +- `AzureStorage` +- `Box` +- `Dropbox` +- `Egnyte` +- `FileShare` +- `GoogleCloudStorage` +- `GoogleDrive` +- `MicrosoftStream` +- `OneDrive` +- `SharePointOnline` +- `SharePointOnPremServer` +- `Other` + +When declaring to `Other`, include an extra `DetailedSource` value to provide more detail on the content source information. + +### ExportSettings.xml Example + +```xml + + + + + +``` + +## LookupListMap.xml + +Optional. + +An XML manifest file that maintains a simple lookup list, which records all SharePoint List Item references. Place it at the root of the Azure Blob Store Container defined by the `CreateMigrationJob`’s `azureContainerManifestUri` parameter. + +Not required if the import package doesn't contain Defining Fields or Views on a List or Document Library. The omission of this file generates a warning message in the log. Include a file with a childless `root` node to avoid this warning message. + +## Manifest.xml + +Required. + +An XML manifest file that contains the complete list of both the contents and the structure of the content package. Migration API uses this manifest file to reconstitute the source and its components. + +Place all instances of the **Manifest.xml** file for a package at the root of the Azure Blob Store Container. + +This manifest file is also the primary descriptor for metadata within the package, and provides the List, Folder, and Item hierarchy, along with metadata for the items including references back to users and groups defined in **UserGroupMap.xml** file. + +Use more than one **Manifest.xml** if needed. The manifests are identified with different file names. Migration API locates all manifests through references in **SystemData.xml** file’s `ManifestFile` entries. + +### Document Library/List ID consistency + +Use consistent Web ID and Document Library ID/List ID at the source and the target location. Inconsistent Web IDs generate errors as Migration API can't find the parent web for the import operation. + +Likewise, Migration API can't import items with incorrect Document Library IDs and List IDs into the target Document Library or List. Don't reuse IDs within the same site collection, to avoid Migration API importing packages to the same target site collection, regardless of the destination web. + +### GUID consistency + +To avoid GUID conflicts and import errors, use the same package for the same target. Importing a new package with the same content will cause problems. The package from a file share assigns GUIDs to files, folders, and list items. Keep the package from the file share as a record of the original GUIDs. Use the same GUIDs for later packages to avoid conflicts and track changes. + +### Preserve content identifiers + +The identifiers in the Import Packages are **explicitly** used during import to identify content. This practice preserves existing identifiers for Document Library contents. + +Reference the target Web and List identifiers **explicitly**. + +Migration API preserves content type identifiers, file/folder item GUIDs, and List Item integer identifiers during import. Import fails when Migration API encounters incorrect identifiers in the package. + +This preservation enables successive import iterations with different packages, allowing items to move locations. + +### Permission Roles + +Manifest.xml contains the following Roles-related objects: + +#### Roles object + +Contains the list of all defined Roles on the Web. + +#### Role object + +Defines a Role with ID, internal permissions rights mask flags, and display information. + +##### RoleId value + +Defines the identifiers of the Role object. + +##### PermMask value + +Contains the rights mask flags. + +#### RoleAssignments object + +Contains the list of all unique permissions (RoleAssignment objects). + +#### RoleAssignment object + +Includes the list of distinct Assignment objects (if any). + +##### Assignment object + +Contains the actual membership of one distinct User or Group and their actual Role, where + +- RoleId values map to the RoleId values of the Role objects. +- PrincipalId values map to ID values of User or Group objects respectively in **UserGroups.xml**. + +#### Permissions Example + +```xml + + … + + + + + + + + + + + + + + … + + + … + +``` + +## Requirements.xml + +Optional. + +SharePoint Server usually generates this XML manifest file. It contains a list of deployment requirements in the form of installation requirements on the migration target, such as + +- feature definitions +- template versions +- Web Part assemblies +- language packs +- and so forth. + +Include no child node under the root for file shares. The omission of this file generates a warning message in the log. + +## RootObjectMap.xml + +Optional. + +Maintains a list of mappings of secondary (dependent) objects. Migration API uses this manifest file to correctly place dependent objects. + +The most common `RootObject` included is a single object of type List. The `ID` of this item should be the List `ID` of the target list, and the `ParentWebID` should match the `ID` of the parent target web containing this list in order for migration to be successful. The `ID`, `WebUrl`, and `Url` values of this object must also match the related structure laid out in the **Manifest.xml** file. + +## SystemData.xml + +Required. + +Contains various low-level system data. It also records the number and paths of **Manifest.xml** files in the manifest package, when there are multiple manifests. + +### Versions + +`SchemaVersion` references to the current `Build` and `DatabaseVersion` of the target farm, currently “15.0.0.0”. + +`SiteVersion` should match the target site collection `UIVersion`, currently `15`. + +### Multiple Manifests + +List all **Manifest.xml** files in the package in **SystemData.xml**, as `ManifestFile` entries. + +### Immutable SystemObjects + +List all `SystemObjects` defining dependent objects that remain immutable by Migration API. + +### SystemData.xml example + +This example **SystemData.xml** file shows the common objects from a file share import. Use different `ID`s for each package, and the `URL`s may be different. + +```xml + + + + + + + + + + + + + + +``` + +## UserGroupMap.xml + +Required. + +Records Users and User Security Groups for managing permissions. Migration API uses the manifest to ascertain the membership of Users and Groups, along with their roles and specific assignments. These assignments include unique permissions set at the level of the object and its offspring, unless a deeper child object overrides them. + +User or Group entries aren't mandatory, but omission prevents author or security information from the population during import. Migration API generates warnings in such cases. + +### User identifiers + +Identify a User only once in a single package. + +Manifest all Users and Groups within the exported Web(s). + +#### User object + +Includes the information about specific Users, including identification of a specific security principle as a domain group or not, sign-in, and the base64 encoded SystemId (SID) of the security principle. + +#### Group object + +Includes the information about specific Groups and the direct membership list of that Group. + +Owner values on Group objects and UserId values on member objects within group objects map to other ID values of other User or Group objects respectively. + +The following example shows how to manifest Users and Groups. + +```xml + + + + + … + + + + + + + + + + … + + +``` + +Make sure the Sign-in and SystemId values of users match the values in SharePoint. + +### Deleted Users + +Include an `IsDeleted` value as `true` for deleted accounts. This practice prevents lookup failures in the import process, which negatively impacts performance. + +### Unresolved User identifiers + +If Migration API is unable to resolve a User with the Sign-in information, and SystemId **is not** provided, Migration API replaces this User with `System Account` in the associated metadata (such as Author or Editor) in the package and generates a warning in the import logs: + +```text +Failed to ensure user 'user@contoso.com' +``` + +If Migration API is unable to resolve a User with the Sign-in while the SystemId **is** provided, Migration API creates a new deleted User with the provided Sign-in and SystemId. Migration API uses this User with associated metadata within the package. Migration API generates a warning in the import logs: + +```text +Failed to retrieve user 'user@contoso.com' attributes from the SiteUsers; falling back to passed in values +``` + +### Avoid non-UPN email addresses in User identifiers + +The `Login` attribute of the User identifier requires a UPN. **Do not use** non-UPN email addresses. Using non-UPN email addresses causes unexpected behavior in SharePoint Online. + +### Examples + +The following examples show the correct and incorrect ways of using the User identifiers. + +In this case, the user has the following identifiers: + +- UPN: +- Email: . + +#### Correct example + +This example manifests the User only once, with a UPN email address. + +```xml + +``` + +#### Incorrect example + +This example **incorrectly** uses a non-UPN email address and **incorrectly** includes more than one identifier for a single user. + +```xml + + +``` + +This example **incorrectly** uses a non-UPN email address. + +```xml + +``` + +## ViewFormsList.xml + +Optional. + +This XML manifest file maintains a list of Web Parts and tracks whether each is a view or form. + +This file is optional if the Import Package doesn't contain Web Parts. The omission of this file generates a warning message in the log. Alternatively, include a manifest file with a childless `root` node to avoid the warning message. diff --git a/docs/apis/migration-perm-guidance.md b/docs/apis/migration-perm-guidance.md index 1e934ccfa..f46fb025c 100644 --- a/docs/apis/migration-perm-guidance.md +++ b/docs/apis/migration-perm-guidance.md @@ -1,7 +1,8 @@ --- title: Migration permission guidance -ms.prod: sharepoint -ms.date: 02/01/2021 +description: "Migration permission guidance" +ms.date: 03/30/2023 +ms.subservice: migration-tool ms.author: jhendr author: JoanneHendrickson manager: serdars @@ -9,12 +10,11 @@ audience: ITPro f1.keywords: - NOCSH ms.topic: conceptual -localization_priority: Priority +ms.localizationpriority: high ms.collection: - SPMigration - M365-collaboration search.appverid: MET150 -description: "Migration permission guidance" --- # Migration permission guidance @@ -22,9 +22,9 @@ You need to be aware of three key numbers as you plan your migration to OneDrive ## Permissions: Inherited and unique -Inherited permissions are set as the default at the root site collection level and are applied to the other locations and objects within that site collection. Unique permissions are all other permissions that differ (or “break”) from what is set at the root. In SharePoint, you can set unique permissions all the way down to the item level. +Inherited permissions are set as the default at the root site collection level and are applied to the other locations and objects within that site collection. Unique permissions are all other permissions that differ (or "break") from what is set at the root. In SharePoint, you can set unique permissions all the way down to the item level. -Each time you break inheritance by granting access to a new user account or group at any level in a site, even on a single item, you are creating a new unique security “scope” ID. That scope is counted as a unique permission towards the total limit. A library (or list) cannot have greater than 50,000 unique security scopes. +Each time you break inheritance by granting access to a new user account or group at any level in a site, even on a single item, you create a new unique security "scope" ID. That scope is counted as a unique permission towards the total limit. A library (or list) can't have greater than 50,000 unique security scopes. ![Site hierarchy](../images/hierarchy-perms.png) @@ -33,22 +33,23 @@ When migrating, we recommend that you have less than 5,000 unique scopes per lib ## Role assignments -A role assignment is a mapping between a user, a SharePoint object (Web, list, file) and a role (Design, Full Control, Contribute, etc.). The role assignment ties together the role definition (permission level) with the specific user or group, and the scope that that permission level will be applied to (such as list, folder, item). +A role assignment is a mapping between a user, a SharePoint object (web, list, file) and a role (for example, Design, Full Control, or Contribute). The role assignment ties together the role definition (permission level) with the specific user or group, and the scope that that permission level will be applied to (such as list, folder, item). -There is a role assignment limit of 5,000 per security scope. +The maximum number of role assignments allowed per security scope is 5,000. ## Item limits -When a library (or list) contains more than 100,000 items (files and folders or list items), you cannot break permissions inheritance on the list itself. There is a limit of 100,000 items that can be updated or removed as a part of creating a new SharePoint security scope. +When a library (or list) contains more than 100,000 items (files and folders or list items), you can't break permissions inheritance on the list itself. There's a limit of 100,000 items that can be updated or removed as a part of creating a new SharePoint security scope. + +If you're migrating a structure that has more than 100,000 children (such as files, folders, lists, or other object types), you need to restructure the migration by importing security in multiple phases to avoid exceeding this limit. Any VROOM invite, REST share link, or any other permission-modifying function call will trigger an HTTP 429 throttle if the threshold is reached. Permissions won't be updated. Unlike other throttles, waiting and trying again won't resolve the situation as you've reached a hard limit of 100,000. -If you are migrating a structure that has more than 100,000 children (such as files, folders, lists, or other object types), you need to restructure the migration by importing security in multiple phases to avoid exceeding this limit. Any VROOM invite, REST share link, or any other permission-modifying function call will trigger an HTTP 429 throttle if the threshold is reached. Permissions will not be updated. Unlike other throttles, waiting and trying again will not resolve the situation as you have reached a hard limit of 100,000. -To learn more about the service limits in SharePoint for Microsoft 365, see [SharePoint Limits](https://docs.microsoft.com/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#items-in-lists-and-libraries). +To learn more about the service limits in SharePoint for Microsoft 365, see [SharePoint Limits](/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#items-in-lists-and-libraries). -## Folders containing fewer than 100,000 items +## Folders with less than 100,000 items -If your library (or list) has fewer than 100,000 items, and you have less than 50,000 unique scopes, you can migrate using the migration API and apply unique scopes to create folders with less 100K items to break inheritance as needed. +If your library (or list) has fewer than 100,000 items, and you have less than 50,000 unique scopes, you can migrate using the Migration API and apply unique scopes to create folders with fewer 100-K items to break inheritance as needed. -## Folders containing more than 100,000 items +## Folders with more than 100,000 items If you have a folder with more than 100,000 items, we recommend one of the following approaches. Determine how many items are in your source or root folder, including lists or other object types. Scan and determine which folder structures have greater than 100,000 items. @@ -56,30 +57,30 @@ If you have a folder with more than 100,000 items, we recommend one of the follo The first option is to restructure your *source* layout. -For example, divide a single folder of 250,000 items into four folders at the root so each folder has less than 100,000 items. There is still “room to grow”, presuming users will continue to add content and make changes here. +For example, divide a single folder of 250,000 items into four folders at the root so each folder has less than 100,000 items. There's still "room to grow", presuming users will continue to add content and make changes here. Make sure that there are no more than 50,000 unique scopes in the structure: ideally less than 5,000. -In this example, at the source, break up the structure into four folders, A, B, C, and D, each having less than 100,000 items. Then perform the migration. See the illustration below. +In this example, at the source, break up the structure into four folders, A, B, C, and D, each having less than 100,000 items. Then perform the migration. For details, see the following illustration. ![Hierarchy ABCD](../images/hierarchy-ABCD.png) ->[!NOTE] ->There are other limits that must be considered during migration. See [SharePoint Limits](https://docs.microsoft.com/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#items-in-lists-and-libraries) for details. +> [!NOTE] +> There are other limits that must be considered during migration. For details, see [SharePoint Limits](/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#items-in-lists-and-libraries). ### Method 2: Create your destination layout to avoid exceeding limits The alternate approach is to keep your source layout, applying unique scopes at the destination before migration. **Example:** Your source folder has 250,000 items within it. At your target location, create folders A, B, C, and D and apply the unique scopes and scope ID. This will break inheritance. Then proceed with your content migration. -If you do not want your end users to share items until migration is completed, use the Migration API to migrate the content & scopes, but set the scope to NULL to prevent any use. +If you don't want your end users to share items until migration is completed, use the Migration API to migrate the content and scopes, but set the scope to NULL to prevent any use. After all the content and incremental migrations are completed, apply the proper scope. After the incremental migration has completed, and only if you previously set the scope to NULL, you can reapply the unique scope for folders A, B, C, D separately. When you reapply the scope, evaluate your folder size starting at the lowest level of hierarchy. -## Other Sharing/Permission related considerations +## Other sharing/permission-related considerations -The REST share link or any other permission-modifying function will not take effect if you attempt to update the permission on a file that is checked out by a user. +The REST share link or any other permission-modifying function won't take effect if you attempt to update the permission on a file that is checked out by a user. Finally, if a SharePoint site or OneDrive location is being actively used during migration, the existing permissions applied on that site, user or document will be enforced. -**Example:** If you attempt to modify the permission on a site that only allows access to existing users already defined on the site, and the user you are trying to add to a file or folder does not already have permissions on the site itself, the permission call (e.g. VROOM Invite) will not be able to make the modification. +**Example:** If you attempt to modify the permission on a site that only allows access to existing users already defined on the site, and the user you're trying to add to a file or folder doesn't already have permissions on the site itself, the permission call (for example, VROOM Invite) won't be able to make the modification. diff --git a/docs/apis/onenote-migration-service.md b/docs/apis/onenote-migration-service.md index e063540f3..5b8f9b616 100644 --- a/docs/apis/onenote-migration-service.md +++ b/docs/apis/onenote-migration-service.md @@ -1,18 +1,18 @@ --- title: Migrating OneNote folders -ms.date: 12/05/2020 +description: "Migrating OneNote folders using the SPO OneNote converting service" +ms.date: 06/28/2022 ms.author: jhendr author: JoanneHendrickson manager: pamgreen audience: Dev ms.topic: article -ms.service: sharepoint-online -localization_priority: Priority +ms.subservice: migration-tool +ms.localizationpriority: high ms.collection: - SPMigration - M365-collaboration search.appverid: MET150 -description: "Migrating OneNote folders using the SPO OneNote converting service" --- # Migrating OneNote folders diff --git a/docs/apis/sharepoint-rest-graph.md b/docs/apis/sharepoint-rest-graph.md index 4f08a62a0..ac203275b 100644 --- a/docs/apis/sharepoint-rest-graph.md +++ b/docs/apis/sharepoint-rest-graph.md @@ -2,24 +2,22 @@ title: Operations using SharePoint REST v2 (Microsoft Graph) endpoints description: Perform basic create, read, update, and delete (CRUD) operations with the SharePoint v2 REST interface. ms.date: 12/05/2020 -ms.service: sharepoint-online -localization_priority: Priority +ms.localizationpriority: high --- - # SharePoint REST operations via the Microsoft Graph REST API -If you are looking for the legacy SharePoint REST API documentation, see [Complete basic operations using SharePoint REST endpoints](https://docs.microsoft.com/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints). +If you are looking for the legacy SharePoint REST API documentation, see [Complete basic operations using SharePoint REST endpoints](../sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints.md). For SharePoint Online, innovation using a REST API against SharePoint is driven via the Microsoft Graph REST API's. In scenarios where solutions already have access tokens available to access SharePoint content, it's possible to access the REST API natively within SharePoint instead of calling via the Microsoft Graph API. Below is a table outlining a set of the Microsoft Graph endpoints being backed by SharePoint Online. -|Graph URL| SharePoint URL| -|----|----| -|https://graph.microsoft.com/v1.0/sites| https://{tenant-name}.sharepoint.com/_api/v2.0/sites| -|https://graph.microsoft.com/v1.0/drives| https://{tenant-name}.sharepoint.com/_api/v2.0/drives| -|https://graph.microsoft.com/v1.0/drive| https://{tenant-name}.sharepoint.com/_api/v2.0/drive| -|https://graph.microsoft.com/v1.0/lists| https://{tenant-name}.sharepoint.com/_api/v2.0/lists| +| Graph URL | SharePoint URL | +| ----------------------------------------- | ------------------------------------------------------- | +| `https://graph.microsoft.com/v1.0/sites` | `https://{tenant-name}.sharepoint.com/_api/v2.0/sites` | +| `https://graph.microsoft.com/v1.0/drives` | `https://{tenant-name}.sharepoint.com/_api/v2.0/drives` | +| `https://graph.microsoft.com/v1.0/drive` | `https://{tenant-name}.sharepoint.com/_api/v2.0/drive` | +| `https://graph.microsoft.com/v1.0/lists` | `https://{tenant-name}.sharepoint.com/_api/v2.0/lists` | If your solution already uses other Microsoft Graph REST API's, it is recommended to call API's via the Microsoft Graph REST endpoints for easier code management. @@ -27,9 +25,4 @@ To figure out if a Microsoft Graph REST API call is backed by SharePoint Online ## See also -- [Microsoft Graph REST API v1.0 reference](https://docs.microsoft.com/graph/api/overview?view=graph-rest-1.0) - - - - - +- [Microsoft Graph REST API v1.0 reference](/graph/api/overview) diff --git a/docs/apis/site-creation-rest.md b/docs/apis/site-creation-rest.md index 1e1011b6a..530ad6137 100644 --- a/docs/apis/site-creation-rest.md +++ b/docs/apis/site-creation-rest.md @@ -1,9 +1,8 @@ --- title: Create Modern SharePoint Sites using REST description: Create and get the status of a new modern SharePoint site by using the REST interface. -ms.date: 03/30/2021 -ms.prod: sharepoint -localization_priority: Priority +ms.date: 12/07/2022 +ms.localizationpriority: high --- # Manage modern SharePoint sites using REST @@ -45,6 +44,7 @@ body: "Lcid": 1033, "ShareByEmailEnabled":false, "Classification":"Low Business Impact", + "SensitivityLabel": "", "Description":"Description", "WebTemplate":"SITEPAGEPUBLISHING#0", "SiteDesignId":"6142d2a0-63a5-4ba0-aede-d9fefca2c767", @@ -57,15 +57,17 @@ body: > [!IMPORTANT] > If you use an app-only context to create the site collection the **Owner property is required**. In other cases this is an optional property and if not present will default to the user calling the REST endpoint. +> [!NOTE] +> The "Classification" parameter only sets the value visible on the site, but doesn't apply the label on the site. Use the new parameter "SensitivityLabel" to actually apply the label on your site collection. -The site design id can be retrieved by using the [Get-SPOSiteDesign](/powershell/module/sharepoint-online/get-spositedesign) (Microsoft SharePoint Online Management Shell) or [Get-PnPSiteDesign](/powershell/module/sharepoint-pnp/get-pnpsitedesign) (PnP PowerShell) cmdlets. If you want to apply an out-of-the-box available site design, use the following values: +The site design id can be retrieved by using the [Get-SPOSiteDesign](/powershell/module/sharepoint-online/get-spositedesign) (Microsoft SharePoint Online Management Shell) or [Get-PnPSiteDesign](/sharepoint/dev/declarative-customization/site-design-pnppowershell) (PnP PowerShell) cmdlets. If you want to apply an out-of-the-box available site design, use the following values: -- Topic: `96c933ac-3698-44c7-9f4a-5fd17d71af9e` or null +- Standard communication: `96c933ac-3698-44c7-9f4a-5fd17d71af9e` or null - Showcase: `6142d2a0-63a5-4ba0-aede-d9fefca2c767` - Blank: `f6cc5403-0d63-442e-96c0-285923709ffc` > [!IMPORTANT] -> To apply your custom site designs as retrieved with [Get-SPOSiteDesign](/powershell/module/sharepoint-online/get-spositedesign) (Microsoft SharePoint Online Management Shell) or [Get-PnPSiteDesign](/powershell/module/sharepoint-pnp/get-pnpsitedesign) (PnP PowerShell) you will have to change the JSON as follows: +> To apply your custom site designs as retrieved with [Get-SPOSiteDesign](/powershell/module/sharepoint-online/get-spositedesign) (Microsoft SharePoint Online Management Shell) or [Get-PnPSiteDesign](/sharepoint/dev/declarative-customization/site-design-pnppowershell) (PnP PowerShell) you will have to change the JSON as follows: ```json ... "SiteDesignId":"00000000-0000-0000-0000-000000000000", @@ -98,7 +100,7 @@ accept: application/json;odata.metadata=none odata-version: 4.0 body: { - "SiteId":"d11e59ca-1465-424c-be90-c847ba849af5" + "siteId":"d11e59ca-1465-424c-be90-c847ba849af5" } ``` ### Response @@ -148,6 +150,7 @@ The full set of values for `SiteStatus` are as follows: + `1` - Provisioning. The site is currently being provisioned. + `2` - Ready. The site has been created. + `3` - Error. An error occurred while provisioning the site. ++ `4` - Site with requested URL already exist. ## See also diff --git a/docs/apis/sp-migration-api-and-sensitivity-labels.md b/docs/apis/sp-migration-api-and-sensitivity-labels.md index 8b1bc111b..c14fa0f53 100644 --- a/docs/apis/sp-migration-api-and-sensitivity-labels.md +++ b/docs/apis/sp-migration-api-and-sensitivity-labels.md @@ -1,35 +1,37 @@ --- title: "Sensitivity labels and the SharePoint Migration API" -ms.date: 02/01/2021 +description: Learn how to have sensitivity labels applied to content before migration with the SharePoint Migration API. +ms.date: 06/28/2022 ms.author: jhendr author: JoanneHendrickson manager: serdars search.appverid: MET150 -localization_priority: Priority -ms.prod: sharepoint -description: Learn how to have sensitivity labels applied to content before migration with the SharePiont Migration API. +ms.localizationpriority: high +ms.subservice: migration-tool --- - # Sensitivity Labels and the SharePoint Migration API -Sensitivity labels cannot be applied to files and folders using the SharePoint Migration API. If you want to have sensitivity labels applied to your content being migrated to Microsoft 365, we recommend using the Microsoft Information Protection (MIP) SDK. There currently isn't a parameter in the API to apply sensitivity labels to files. +Sensitivity labels cannot be applied to files and folders using the SharePoint Migration API. If you want to have sensitivity labels applied to your content being migrated to Microsoft 365, we recommend using the Microsoft Information Protection SDK. There currently isn't a parameter in the API to apply sensitivity labels to files. + +**Step 1:** + +Before you migrate your content with the Migration API, become familiar with how sensitivity labels work in Microsoft 365 and learn about the Microsoft Information Protection SDK: + +- [Enable sensitivity labels for Offices files in SharePoint and OneDrive](/microsoft-365/compliance/sensitivity-labels-sharepoint-onedrive-files) +- [Microsoft Information Protection SDK](/information-protection/develop/overview) -**Step 1:** -Before you migrate your content with the Migration API, become familiar with how sensitivity labels work in Microsoft 365 and learn about the Microsoft Information Protection (MIP) SDK: +**Step 2:** -- [Enable sensitivity labels for Offices files in SharePoint and OneDrive](https://docs.microsoft.com//microsoft-365/compliance/sensitivity-labels-sharepoint-onedrive-files) -- [Microsoft Information Protection SDK](https://docs.microsoft.com/information-protection/develop/overview) +Download and configure the Microsoft Information Protection SDK. The article listed here shows you how to set up and configure your Microsoft 365 subscription and client workstation, in preparation for using the SDK. -**Step 2:** -Download and configure the Microsoft Information Protection (MIP) SDK. The article listed here shows you how to set up and configure your Microsoft 365 subscription and client workstation, in preparation for using the SDK. +- [Microsoft Information Projection (MIP) SDK setup and configuration](/information-protection/develop/setup-configure-mip) -- [Microsoft Information Projection (MIP) SDK setup and configuration](https://docs.microsoft.com/information-protection/develop/setup-configure-mip) +**Step 3:** +Apply sensitivity labels using the MIP SDK. -**Step 3:** -Apply sensitivity labels using the MIP SDK. - -If you're currently using Azure Information Protection, you must migrate your labels to Office 365 Security and Compliance Center. For more information on the process, see [How to migrate Azure Information Protection labels to the Office 365 Security & Compliance Center](https://docs.microsoft.com/azure/information-protection/configure-policy-migrate-labels). +If you're currently using Azure Information Protection, you must migrate your labels to the Microsoft Purview compliance portal. For more information on the process, see [How to migrate Azure Information Protection labels to unified sensitivity labels](/azure/information-protection/configure-policy-migrate-labels). +**Step 4:** -**Step 4:** Migrate content using the [SharePoint Migration API](https://docs.microsoft.com/sharepoint/dev/apis/migration-api-overview) +Migrate content using the [SharePoint Import Migration API (CreationMigrationJob)](migration-api-overview.md) diff --git a/docs/apis/spod-copy-move-api.md b/docs/apis/spod-copy-move-api.md index 3482f27b5..202977581 100644 --- a/docs/apis/spod-copy-move-api.md +++ b/docs/apis/spod-copy-move-api.md @@ -1,32 +1,32 @@ --- title: Microsoft 365 Copy and Move API (CreateCopyJobs) -ms.date: 12/05/2020 +description: "Microsoft 365 Copy and Move API (CreateCopyJobs)" +ms.date: 10/05/2023 ms.author: jhendr author: JoanneHendrickson -manager: pamgreen +manager: serdars audience: ITPro f1.keywords: - NOCSH ms.topic: article -ms.service: sharepoint-online -localization_priority: Priority +ms.subservice: migration-tool +ms.localizationpriority: high ms.collection: - SPMigration - M365-collaboration search.appverid: MET150 -description: "Microsoft 365 Copy and Move API (CreateCopyJobs)" --- # Microsoft 365 Copy and Move API (CreateCopyJobs) ->[!IMPORTANT] ->SharePoint & OneDrive Copy and Move API replaces the CreateCopyJob API. The CreateCopyJob API has been deprecated. +> [!IMPORTANT] +> SharePoint & OneDrive Copy and Move API replaces the CreateCopyJob API. The CreateCopyJob API has been deprecated. The following API is based on the use of the SharePoint Client Side Object Model (CSOM). We recommend using [NuGet](https://www.nuget.org/) packages when you reference CSOM in your solution. You can find the latest version of the SharePoint Online CSOM package from the [NuGet library](https://www.nuget.org/) using the ID *Microsoft.SharePointOnline.CSOM*. ->[!IMPORTANT] ->Learn more about [limitations](#limitations) of this API before you begin. +> [!IMPORTANT] +> Learn more about [limitations](#limitations) of this API before you begin. ## Method @@ -53,8 +53,8 @@ public List CreateCopyJobs(Uri[] exportObjectUris, Uri dest public bool IsMoveMode { get; set; } ``` ->[!IMPORTANT] ->By default, this is set to copy. For a move operation, set this parameter to true. +> [!IMPORTANT] +> By default, this is set to copy. For a move operation, set this parameter to true. ```csharp public bool IgnoreVersionHistory { get; set; } @@ -110,8 +110,8 @@ public bool MoveButKeepSource { get; set; } Once set, this move operation is similar to copy. The file will move to destination, but the source content will not be deleted. If set, this will make a copy with the version history and preserve the original metadata. No source item deletions occurs at the end. ->[!NOTE] ->This is not like the normal copy, which only copies the most recent major version and doesn't maintain all the metadata. +> [!NOTE] +> This is not like the normal copy, which only copies the most recent major version and doesn't maintain all the metadata. ```csharp public bool ExcludeChildren { get; set; } @@ -121,12 +121,12 @@ For this operation, only the root level folder of the URL is copied. The sub-fol ### Output -|Output parameter|Description| -|:-----|:-----| -|JobID/GUID|Return a unique Job ID associated with this asynchronous read| -|SourceListItemUniqueIds|Return the source | -|JobQueueUri|URL for accessing Azure queue used for returning notification of copy and move process| -|EncryptionKey| AES256CBC encryption key used to decrypt messages from job/manifest queue| +| Output parameter | Description | +| :---------------------- | :------------------------------------------------------------------------------------- | +| JobID/GUID | Return a unique Job ID associated with this asynchronous read | +| SourceListItemUniqueIds | Return the source | +| JobQueueUri | URL for accessing Azure queue used for returning notification of copy and move process | +| EncryptionKey | AES256CBC encryption key used to decrypt messages from job/manifest queue | ```csharp public Uri JobQueueUri { get; set; } @@ -138,8 +138,8 @@ The reporting features are the same as they are for CreateMigrationJob. Logging Currently, the following limitations are: -|What|Limitation| -|:-----|:-----| -|File size| A file must be less than 2 GB.| -|Number of items| No more than 30,000 items in a job.| -|Total size of job| Job size not to exceed 100 GB.| +| What | Limitation | +| :---------------- | :---------------------------------- | +| File size | [SharePoint Limits](/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#moving-and-copying-across-sites) | +| Number of items | [SharePoint Limits](/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#moving-and-copying-across-sites) | +| Total size of job | [SharePoint Limits](/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#moving-and-copying-across-sites) | diff --git a/docs/apis/syntex/rest-applymodel-method.md b/docs/apis/syntex/rest-applymodel-method.md new file mode 100644 index 000000000..d366409ba --- /dev/null +++ b/docs/apis/syntex/rest-applymodel-method.md @@ -0,0 +1,140 @@ +--- +title: Batch apply model +description: Use REST API to apply a document understanding model to one or more libraries. +ms.date: 09/23/2022 +ms.author: chucked +author: chuckedmonson +manager: pamgreen +ms.reviewer: ssquires +audience: admin +ms.topic: reference +ms.collection: m365initiative-syntex +ms.localizationpriority: high +--- +# Batch Apply model + +Applies (or syncs) a trained document understanding model to one or more libraries (see [example](rest-applymodel-method.md#examples)). + +## HTTP request + +```HTTP +POST /_api/machinelearning/publications HTTP/1.1 +``` + +## URI parameters + +None + +## Request headers + +| Header | Value | +|--------|-------| +|Accept|application/json;odata=verbose| +|Content-Type|application/json;odata=verbose;charset=utf-8| +|x-requestdigest|The appropriate digest for current site.| + +## Request body + +| Name | Required | Type | Description | +|--------|-------|--------|------------| +|__metadata|yes|string|Set the object meta on the SPO. Always use the value: {"type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningPublicationsEntityData"}.| +|Publications|yes|MachineLearningPublicationEntityData[]|The collection of MachineLearningPublicationEntityData each of which specifies the model and target document library.| + +### MachineLearningPublicationEntityData + +| Name | Required | Type | Description | +|--------|-------|--------|------------| +|ModelUniqueId|yes|string|The unique ID of the model file.| +|TargetSiteUrl|yes|string|The full URL of the target library site.| +|TargetWebServerRelativeUrl|yes|string|The server relative URL of the web for the target library.| +|TargetLibraryServerRelativeUrl|yes|string|The server relative URL of the target library.| +|ViewOption|no|string|Specifies whether to set new model view as the library default.| + +## Response + +| Name | Type | Description| +|--------|-------|------------| +|201 Created||This is a customized API to support applying a model to multi document libraries. In the case of partial success, 201 created could still be returned and the caller needs to inspect the response body to understand if the model has been successfully applied to a document library.| + +## Response Body + +| Name | Type | Description| +|--------|-------|------------| +|TotalSuccesses|int|The total number of a model being successfully applied to a document library.| +|TotalFailures|int|The total number of a model failing to be applied to a document library.| +|Details|MachineLearningPublicationResult[]|The collection of MachineLearningPublicationResult each of which specifies the detailed result of applying the model to the document library.| + +### MachineLearningPublicationResult + +| Name | Type | Description| +|--------|-------|------------| +|StatusCode|int|The HTTP status code.| +|ErrorMessage|string|The error message which tells what's wrong when apply the model to the document library.| +|Publication|MachineLearningPublicationEntityData|It specifies the model info and the target document library.| + +### MachineLearningPublicationEntityData + +| Name | Type | Description | +|--------|--------|------------| +|ModelUniqueId|string|The unique ID of the model file.| +|TargetSiteUrl|string|The full URL of the target library site.| +|TargetWebServerRelativeUrl|string|The server relative URL of the web for the target library.| +|TargetLibraryServerRelativeUrl|string|The server relative URL of the target library.| + +## Examples + +### Apply a model to the contracts document library in the repository site + +In this sample, the ID of the Contoso Contract document understanding model is `7645e69d-21fb-4a24-a17a-9bdfa7cb63dc`. + +#### Sample request + +```HTTP +{ + "__metadata": { + "type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningPublicationsEntityData" + }, + "Publications": { + "results": [ + { + "ModelUniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc", + "TargetSiteUrl": "https://contoso.sharepoint.com/sites/repository/", + "TargetWebServerRelativeUrl": "/sites/repository", + "TargetLibraryServerRelativeUrl": "/sites/repository/contracts", + "ViewOption": "NewViewAsDefault" + } + ] + } +} +``` + + +#### Sample response + +In the response, TotalFailures and TotalSuccesses refers to the number of failures and successes of the model being applies to the specified libraries. + +**Status code:** 201 + +```JSON +{ + "Details": [ + { + "ErrorMessage": null, + "Publication": { + "ModelUniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc", + "TargetSiteUrl": "https://contoso.sharepoint.com/sites/repository/", + "TargetWebServerRelativeUrl": "/sites/repository", + "TargetLibraryServerRelativeUrl": "/sites/repository/contracts", + "ViewOption": "NewViewAsDefault" + }, + "StatusCode": 201 + } + ], + "TotalFailures": 0, + "TotalSuccesses": 1 +} +``` + +## See also + +[Syntex document understanding model REST API](syntex-model-rest-api.md) diff --git a/docs/apis/syntex/rest-batchdelete-method.md b/docs/apis/syntex/rest-batchdelete-method.md new file mode 100644 index 000000000..546a3ca51 --- /dev/null +++ b/docs/apis/syntex/rest-batchdelete-method.md @@ -0,0 +1,132 @@ +--- +title: BatchDelete +description: Use REST API to remove an applied document understanding model from one or more libraries. +ms.date: 09/23/2022 +ms.author: chucked +author: chuckedmonson +manager: pamgreen +ms.reviewer: ssquires +audience: admin +ms.topic: reference +ms.collection: m365initiative-syntex +ms.localizationpriority: high +--- + +# BatchDelete + +Removes an applied document understanding model from one or more libraries. Note that a model must be removed from all libraries before it can be deleted (see [example](rest-batchdelete-method.md#examples)). + +## HTTP request + +```HTTP +POST /_api/machinelearning/publications/batchdelete HTTP/1.1 +``` + +## URI parameters + +None + +## Request headers + +| Header | Value | +|--------|-------| +|Accept|application/json;odata=verbose| +|Content-Type|application/json;odata=verbose;charset=utf-8| +|x-requestdigest|The appropriate digest for current site.| + +## Request body + +| Name | Required | Type | Description | +|--------|-------|--------|------------| +|Publications|yes|MachineLearningPublicationEntityData[]|The collection of MachineLearningPublicationEntityData each of which specifies the model and target document library.| + +### MachineLearningPublicationEntityData + +| Name | Required | Type | Description | +|--------|-------|--------|------------| +|ModelUniqueId|yes|string|The unique ID of the model file.| +|TargetSiteUrl|yes|string|The full URL of the target library site.| +|TargetWebServerRelativeUrl|yes|string|The server relative URL of the web for the target library.| +|TargetLibraryServerRelativeUrl|yes|string|The server relative URL of the target library.| + +## Response + +| Name | Type | Description| +|--------|-------|------------| +|200 OK||This is a customized API to support removing a model from multi document libraries. In the case of partial success, 200 OK could still be returned and the caller needs to inspect the response body to understand if the model has been successfully removed from a document library.| + +## Response Body + +| Name | Type | Description| +|--------|-------|------------| +|TotalSuccesses|int|The total number of a model being successfully removed from a document library.| +|TotalFailures|int|The total number of a model failing to be removed from a document library.| +|Details|MachineLearningPublicationResult[]|The collection of MachineLearningPublicationResult each of which specifies the detailed result of removing the model from a document library.| + +### MachineLearningPublicationResult + +| Name | Type | Description| +|--------|-------|------------| +|StatusCode|int|The HTTP status code.| +|ErrorMessage|string|The error message which tells what's wrong when apply the model to the document library.| +|Publication|MachineLearningPublicationEntityData|It specifies the model info and the target document library.| + +### MachineLearningPublicationEntityData + +| Name | Type | Description | +|--------|--------|------------| +|ModelUniqueId|string|The unique ID of the model file.| +|TargetSiteUrl|string|The full URL of the target library site.| +|TargetWebServerRelativeUrl|string|The server relative URL of the web for the target library.| +|TargetLibraryServerRelativeUrl|string|The server relative URL of the target library.| + +## Examples + +### Remove a model from the contracts document library in the repository site + +In this sample, the ID of the Contoso Contract document understanding model is `7645e69d-21fb-4a24-a17a-9bdfa7cb63dc`. + +#### Sample request + +```HTTP +{ + "publications": [ + { + "ModelUniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc", + "TargetSiteUrl": "https://constco.sharepoint-df.com/sites/docsite", + "TargetWebServerRelativeUrl": "/sites/docsite ", + "TargetLibraryServerRelativeUrl": "/sites/dcocsite/joedcos" + } + ] +} +``` + +#### Sample response + +In the response, TotalFailures and TotalSuccesses refer to the number of failures and successes of the model being removed from the specified libraries. + +**Status code:** 200 + +```JSON +{ + "Details": [ + { + "ErrorMessage": null, + "Publication": { + "ModelUniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc", + "TargetSiteUrl": "https://contoso.sharepoint.com/sites/repository/", + "TargetWebServerRelativeUrl": "/sites/repository", + "TargetLibraryServerRelativeUrl": "/sites/repository/contracts", + "ViewOption": "NewViewAsDefault" + }, + "StatusCode": 200 + } + ], + "TotalFailures": 0, + "TotalSuccesses": 1 +} +``` + +## See also + +[Syntex document understanding model REST API](syntex-model-rest-api.md) diff --git a/docs/apis/syntex/rest-createclassificationrequest.md b/docs/apis/syntex/rest-createclassificationrequest.md new file mode 100644 index 000000000..c4321f606 --- /dev/null +++ b/docs/apis/syntex/rest-createclassificationrequest.md @@ -0,0 +1,93 @@ +--- +title: Create file classification request +description: Use REST API to create a request to classify one or more files using a trained document understanding model. +ms.date: 09/23/2022 +ms.author: chucked +author: chuckedmonson +manager: pamgreen +ms.reviewer: ssquires +audience: admin +ms.topic: reference +ms.collection: m365initiative-syntex +ms.localizationpriority: high +--- + +# Create file classification request + +Creates a request to classify one or more files using the applied document understanding model. (For more information, see [example](rest-createclassificationrequest.md#examples).) + +The REST service of SharePoint Online (and SharePoint 2016 and later on-premises) supports the combining of multiple requests. Requests are combined into a single call to the service by using the OData $batch query option. This method can be used to enqueue classification work items for hundreds of documents at one time. + +## HTTP request + +```http +POST /_api/machinelearning/workItems HTTP/1.1 +``` + +## URI Parameters + +None + +## Request headers + +| Header | Value | +|--------|-------| +|Accept|application/json;odata=verbose| +|Content-Type|application/json;odata=verbose;charset=utf-8| +|x-requestdigest|The appropriate digest for current site| + +## Request body + +|Name |Type |Description | +|--------|-------|------------| +|_metadata|string |Set the object meta on the SPO. Always use the value: {"type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningWorkItemEntityData"}. | +|TargetSiteId|guid|The ID of the site where the file to classify is located. This can be omitted when TargetSiteUrl has a value. | +|TargetSiteUrl|string|The full URL of the site where the file to classify is located. This can be omitted when TargeSiteId has a value.| +|TargetWebId|guid|The ID of the web where the file to classify is located. This can be omitted when TargetWebServerRelativeUrl has a value. | +|TargetWebServerRelativeUrl|string|The server relative URL of the web where the file to classify is located. This can be omitted when TargetWebId has a value. | +|TargetUniqueId|guid|The ID of the folder to classify. This can be omitted when TargetServerRelativeUrl has a value. | +|TargetServerRelativeUrl|string|The server relative URL of the file to classify is located. This can be omitted when TargetUniqueId has a value.| + +## Responses + +| Name | Type | Description| +|--------|-------|------------| +|201 Created| |The response is customized. In there is failure, it could still return 201 Created. The caller should further check the response body to determine the exact result.| + +## Examples + +### Enqueue a request to classify a file of ID "e6cff8b7-c90c-4564-b5b8-033449090932" + +#### Sample request + +```JSON +{ + "__metadata": { + "type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningWorkItemEntityData" + }, + "TargetSiteId": "f686e63b-aba7-48e5-97c7-68c4c1df292f", + "TargetWebId": "66d6b64d-6f88-4dd9-b3db-47e6f00c53e8", + "TargetUniqueId": "e6cff8b7-c90c-4564-b5b8-033449090932" +} +``` + +#### Sample response + +**Status code:** 201 +```JSON +{ + "ErrorMessage": null, + "StatusCode": 201 +} +``` + +```JSON +{ + "ErrorMessage": null, + "StatusCode": 201 +} +``` + +## See also + +[Syntex document understanding model REST API](syntex-model-rest-api.md) diff --git a/docs/apis/syntex/rest-createfolderclassificationrequest.md b/docs/apis/syntex/rest-createfolderclassificationrequest.md new file mode 100644 index 000000000..4e6a04e17 --- /dev/null +++ b/docs/apis/syntex/rest-createfolderclassificationrequest.md @@ -0,0 +1,97 @@ +--- +title: Create folder classification request +description: Use REST API to create a request to classify an entire folder using a trained document understanding model. +ms.date: 09/23/2022 +ms.author: chucked +author: chuckedmonson +manager: pamgreen +ms.reviewer: ssquires +audience: admin +ms.topic: reference +ms.collection: m365initiative-syntex +ms.localizationpriority: high +--- + +# Create folder classification request + +Creates a request to classify a whole folder during off-peak hours by using the applied document understanding model. (For more information, see [example](rest-createfolderclassificationrequest.md#examples).) +This API can be used to classify a whole document library by creating a work item for its root folder. + +## HTTP request + +```http +POST /_api/machinelearning/workItems HTTP/1.1 +``` + +## URI Parameters + +None + +## Request headers + +| Header | Value | +|--------|-------| +|Accept|application/json;odata=verbose| +|Content-Type|application/json;odata=verbose;charset=utf-8| +|x-requestdigest|The appropriate digest for current site| + +## Request body + +|Name |Type |Description | +|--------|-------|------------| +|_metadata|string |Set the object meta on the SPO. Always use the value: {"type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningWorkItemEntityData"}. | +|TargetSiteId|guid|The ID of the site where the folder to classify is located. This can be omitted when TargetSiteUrl has a value. | +|TargetSiteUrl|string|The full URL of the site where the folder to classify is located. This can be omitted when TargeSiteId has a value.| +|TargetWebId|guid|The ID of the web where the folder to classify is located. This can be omitted when TargetWebServerRelativeUrl has a value. | +|TargetWebServerRelativeUrl|string|The server relative URL of the web where the folder to classify is located. This can be omitted when TargetWebId has a value. | +|TargetUniqueId|guid|The ID of the folder to classify. This can be omitted when TargetServerRelativeUrl has a value. | +|TargetServerRelativeUrl|string|The server relative URL of the folder to classify is located. This can be omitted when TargetUniqueId has a value.| +|IsFolder|boolean|The flag that indicates if what will be classified is a folder. Always set this to true for creating a folder classification work item. | + + +## Responses + +| Name | Type | Description| +|--------|-------|------------| +|201 Created| |The response is customized. If there is failure, it could still return 201 Created. The caller should further check the response body to determine the exact result.| + +## Response body + +| Name | Type | Description| +|--------|-------|------------| +|StatusCode |int |The HTTP status code. If it’s not 200 or 201, the API should have failed.| +|ErrorMessage |string |The error message that tells what's wrong when apply the model to the document library.| + +## Examples + +### Enqueue a request to classify a whole folder of ID "e6cff8b7-c90c-4564-b5b8-033449090932" + + +#### Sample request + +```JSON +{ + "__metadata": { + "type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningWorkItemEntityData" + }, + "TargetSiteId": "f686e63b-aba7-48e5-97c7-68c4c1df292f", + "TargetWebId": "66d6b64d-6f88-4dd9-b3db-47e6f00c53e8", + "TargetUniqueId": "e6cff8b7-c90c-4564-b5b8-033449090932", + "IsFolder": true +} +``` + +#### Sample response + +**Status code:** 201 + +```JSON +{ + "ErrorMessage": null, + "StatusCode": 201 +} +``` + +## See also + +[Syntex document understanding model REST API](syntex-model-rest-api.md) diff --git a/docs/apis/syntex/rest-createmodel-method.md b/docs/apis/syntex/rest-createmodel-method.md new file mode 100644 index 000000000..7bdc5f0c8 --- /dev/null +++ b/docs/apis/syntex/rest-createmodel-method.md @@ -0,0 +1,72 @@ +--- +title: Create model +description: Use REST API to create a model and its associated content type. +ms.date: 09/23/2022 +ms.author: chucked +author: chuckedmonson +manager: pamgreen +ms.reviewer: ssquires +audience: admin +ms.topic: reference +ms.collection: m365initiative-syntex +ms.localizationpriority: high +--- + +# Create model + +Creates a model and its associated content type. Note that this only creates the model. It will still need to be trained in the content center (see [example](rest-createmodel-method.md#examples)). + +## HTTP request + +```http +POST /_api/machinelearning/models HTTP/1.1 +``` +## URI Parameters + +None + +## Request headers + +| Header | Value | +|--------|-------| +|Accept|application/json;odata=verbose| +|Content-Type|application/json;odata=verbose;charset=utf-8| +|x-requestdigest|The appropriate digest for current site| + +## Request body + +|Name |Type |Description | +|--------|-------|------------| +|_metadata| |Set the object meta on the SPO. Always use the value: {"type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningModelEntityData"}. | +|ContentTypeGroup|string|The associated content type group associated with the model. Defaulted to "Intelligent Document Content Types".| +|ContentTypeName|string|The associated content type name. The created model file will have the same name.| + +## Responses + +| Name | Type | Description| +|--------|-------|------------| +|201 Created| |Success| + +## Examples + +### Create a new document understanding model called "Contoso Contract" + +#### Sample request + +```json +{ + "__metadata": { + "type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningModelEntityData" + }, + "ContentTypeGroup": "Intelligent Document Content Types", + "ContentTypeName": "Contoso Contract" +} +``` + +#### Sample response + +**Status code:** 201 + +## See also + +[Syntex document understanding model REST API](syntex-model-rest-api.md) diff --git a/docs/apis/syntex/rest-getbytitle-method.md b/docs/apis/syntex/rest-getbytitle-method.md new file mode 100644 index 000000000..eb185e33c --- /dev/null +++ b/docs/apis/syntex/rest-getbytitle-method.md @@ -0,0 +1,111 @@ +--- +title: GetByTitle +description: Use REST API to get or update information about a Microsoft Syntex document understanding model using the model title. +ms.date: 09/23/2022 +ms.author: chucked +author: chuckedmonson +manager: pamgreen +ms.reviewer: ssquires +audience: admin +ms.topic: article +ms.collection: m365initiative-syntex +ms.localizationpriority: high +--- + +# GetByTitle + +Gets or updates information about a Microsoft Syntex document understanding model using the model title (see [example](rest-getbytitle-method.md#examples)). + +## HTTP request + +```HTTP +GET /_api/machinelearning/models/getbytitle('{modelFileName}') HTTP/1.1 +``` + +This same method can be used for deleting a model, too. + +```HTTP +DELETE /_api/machinelearning/models/getbytitle('{modelFileName}') HTTP/1.1 +``` + +## URI parameters + +|Name |In |Required|Type|Description| +|-----|---|--------|----|-----------| +|modelFileName|query|True|string|Name of the Syntex model file.| + +## Request headers + +| Header | Value | +|--------|-------| +|Accept|application/json;odata=verbose| + +## Request body + +For GET, no request body is needed. + +## Responses + +| Name | Type | Description| +|--------|-------|------------| +|200 OK| |Success| + +## Examples + +### Get information about the Contoso Contract model + +In this sample, the name of the Syntex document understanding model is `Contoso Contract`. + +#### Sample request + +```HTTP +GET /_api/machinelearning/models/getbytitle('Contoso Contract') HTTP/1.1 +``` + +#### Sample response + +**Status code:** 200 + +```HTTP +{ + "@odata.context": "https://contoso.sharepoint.com/sites/filerepository/_api/$metadata#models/$entity", + "@odata.type": "#Microsoft.Office.Server.ContentCenter.SPMachineLearningModel", + "@odata.id": "https://contoso.sharepoint.com/sites/filerepository/_api/machinelearning/models/getbyuniqueId('7645e69d-21fb-4a24-a17a-9bdfa7cb63dc')", + "@odata.etag": "\"7645e69d-21fb-4a24-a17a-9bdfa7cb63dc,111\"", + "@odata.editLink": " https://contoso.sharepoint.com/sites/filerepository /_api/machinelearning/models/getbyuniqueId('7645e69d-21fb-4a24-a17a-9bdfa7cb63dc')", + "ConfidenceScore": "{\"trainingStatus\":{\"kind\":\"original\",\"ClassifierStatus\":{\"TrainingStatus\":\"success\",\"TimeStamp\":1611716640535},\"ExtractorsStatus\":[{\"TimeStamp\":1585175746775,\"ExtractorName\":\"Contract Name\",\"TrainingStatus\":\"success\"},{\"TimeStamp\":1586905975794,\"ExtractorName\":\"Client \",\"TrainingStatus\":\"success\"},{\"TimeStamp\":1586906061099,\"ExtractorName\":\"Contract Date\",\"TrainingStatus\":\"success\"},{\"TimeStamp\":1586907912388,\"ExtractorName\":\"Fee\",\"TrainingStatus\":\"success\"},{\"TimeStamp\":1611716640115,\"ExtractorName\":\"ServiceType\",\"TrainingStatus\":\"success\"}]},\"modelAccuracy\":{\"Classifier\":1,\"Extractors\":{\"Contract Name\":1,\"Client \":1,\"Contract Date\":1,\"Fee\":1,\"ServiceType\":1}},\"perSampleAccuracy\":{\"133\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"249\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"252\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"253\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"254\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"255\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"256\":{\"Extractors\":{\"ServiceType\":1}},\"257\":{\"Extractors\":{\"ServiceType\":1}}},\"perSamplePrediction\":{\"133\":{\"Extractors\":{\"ServiceType\":[]}},\"249\":{\"Extractors\":{\"ServiceType\":[\"Writing\"]}},\"252\":{\"Extractors\":{\"ServiceType\":[\"Catering\"]}},\"253\":{\"Extractors\":{\"ServiceType\":[\"Design\"]}},\"254\":{\"Extractors\":{\"ServiceType\":[\"Marketing\"]}},\"255\":{\"Extractors\":{\"ServiceType\":[\"Financial Planning\"]}},\"256\":{\"Extractors\":{\"ServiceType\":[\"Writing\"]}},\"257\":{\"Extractors\":{\"ServiceType\":[\"Writing\"]}}},\"trainingFailures\":{}}", + "ContentTypeGroup": "Intelligent Document Content Types", + "ContentTypeId": "0x01010083DF84D4F59BBD4CB06F075AA81F58AA", + "ContentTypeName": "Contoso Contract", + "Created": "2020-03-25T22:04:04Z", + "CreatedBy": "i:0#.f|membership|meganb@contoso.com", + "DriveId": "b!O-aG9qer5UiXx2jEwd8pL0221maIb9lNs9tH5vAMU-h2NuHxlYUiTJyiwKQHZobK", + "Explanations": "{\"Classifier\":[{\"id\":\"8122ac1d-8fcb-4705-8872-2825cbf05bfe\",\"kind\":\"dictionaryFeature\",\"name\":\"agreement\",\"active\":true,\"nGrams\":[\"CONSULTING AGREEMENT\",\"SERVICES AGREEMENT\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"af83bea8-bc53-4e93-a3da-f1e697eb6bef\",\"kind\":\"modelFeature\",\"name\":\"Contract Name\",\"active\":true,\"modelReference\":\"Contract Name\",\"conceptId\":\"841d0dcf-7f1d-4a39-931c-53923d10c346\"},{\"id\":\"e3734994-9e34-40e3-82c7-bb6c7bc5a0c3\",\"kind\":\"modelFeature\",\"name\":\"Client \",\"active\":true,\"modelReference\":\"Client \",\"conceptId\":\"8b8490d0-9a09-4c16-bcff-59ce62e05c28\"},{\"id\":\"7c93e7fe-cbfb-47ee-8cca-46ecdf5f628f\",\"kind\":\"modelFeature\",\"name\":\"Contract Date\",\"active\":true,\"modelReference\":\"Contract Date\",\"conceptId\":\"6ba58918-e2f0-4685-9080-98ec4c3adc7c\"},{\"id\":\"5cc85b62-148a-4b07-9155-d9fb7cebb6d0\",\"kind\":\"modelFeature\",\"name\":\"Fee\",\"active\":true,\"modelReference\":\"Fee\",\"conceptId\":\"9c7f764d-afd2-49cd-aaa2-e9407156bfb3\"},{\"id\":\"0f8a23a6-c744-4cae-82bd-d836332ceb56\",\"kind\":\"modelFeature\",\"name\":\"ServiceType\",\"active\":true,\"modelReference\":\"ServiceType\",\"conceptId\":\"4aa9f2fe-cfab-49f8-86b1-11646c79cdbf\"}],\"Extractors\":{\"Contract Name\":[{\"id\":\"8804fbeb-bcf8-44c0-8ade-3fc65496037f\",\"kind\":\"dictionaryFeature\",\"name\":\"before\",\"active\":true,\"nGrams\":[\"- AND -\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false}],\"Client \":[{\"id\":\"606c56de-9e71-42ef-8ec6-f0bbf351d673\",\"kind\":\"dictionaryFeature\",\"name\":\"start\",\"active\":true,\"nGrams\":[\"BETWEEN:\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"334e6df5-e076-40db-a47b-f11ceec7af9a\",\"kind\":\"dictionaryFeature\",\"name\":\"after\",\"active\":true,\"nGrams\":[\"of\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"bccefd2e-88a4-406c-aa9d-81d508bbafb3\",\"kind\":\"proximityFeature\",\"name\":\"prox\",\"active\":true,\"patterns\":[[{\"id\":\"606c56de-9e71-42ef-8ec6-f0bbf351d673\",\"kind\":\"proximityFeatureReference\"},{\"kind\":\"proximityTokenRange\",\"minCount\":1,\"maxCount\":6},{\"id\":\"334e6df5-e076-40db-a47b-f11ceec7af9a\",\"kind\":\"proximityFeatureReference\"}]]}],\"Contract Date\":[{\"id\":\"fabe1ed3-07af-4dc6-852d-fe9521c64801\",\"kind\":\"dictionaryFeature\",\"name\":\"dated\",\"active\":true,\"nGrams\":[\"dated\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"983da7b8-51d7-4a85-9644-007b488fce0b\",\"kind\":\"dictionaryFeature\",\"name\":\"betw\",\"active\":true,\"nGrams\":[\"between\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false}],\"Fee\":[{\"id\":\"f4cf89dc-64d1-49a1-9be4-41debda251b6\",\"kind\":\"dictionaryFeature\",\"name\":\"flat fee of \",\"active\":true,\"nGrams\":[\"flat fee of $\",\"flat fee of $$\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false}],\"ServiceType\":[{\"id\":\"c04408f5-ce14-4eb0-81d0-f72ea9fa7e83\",\"kind\":\"dictionaryFeature\",\"name\":\"Before label\",\"active\":true,\"nGrams\":[\"will provide \"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"ea94fa7f-e41b-4e09-a484-355912bfbdff\",\"kind\":\"dictionaryFeature\",\"name\":\"After label\",\"active\":true,\"nGrams\":[\"services for \"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false}]}}", + "ID": 16, + "LastTrained": "2021-01-27T03:04:00Z", + "ListID": "f1e13676-8595-4c22-9ca2-c0a4076686ca", + "ModelSettings": null, + "ModelType": 2, + "Modified": "2021-01-27T03:05:04Z", + "ModifiedBy": "i:0#.f|membership|kevinche@contoso.com", + "ObjectId": "01ZBWEM5E54ZCXN6ZBERFKC6U336T4WY64", + "PublicationType": 0, + "Schemas": "{\"Extractors\":{\"Contract Name\":{\"concepts\":{\"841d0dcf-7f1d-4a39-931c-53923d10c346\":{\"name\":\"Contract Name\"}},\"relationships\":[]},\"Client \":{\"concepts\":{\"8b8490d0-9a09-4c16-bcff-59ce62e05c28\":{\"name\":\"Client \"}},\"relationships\":[]},\"Contract Date\":{\"concepts\":{\"6ba58918-e2f0-4685-9080-98ec4c3adc7c\":{\"name\":\"Contract Date\"}},\"relationships\":[]},\"Fee\":{\"concepts\":{\"9c7f764d-afd2-49cd-aaa2-e9407156bfb3\":{\"name\":\"Fee\"}},\"relationships\":[]},\"ServiceType\":{\"concepts\":{\"4aa9f2fe-cfab-49f8-86b1-11646c79cdbf\":{\"name\":\"ServiceType\",\"termSetId\":\"76c12efb-5173-4982-ae9b-5f9e37187171\"}},\"relationships\":[]}}}", + "SourceUrl": null, + "UniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc" +} +``` + +### Get and delete the Contoso Contract model by name + +In this sample, the name of the Contoso Contract document understanding model is `Contoso Contract`. + +##### Sample request + +```HTTP +DELETE /_api/machinelearning/models/getbytitle('Contoso Contract') HTTP/1.1 +``` + +## See also + +[Syntex document understanding model REST API](syntex-model-rest-api.md) diff --git a/docs/apis/syntex/rest-getbyuniqueid-method.md b/docs/apis/syntex/rest-getbyuniqueid-method.md new file mode 100644 index 000000000..a22cb154e --- /dev/null +++ b/docs/apis/syntex/rest-getbyuniqueid-method.md @@ -0,0 +1,110 @@ +--- +title: GetByUniqueId +description: Use REST API to get or update information about a Microsoft Syntex document understanding model. +ms.date: 09/23/2022 +ms.author: chucked +author: chuckedmonson +manager: pamgreen +ms.reviewer: ssquires +audience: admin +ms.topic: reference +ms.collection: m365initiative-syntex +ms.localizationpriority: high +--- + +# GetByUniqueId + +Gets or updates information about a Microsoft Syntex document understanding model (see [example](rest-getbyuniqueid-method.md#examples)). + +## HTTP request + +```HTTP +GET /_api/machinelearning/models/getbyuniqueid('{modelUniqueId}') HTTP/1.1 +``` + +This same method can be used for deleting a model, too. + +```HTTP +DELETE /_api/machinelearning/models/getbyuniqueid('{modelUniqueId}') HTTP/1.1 +``` +## URI parameters + +|Name |In |Required|Type|Description| +|-----|---|--------|----|-----------| +|modelUniqueId|query|True|string|ID of the Syntex model file.| + +## Request headers + +| Header | Value | +|--------|-------| +|Accept|application/json;odata=verbose| + +## Request body + +For GET, no request body is needed. + +## Responses + +| Name | Type | Description| +|--------|-------|------------| +|200 OK| |Success| + +## Examples + +### Get the Contoso Contract model by ID + +In this sample, the ID of the Contoso Contract document understanding model is `7645e69d-21fb-4a24-a17a-9bdfa7cb63dc`. + +#### Sample request + +```HTTP +GET /_api/machinelearning/models/getbyuniqueid('7645e69d-21fb-4a24-a17a-9bdfa7cb63dc') HTTP/1.1 +``` + +#### Sample response + +**Status code:** 200 + +```HTTP +{ + "@odata.context": "https://contoso.sharepoint.com/sites/filerepository/_api/$metadata#models/$entity", + "@odata.type": "#Microsoft.Office.Server.ContentCenter.SPMachineLearningModel", + "@odata.id": "https://contoso.sharepoint.com/sites/filerepository/_api/machinelearning/models/getbyuniqueId('7645e69d-21fb-4a24-a17a-9bdfa7cb63dc')", + "@odata.etag": "\"7645e69d-21fb-4a24-a17a-9bdfa7cb63dc,111\"", + "@odata.editLink": " https://contoso.sharepoint.com/sites/filerepository /_api/machinelearning/models/getbyuniqueId('7645e69d-21fb-4a24-a17a-9bdfa7cb63dc')", + "ConfidenceScore": "{\"trainingStatus\":{\"kind\":\"original\",\"ClassifierStatus\":{\"TrainingStatus\":\"success\",\"TimeStamp\":1611716640535},\"ExtractorsStatus\":[{\"TimeStamp\":1585175746775,\"ExtractorName\":\"Contract Name\",\"TrainingStatus\":\"success\"},{\"TimeStamp\":1586905975794,\"ExtractorName\":\"Client \",\"TrainingStatus\":\"success\"},{\"TimeStamp\":1586906061099,\"ExtractorName\":\"Contract Date\",\"TrainingStatus\":\"success\"},{\"TimeStamp\":1586907912388,\"ExtractorName\":\"Fee\",\"TrainingStatus\":\"success\"},{\"TimeStamp\":1611716640115,\"ExtractorName\":\"ServiceType\",\"TrainingStatus\":\"success\"}]},\"modelAccuracy\":{\"Classifier\":1,\"Extractors\":{\"Contract Name\":1,\"Client \":1,\"Contract Date\":1,\"Fee\":1,\"ServiceType\":1}},\"perSampleAccuracy\":{\"133\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"249\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"252\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"253\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"254\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"255\":{\"Classifier\":1,\"Extractors\":{\"ServiceType\":1}},\"256\":{\"Extractors\":{\"ServiceType\":1}},\"257\":{\"Extractors\":{\"ServiceType\":1}}},\"perSamplePrediction\":{\"133\":{\"Extractors\":{\"ServiceType\":[]}},\"249\":{\"Extractors\":{\"ServiceType\":[\"Writing\"]}},\"252\":{\"Extractors\":{\"ServiceType\":[\"Catering\"]}},\"253\":{\"Extractors\":{\"ServiceType\":[\"Design\"]}},\"254\":{\"Extractors\":{\"ServiceType\":[\"Marketing\"]}},\"255\":{\"Extractors\":{\"ServiceType\":[\"Financial Planning\"]}},\"256\":{\"Extractors\":{\"ServiceType\":[\"Writing\"]}},\"257\":{\"Extractors\":{\"ServiceType\":[\"Writing\"]}}},\"trainingFailures\":{}}", + "ContentTypeGroup": "Intelligent Document Content Types", + "ContentTypeId": "0x01010083DF84D4F59BBD4CB06F075AA81F58AA", + "ContentTypeName": "Contoso Contract", + "Created": "2020-03-25T22:04:04Z", + "CreatedBy": "i:0#.f|membership|meganb@contoso.com", + "DriveId": "b!O-aG9qer5UiXx2jEwd8pL0221maIb9lNs9tH5vAMU-h2NuHxlYUiTJyiwKQHZobK", + "Explanations": "{\"Classifier\":[{\"id\":\"8122ac1d-8fcb-4705-8872-2825cbf05bfe\",\"kind\":\"dictionaryFeature\",\"name\":\"agreement\",\"active\":true,\"nGrams\":[\"CONSULTING AGREEMENT\",\"SERVICES AGREEMENT\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"af83bea8-bc53-4e93-a3da-f1e697eb6bef\",\"kind\":\"modelFeature\",\"name\":\"Contract Name\",\"active\":true,\"modelReference\":\"Contract Name\",\"conceptId\":\"841d0dcf-7f1d-4a39-931c-53923d10c346\"},{\"id\":\"e3734994-9e34-40e3-82c7-bb6c7bc5a0c3\",\"kind\":\"modelFeature\",\"name\":\"Client \",\"active\":true,\"modelReference\":\"Client \",\"conceptId\":\"8b8490d0-9a09-4c16-bcff-59ce62e05c28\"},{\"id\":\"7c93e7fe-cbfb-47ee-8cca-46ecdf5f628f\",\"kind\":\"modelFeature\",\"name\":\"Contract Date\",\"active\":true,\"modelReference\":\"Contract Date\",\"conceptId\":\"6ba58918-e2f0-4685-9080-98ec4c3adc7c\"},{\"id\":\"5cc85b62-148a-4b07-9155-d9fb7cebb6d0\",\"kind\":\"modelFeature\",\"name\":\"Fee\",\"active\":true,\"modelReference\":\"Fee\",\"conceptId\":\"9c7f764d-afd2-49cd-aaa2-e9407156bfb3\"},{\"id\":\"0f8a23a6-c744-4cae-82bd-d836332ceb56\",\"kind\":\"modelFeature\",\"name\":\"ServiceType\",\"active\":true,\"modelReference\":\"ServiceType\",\"conceptId\":\"4aa9f2fe-cfab-49f8-86b1-11646c79cdbf\"}],\"Extractors\":{\"Contract Name\":[{\"id\":\"8804fbeb-bcf8-44c0-8ade-3fc65496037f\",\"kind\":\"dictionaryFeature\",\"name\":\"before\",\"active\":true,\"nGrams\":[\"- AND -\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false}],\"Client \":[{\"id\":\"606c56de-9e71-42ef-8ec6-f0bbf351d673\",\"kind\":\"dictionaryFeature\",\"name\":\"start\",\"active\":true,\"nGrams\":[\"BETWEEN:\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"334e6df5-e076-40db-a47b-f11ceec7af9a\",\"kind\":\"dictionaryFeature\",\"name\":\"after\",\"active\":true,\"nGrams\":[\"of\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"bccefd2e-88a4-406c-aa9d-81d508bbafb3\",\"kind\":\"proximityFeature\",\"name\":\"prox\",\"active\":true,\"patterns\":[[{\"id\":\"606c56de-9e71-42ef-8ec6-f0bbf351d673\",\"kind\":\"proximityFeatureReference\"},{\"kind\":\"proximityTokenRange\",\"minCount\":1,\"maxCount\":6},{\"id\":\"334e6df5-e076-40db-a47b-f11ceec7af9a\",\"kind\":\"proximityFeatureReference\"}]]}],\"Contract Date\":[{\"id\":\"fabe1ed3-07af-4dc6-852d-fe9521c64801\",\"kind\":\"dictionaryFeature\",\"name\":\"dated\",\"active\":true,\"nGrams\":[\"dated\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"983da7b8-51d7-4a85-9644-007b488fce0b\",\"kind\":\"dictionaryFeature\",\"name\":\"betw\",\"active\":true,\"nGrams\":[\"between\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false}],\"Fee\":[{\"id\":\"f4cf89dc-64d1-49a1-9be4-41debda251b6\",\"kind\":\"dictionaryFeature\",\"name\":\"flat fee of \",\"active\":true,\"nGrams\":[\"flat fee of $\",\"flat fee of $$\"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false}],\"ServiceType\":[{\"id\":\"c04408f5-ce14-4eb0-81d0-f72ea9fa7e83\",\"kind\":\"dictionaryFeature\",\"name\":\"Before label\",\"active\":true,\"nGrams\":[\"will provide \"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false},{\"id\":\"ea94fa7f-e41b-4e09-a484-355912bfbdff\",\"kind\":\"dictionaryFeature\",\"name\":\"After label\",\"active\":true,\"nGrams\":[\"services for \"],\"caseSensitive\":false,\"ignoreDigitIdentity\":false,\"ignoreLetterIdentity\":false}]}}", + "ID": 16, + "LastTrained": "2021-01-27T03:04:00Z", + "ListID": "f1e13676-8595-4c22-9ca2-c0a4076686ca", + "ModelSettings": null, + "ModelType": 2, + "Modified": "2021-01-27T03:05:04Z", + "ModifiedBy": "i:0#.f|membership|kevinche@contoso.com", + "ObjectId": "01ZBWEM5E54ZCXN6ZBERFKC6U336T4WY64", + "PublicationType": 0, + "Schemas": "{\"Extractors\":{\"Contract Name\":{\"concepts\":{\"841d0dcf-7f1d-4a39-931c-53923d10c346\":{\"name\":\"Contract Name\"}},\"relationships\":[]},\"Client \":{\"concepts\":{\"8b8490d0-9a09-4c16-bcff-59ce62e05c28\":{\"name\":\"Client \"}},\"relationships\":[]},\"Contract Date\":{\"concepts\":{\"6ba58918-e2f0-4685-9080-98ec4c3adc7c\":{\"name\":\"Contract Date\"}},\"relationships\":[]},\"Fee\":{\"concepts\":{\"9c7f764d-afd2-49cd-aaa2-e9407156bfb3\":{\"name\":\"Fee\"}},\"relationships\":[]},\"ServiceType\":{\"concepts\":{\"4aa9f2fe-cfab-49f8-86b1-11646c79cdbf\":{\"name\":\"ServiceType\",\"termSetId\":\"76c12efb-5173-4982-ae9b-5f9e37187171\"}},\"relationships\":[]}}}", + "SourceUrl": null, + "UniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc" +} +``` + +### Get and delete the Contoso Contract model by ID + +In this sample, the ID of the Contoso Contract document understanding model is `7645e69d-21fb-4a24-a17a-9bdfa7cb63dc`. + +#### Sample request + +```HTTP +DELETE /_api/machinelearning/models/getbyuniqueid('7645e69d-21fb-4a24-a17a-9bdfa7cb63dc') HTTP/1.1 +``` + +## See also + +[Syntex document understanding model REST API](syntex-model-rest-api.md) diff --git a/docs/apis/syntex/rest-getmodelandlibraryinfo.md b/docs/apis/syntex/rest-getmodelandlibraryinfo.md new file mode 100644 index 000000000..2ae731fe7 --- /dev/null +++ b/docs/apis/syntex/rest-getmodelandlibraryinfo.md @@ -0,0 +1,122 @@ +--- +title: Get model and library info +description: Use REST API to get information about a model and the library where it has been applied. +ms.date: 09/23/2022 +ms.author: chucked +author: chuckedmonson +manager: pamgreen +ms.reviewer: ssquires +audience: admin +ms.topic: reference +ms.collection: m365initiative-syntex +ms.localizationpriority: high +--- + +# Get model and library information + +Gets information about a model and the library where it has been applied (see [example](rest-getmodelandlibraryinfo.md#examples)). + +## HTTP request + +```HTTP +GET /_api/machinelearning/publications/getbymodeluniqueid('{modelUniqueId}') HTTP/1.1 +``` + +## URI parameters + +| Name | In | Required | Type | Description | +|--------|-------|--------|------------|-----------| +|ModelUniqueId|query|True|GUID|The unique id of the model file.| + +## Request headers + +| Header | Value | +|--------|-------| +|Accept|application/json;odata=verbose| + + +## Response + +| Name | Type | Description| +|--------|-------|------------| +|200 OK| |Success| + +## Examples + +### Get information about the contracts model and primed document library in the repository site + +In this sample, the ID of the Contoso Contract document understanding model is `7645e69d-21fb-4a24-a17a-9bdfa7cb63dc`. + +#### Sample request + +```HTTP +GET /sites/TestCC/_api/machinelearning/publications/getbymodeluniqueid('7645e69d-21fb-4a24-a17a-9bdfa7cb63dc') HTTP/1.1 +``` + +#### Sample response + +**Status code:** 200 + +```JSON +{ + "@odata.context": "https://contoso.sharepoint.com/sites/TestCC/_api/$metadata#publications", + "value": [ + { + "@odata.type": "#Microsoft.Office.Server.ContentCenter.SPMachineLearningPublication", + "@odata.id": "https://contoso.sharepoint.com/sites/repository /_api/machinelearning/publications/getbyuniqueId('7645e69d-21fb-4a24-a17a-9bdfa7cb63dc')", + "@odata.etag": "\"7645e69d-21fb-4a24-a17a-9bdfa7cb63dc,94\"", + "@odata.editLink": " https://contoso.sharepoint.com/sites/TestCC /_api/machinelearning/publications/getbyuniqueId('7645e69d-21fb-4a24-a17a-9bdfa7cb63dc')", + "Created": "2021-04-27T03:05:25Z", + "CreatedBy": "i:0#.f|membership|meganb@contoso.com", + "DriveId": "b!O-aG9qer5UiXx2jEwd8pL0221maIb9lNs9tH5vAMU-gPy9BrxT7GTrtXtdtv1Uzb", + "ID": 26, + "ModelId": 16, + "ModelName": "contosocontract.classifier", + "ModelType": 0, + "ModelUniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc", + "ModelVersion": "8.0", + "Modified": "2021-03-17T17:56:42Z", + "ModifiedBy": "i:0#.f|membership|joedoe@contoso.com", + "ObjectId": "01ZBWEM5FZRILGLXTEB5CZ2NNNSCTWBJMQ", + "PublicationType": 1, + "TargetLibraryRemoved": false, + "TargetLibraryServerRelativeUrl": "/sites/repository/contracts", + "TargetLibraryUrl": " https://contoso.sharepoint.com/sites/repository/contracts", + "TargetSiteUrl": "https://contoso.sharepoint.com/sites/repository", + "TargetWebServerRelativeUrl": "/sites/repository", + "UniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc", + "ViewOption": "NewViewAsDefault" + }, + { + "@odata.type": "#Microsoft.Office.Server.ContentCenter.SPMachineLearningPublication", + "@odata.id": "https://contoso.sharepoint.com /sites/legal/_api/machinelearning/publications/getbyuniqueId('7645e69d-21fb-4a24-a17a-9bdfa7cb63dc')", + "@odata.etag": "\"7645e69d-21fb-4a24-a17a-9bdfa7cb63dc,101\"", + "@odata.editLink": "https://contoso.sharepoint.com /sites/legal/_api/machinelearning/publications/getbyuniqueId('7645e69d-21fb-4a24-a17a-9bdfa7cb63dc')", + "Created": "2021-01-27T03:17:44Z", + "CreatedBy": "i:0#.f|membership|esherman@contoso.com ", + "DriveId": "b!O-aG9qer5UiXx2jEwd8pL0221maIb9lNs9tH5vAMU-gPy9BrxT7GTrtXtdtv1Uzb", + "ID": 27, + "ModelId": 16, + "ModelName": "dispositions.classifier", + "ModelType": 0, + "ModelUniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc", + "ModelVersion": "8.0", + "Modified": "2021-03-17T23:17:46Z", + "ModifiedBy": "i:0#.f|membership|esherman@contoso.com ", + "ObjectId": "01ZBWEM5B3ERSZK4PAARGLFZ7JP6GMXG2R", + "PublicationType": 1, + "TargetLibraryRemoved": false, + "TargetLibraryServerRelativeUrl": "/sites/legal/dispositions", + "TargetLibraryUrl": "https://contoso.sharepoint.com/sites/legal/dispositions", + "TargetSiteUrl": " https://contoso.sharepoint.com/sites/legal", + "TargetWebServerRelativeUrl": "/sites/legal", + "UniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc", + "ViewOption": "NewViewAsDefault" + } + ] +} +``` + +## See also + +[Syntex document understanding model REST API](syntex-model-rest-api.md) diff --git a/docs/apis/syntex/rest-updatemodelsettings-method.md b/docs/apis/syntex/rest-updatemodelsettings-method.md new file mode 100644 index 000000000..904565c66 --- /dev/null +++ b/docs/apis/syntex/rest-updatemodelsettings-method.md @@ -0,0 +1,74 @@ +--- +title: UpdateModelSettings +description: Use REST API to update available models settings for a Microsoft Syntex document understanding model. +ms.date: 09/23/2022 +ms.author: chucked +author: chuckedmonson +manager: pamgreen +ms.reviewer: ssquires +audience: admin +ms.topic: reference +ms.collection: m365initiative-syntex +ms.localizationpriority: high +--- + +# UpdateModelSettings + +Updates available models settings (associated retention label and model description) for a Microsoft Syntex document understanding model (see [example](rest-updatemodelsettings-method.md#examples)). + +## HTTP request + +```HTTP +POST /_api/machinelearning/models/getbytitle('{modelFileName}')/updatemodelsettings HTTP/1.1 +``` + +## URI parameters + +|Name |In |Required|Type|Description| +|-----|---|--------|----|-----------| +|modelFileName|query|True|string|Name of the Syntex model file.| + +## Request headers + +| Header | Value | +|--------|-------| +|Accept|application/json;odata=verbose| +|Content-Type|application/json;odata=verbose;charset=utf-8| +|x-requestdigest|The appropriate digest for the current site.| + +## Request body + +|Name |Type |Description | +|--------|-------|-------| +|ModelSettings|string|JSON of model settings.| +|Description|string|The model description.| +|RetentionLabel| |Info for the associated label (label ID and name).| + +## Responses + +| Name | Type | Description| +|--------|-------|------------| +|200 OK| |Success| + +## Examples + +### Update model settings for Contoso Contract + +In this example, the model description and "Standard Hold" retention label are updated. The ID of the retention label is `27c5fcba-abfd-4c34-823d-0b4a48f7ffe6`. + +#### Sample request + +```HTTP +{ + "ModelSettings": "{\"Description\":\"This model is used to set files classified as Contoso Contracts with a standard hold retention.\", \"RetentionLabel\":{\"Id\":\"27c5fcba-abfd-4c34-823d-0b4a48f7ffe6\",\"Name\":\"Standard Hold\"}}" +} + +``` + +#### Sample response + +**Status code:** 200 + +## See also + +[Syntex document understanding model REST API](syntex-model-rest-api.md) diff --git a/docs/apis/syntex/syntex-model-rest-api.md b/docs/apis/syntex/syntex-model-rest-api.md new file mode 100644 index 000000000..277c633dd --- /dev/null +++ b/docs/apis/syntex/syntex-model-rest-api.md @@ -0,0 +1,57 @@ +--- +title: Unstructured document understanding model REST API +description: Overview of the document understanding model REST API. +ms.date: 07/21/2025 +ms.author: chucked +author: chuckedmonson +manager: pamgreen +ms.reviewer: ssquires +audience: admin +ms.topic: reference +ms.collection: m365initiative-syntex +ms.localizationpriority: medium +--- + +# Unstructured document processing model REST API + +You can use the SharePoint REST interface to create an unstructured document processing model, apply or remove the model to one or more libraries, and obtain or update information about the model. + +The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option. + +For details and links to code samples, see [Make batch requests with the REST APIs](/sharepoint/dev/sp-add-ins/make-batch-requests-with-the-rest-apis). + +## Prerequisites + +Before you get started, make sure that you're familiar with the following: + +- [Get to know the SharePoint REST service](/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service) +- [Complete basic operations using SharePoint REST endpoints](/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints) + +## REST commands + +The following REST commands are available for working with unstructured document processing models: + +- [Create model](rest-createmodel-method.md) – Creates a model and its associated content type. +- [GetByUniqueId](rest-getbyuniqueid-method.md) – Gets or updates information about an unstructured document processing model. +- [GetByTitle](rest-getbytitle-method.md) – Gets or updates information about an unstructured document processing model using the model title. +- [Apply model](rest-applymodel-method.md) – Applies (or syncs) a trained unstructured document processing model to one or more libraries. +- [Get model and library information](rest-getmodelandlibraryinfo.md) – Gets information about a model and the library where it has been applied. +- [UpdateModelSettings](rest-updatemodelsettings-method.md) – Updates available models settings (associated retention label and model description) for an unstructured document processing model. +- [BatchDelete](rest-batchdelete-method.md) – Removes an applied unstructured document processing model from one or more libraries. +- [Create file classification request](rest-createclassificationrequest.md) – Creates a request to classify a specified file or files using the applied model. +- [Create folder classification request](rest-createclassificationrequest.md) – Creates a request to classify an entire folder using the applied model. + +## Scenarios + +Note the following scenario examples that aren't intuitive from the method name. For more information, see each article. + +The create model method only creates the model object and its associated content type. You'll need to first train the model in the content center before it can be applied to a library. + +The apply model method is used to configure the model on the target library to classify documents and optionally extract additional information. This API also supports batch applying the model to multiple libraries. + +The remove model method just removes the model from one or more libraries where it was previously applied. If you want to delete the model, it must first be removed from all the libraries where it was applied. + + +## See also + +[Unstructured document processing overview](/microsoft-365/contentunderstanding/document-understanding-overview) diff --git a/docs/apis/webhooks/get-started-webhooks.md b/docs/apis/webhooks/get-started-webhooks.md index 01d0096bc..c3b73e38a 100644 --- a/docs/apis/webhooks/get-started-webhooks.md +++ b/docs/apis/webhooks/get-started-webhooks.md @@ -1,17 +1,14 @@ --- title: Get started with SharePoint webhooks description: Build an application that adds and handles SharePoint webhook requests. -ms.date: 03/14/2018 -ms.prod: sharepoint -localization_priority: Priority +ms.date: 09/23/2022 +ms.localizationpriority: high --- - - # Get started with SharePoint webhooks This article describes how to build an application that adds and handles SharePoint webhook requests. You will learn how to use [Postman client](https://www.getpostman.com/) to construct and execute SharePoint webhook requests quickly while interacting with a simple ASP.NET Web API as the webhook receiver. -You will use plain HTTP requests, which is useful for helping you understand how webhooks work. +You will use plain HTTP requests, which is useful for helping you understand how webhooks work. To complete the step-by-step instructions in this article, download and install the following tools: @@ -19,31 +16,29 @@ To complete the step-by-step instructions in this article, download and install * [Postman](https://www.getpostman.com/) * [Visual Studio Community Edition](https://go.microsoft.com/fwlink/?LinkId=691978&clcid=0x409) * [ngrok](https://ngrok.com/) (to install ngrok, see [Download and Installation](https://ngrok.com/download)) -* An Office 365 developer subscription with SharePoint Online. If you are new to Office 365, you can also [sign up for an Office 365 developer subscription through the Office 365 Developer Program](https://developer.microsoft.com/office/dev-program). See the [Office 365 Developer Program documentation](https://docs.microsoft.com/office/developer-program/office-365-developer-program) for step-by-step instructions about how to join the Office 365 Developer Program and sign up and configure your subscription. +* An Office 365 developer subscription with SharePoint Online. If you are new to Office 365, you can also [sign up for an Office 365 developer subscription through the Office 365 Developer Program](https://developer.microsoft.com/office/dev-program). See the [Office 365 Developer Program documentation](/office/developer-program/office-365-developer-program) for step-by-step instructions about how to join the Office 365 Developer Program and sign up and configure your subscription. ## Step 1: Register an Azure AD application for Postman client -In order for the Postman client to communicate with SharePoint, you need to register a Microsoft Azure Active Directory (Azure AD) app in your Azure AD tenant associated with your Office 365 tenant. +In order for the Postman client to communicate with SharePoint, you need to register a Microsoft Azure Active Directory (Azure AD) app in your Azure AD tenant associated with your Office 365 tenant. 1. Ensure that you register the application as a **Web Application**. +1. To access SharePoint Online, it's important to grant the Azure AD app permissions to the **Office 365 SharePoint Online** application and select the **read and write items and lists in all site collections** permission. -2. To access SharePoint Online, it's important to grant the Azure AD app permissions to the **Office 365 SharePoint Online** application and select the **read and write items and lists in all site collections** permission. - - > [!NOTE] - > For more information about adding an Azure AD application and granting permissions to applications, see [Adding an application](https://docs.microsoft.com/azure/active-directory/develop/active-directory-integrating-applications#adding-an-application). + > [!NOTE] + > For more information about adding an Azure AD application and granting permissions to applications, see [Adding an application](/azure/active-directory/develop/active-directory-integrating-applications#adding-an-application). -3. Enter the following endpoint as the Reply (Redirect) URL for the app. This is the endpoint to which Azure AD will send the authentication response, including the access token, if authentication was successful. +1. Enter the following endpoint as the Reply (Redirect) URL for the app. This is the endpoint to which Azure AD will send the authentication response, including the access token, if authentication was successful. - ```html - https://www.getpostman.com/oauth2/callback - ``` + ```html + https://www.getpostman.com/oauth2/callback + ``` -4. Generate a **Key**, which will be the client secret. +1. Generate a **Key**, which will be the client secret. +1. The following properties are required in later steps, so copy them to a safe place: -5. The following properties are required in later steps, so copy them to a safe place: - - * Client Id - * Client Secret + * Client Id + * Client Secret ## Step 2: Build a webhook receiver @@ -52,22 +47,14 @@ For this project, use the Visual Studio Web API project to build the webhook rec ### Create a new ASP.NET Web API project 1. Open Visual Studio. - -2. Select **File** > **New** > **Project**. - -3. In the **Templates** pane, select **Installed Templates**, and expand the **Visual C#** node. - -4. Under **Visual C#**, select **Web**. - -5. In the list of project templates, select **ASP.NET Web Application**. - -6. Name the project **SPWebhooksReceiver**, and select **OK**. - -7. In the **New ASP.NET Project** dialog, select the **Web API** template from the **ASP.NET 4.5.** group. - -8. Change the authentication to **No Authentication** by selecting the **Change Authentication** button. - -9. Select **OK** to create the Web API project. +1. Select **File** > **New** > **Project**. +1. In the **Templates** pane, select **Installed Templates**, and expand the **Visual C#** node. +1. Under **Visual C#**, select **Web**. +1. In the list of project templates, select **ASP.NET Web Application**. +1. Name the project **SPWebhooksReceiver**, and select **OK**. +1. In the **New ASP.NET Project** dialog, select the **Web API** template from the **ASP.NET 4.5.** group. +1. Change the authentication to **No Authentication** by selecting the **Change Authentication** button. +1. Select **OK** to create the Web API project. > [!NOTE] > You can clear the **Host in the cloud** check box because this project will not be deployed to the cloud. @@ -81,70 +68,54 @@ Visual Studio creates your project. Use ASP.NET Web API Tracing to log the requests coming from SharePoint. The following steps install the tracing package: 1. Go to **Solution Explorer** in Visual Studio. - -2. Open the context menu (right-click) for the project, and select **Manage NuGet Packages**. - -3. In the search box, enter **Microsoft.AspNet.WebApi.Tracing**. - -4. In the search results, select the **Microsoft.AspNet.WebApi.Tracing** package, and then select **Install** to install the package. +1. Open the context menu (right-click) for the project, and select **Manage NuGet Packages**. +1. In the search box, enter **Microsoft.AspNet.WebApi.Tracing**. +1. In the search results, select the **Microsoft.AspNet.WebApi.Tracing** package, and then select **Install** to install the package. #### Build SPWebhookNotification model Each notification generated by the service is serialized into a **webhookNotification** instance. You need to build a simple model that represents this notification instance. 1. Go to **Solution Explorer** in Visual Studio. - -2. Open the context menu (right-click) for the **Models** folder, and select **Add** > **Class**. - -3. Enter **SPWebhookNotification** as the class name and select **Add** to add the class to your project. - -4. Add the following code to the body of the **SPWebhookNotification** class: - - ```cs - public string SubscriptionId { get; set; } - - public string ClientState { get; set; } - - public string ExpirationDateTime { get; set; } - - public string Resource { get; set; } - - public string TenantId { get; set; } - - public string SiteUrl { get; set; } - - public string WebId { get; set; } - ``` +1. Open the context menu (right-click) for the **Models** folder, and select **Add** > **Class**. +1. Enter **SPWebhookNotification** as the class name and select **Add** to add the class to your project. +1. Add the following code to the body of the **SPWebhookNotification** class: + + ```csharp + public string SubscriptionId { get; set; } + public string ClientState { get; set; } + public string ExpirationDateTime { get; set; } + public string Resource { get; set; } + public string TenantId { get; set; } + public string SiteUrl { get; set; } + public string WebId { get; set; } + ``` #### Build SPWebhookContent model Because multiple notifications can be submitted to your webhook receiver in a single request, they are combined together in an object with a single array value. Build a simple model that represents the array. 1. Go to **Solution Explorer** in Visual Studio. +1. Open the context menu (right-click) for the **Models** folder, and select **Add** > **Class**. +1. Enter **SPWebhookContent** as the class name, and select **Add** to add the class to your project. +1. Add the following code to the body of the **SPWebhookContent** class: -2. Open the context menu (right-click) for the **Models** folder, and select **Add** > **Class**. - -3. Enter **SPWebhookContent** as the class name, and select **Add** to add the class to your project. - -4. Add the following code to the body of the **SPWebhookContent** class: - - ```cs - public List Value { get; set; } - ``` + ```csharp + public List Value { get; set; } + ``` #### Add SharePoint webhook client state -Webhooks provide the ability to use an optional string value that is passed back in the notification message for your subscription. This can be used to verify that the request is indeed coming from the source you trust, which in this case is SharePoint. +Webhooks provide the ability to use an optional string value that is passed back in the notification message for your subscription. This can be used to verify that the request is indeed coming from the source you trust, which in this case is SharePoint. Add a client state value with which the application can verify the incoming requests. 1. Go to **Solution Explorer** in Visual Studio. +1. Open the **web.config** file, and add the following key as the client state to the `` section: -2. Open the **web.config** file, and add the following key as the client state to the `` section: - - ```xml - - ``` + ```xml + + ``` #### Enable tracing @@ -157,162 +128,152 @@ In the **web.config** file, enable tracing by adding the following key inside th A trace writer is required, so you must add a trace writer to the controller configuration (in this case use the one from **System.Diagnostics**). 1. Go to **Solution Explorer** in Visual Studio. +1. Open **WebApiConfig.cs** in the **App_Start** folder. +1. Add the following line inside the **Register** method: -2. Open **WebApiConfig.cs** in the **App_Start** folder. - -3. Add the following line inside the **Register** method: - - ```cs - config.EnableSystemDiagnosticsTracing(); - ``` + ```csharp + config.EnableSystemDiagnosticsTracing(); + ``` #### Build SharePoint webhook controller Now build the webhook receiver controller that handles the incoming requests from SharePoint and take action accordingly. 1. Go to **Solution Explorer** in Visual Studio. - -2. Open the context menu (right-click) for the **Controllers** folder, and select **Add** > **Controller**. - -3. In the **Add Scaffold** dialog, select **Web API 2 Controller - Empty**. - -4. Select **Add**. - -5. Name the controller **SPWebhookController**, and select **Add** to add the API controller to your project. - -6. Replace the `using` statements with the following code: - - ```cs - using Newtonsoft.Json; - using SPWebhooksReceiver.Models; - using System.Collections.Generic; - using System.Configuration; - using System.Linq; - using System.Net; - using System.Net.Http; - using System.Threading.Tasks; - using System.Web; - using System.Web.Http; - using System.Web.Http.Tracing; - ``` - -7. Replace the code in the **SPWebhookController** class with the following code: - - ```cs - [HttpPost] - public HttpResponseMessage HandleRequest() - { - HttpResponseMessage httpResponse = new HttpResponseMessage(HttpStatusCode.BadRequest); - var traceWriter = Configuration.Services.GetTraceWriter(); - string validationToken = string.Empty; - IEnumerable clientStateHeader = new List(); - string webhookClientState = ConfigurationManager.AppSettings["webhookclientstate"].ToString(); - - if (Request.Headers.TryGetValues("ClientState", out clientStateHeader)) - { - string clientStateHeaderValue = clientStateHeader.FirstOrDefault() ?? string.Empty; - - if (!string.IsNullOrEmpty(clientStateHeaderValue) && clientStateHeaderValue.Equals(webhookClientState)) - { - traceWriter.Trace(Request, "SPWebhooks", - TraceLevel.Info, - string.Format("Received client state: {0}", clientStateHeaderValue)); - - var queryStringParams = HttpUtility.ParseQueryString(Request.RequestUri.Query); - - if (queryStringParams.AllKeys.Contains("validationtoken")) - { - httpResponse = new HttpResponseMessage(HttpStatusCode.OK); - validationToken = queryStringParams.GetValues("validationtoken")[0].ToString(); - httpResponse.Content = new StringContent(validationToken); - - traceWriter.Trace(Request, "SPWebhooks", - TraceLevel.Info, - string.Format("Received validation token: {0}", validationToken)); - return httpResponse; - } - else - { - var requestContent = Request.Content.ReadAsStringAsync().Result; - - if (!string.IsNullOrEmpty(requestContent)) - { - SPWebhookNotification notification = null; - - try - { - var objNotification = JsonConvert.DeserializeObject(requestContent); - notification = objNotification.Value[0]; - } - catch (JsonException ex) - { - traceWriter.Trace(Request, "SPWebhooks", - TraceLevel.Error, - string.Format("JSON deserialization error: {0}", ex.InnerException)); - return httpResponse; - } - - if (notification != null) - { - Task.Factory.StartNew(() => - { - //handle the notification here - //you can send this to an Azure queue to be processed later - //for this sample, we just log to the trace - - traceWriter.Trace(Request, "SPWebhook Notification", - TraceLevel.Info, string.Format("Resource: {0}", notification.Resource)); - traceWriter.Trace(Request, "SPWebhook Notification", - TraceLevel.Info, string.Format("SubscriptionId: {0}", notification.SubscriptionId)); - traceWriter.Trace(Request, "SPWebhook Notification", - TraceLevel.Info, string.Format("TenantId: {0}", notification.TenantId)); - traceWriter.Trace(Request, "SPWebhook Notification", - TraceLevel.Info, string.Format("SiteUrl: {0}", notification.SiteUrl)); - traceWriter.Trace(Request, "SPWebhook Notification", - TraceLevel.Info, string.Format("WebId: {0}", notification.WebId)); - traceWriter.Trace(Request, "SPWebhook Notification", - TraceLevel.Info, string.Format("ExpirationDateTime: {0}", notification.ExpirationDateTime)); - - }); - - httpResponse = new HttpResponseMessage(HttpStatusCode.OK); - } - } - } - } - else - { - httpResponse = new HttpResponseMessage(HttpStatusCode.Forbidden); - } - } - - return httpResponse; - } - ``` - -8. Save the file. +1. Open the context menu (right-click) for the **Controllers** folder, and select **Add** > **Controller**. +1. In the **Add Scaffold** dialog, select **Web API 2 Controller - Empty**. +1. Select **Add**. +1. Name the controller **SPWebhookController**, and select **Add** to add the API controller to your project. +1. Replace the `using` statements with the following code: + + ```csharp + using Newtonsoft.Json; + using SPWebhooksReceiver.Models; + using System.Collections.Generic; + using System.Configuration; + using System.Linq; + using System.Net; + using System.Net.Http; + using System.Threading.Tasks; + using System.Web; + using System.Web.Http; + using System.Web.Http.Tracing; + ``` + +1. Replace the code in the **SPWebhookController** class with the following code: + + ```csharp + [HttpPost] + public HttpResponseMessage HandleRequest() + { + HttpResponseMessage httpResponse = new HttpResponseMessage(HttpStatusCode.BadRequest); + var traceWriter = Configuration.Services.GetTraceWriter(); + string validationToken = string.Empty; + IEnumerable clientStateHeader = new List(); + string webhookClientState = ConfigurationManager.AppSettings["webhookclientstate"].ToString(); + + if (Request.Headers.TryGetValues("ClientState", out clientStateHeader)) + { + string clientStateHeaderValue = clientStateHeader.FirstOrDefault() ?? string.Empty; + + if (!string.IsNullOrEmpty(clientStateHeaderValue) && clientStateHeaderValue.Equals(webhookClientState)) + { + traceWriter.Trace(Request, "SPWebhooks", + TraceLevel.Info, + string.Format("Received client state: {0}", clientStateHeaderValue)); + + var queryStringParams = HttpUtility.ParseQueryString(Request.RequestUri.Query); + + if (queryStringParams.AllKeys.Contains("validationtoken")) + { + httpResponse = new HttpResponseMessage(HttpStatusCode.OK); + validationToken = queryStringParams.GetValues("validationtoken")[0].ToString(); + httpResponse.Content = new StringContent(validationToken); + + traceWriter.Trace(Request, "SPWebhooks", + TraceLevel.Info, + string.Format("Received validation token: {0}", validationToken)); + return httpResponse; + } + else + { + var requestContent = Request.Content.ReadAsStringAsync().Result; + + if (!string.IsNullOrEmpty(requestContent)) + { + SPWebhookNotification notification = null; + + try + { + var objNotification = JsonConvert.DeserializeObject(requestContent); + notification = objNotification.Value[0]; + } + catch (JsonException ex) + { + traceWriter.Trace(Request, "SPWebhooks", + TraceLevel.Error, + string.Format("JSON deserialization error: {0}", ex.InnerException)); + return httpResponse; + } + + if (notification != null) + { + Task.Factory.StartNew(() => + { + //handle the notification here + //you can send this to an Azure queue to be processed later + //for this sample, we just log to the trace + + traceWriter.Trace(Request, "SPWebhook Notification", + TraceLevel.Info, string.Format("Resource: {0}", notification.Resource)); + traceWriter.Trace(Request, "SPWebhook Notification", + TraceLevel.Info, string.Format("SubscriptionId: {0}", notification.SubscriptionId)); + traceWriter.Trace(Request, "SPWebhook Notification", + TraceLevel.Info, string.Format("TenantId: {0}", notification.TenantId)); + traceWriter.Trace(Request, "SPWebhook Notification", + TraceLevel.Info, string.Format("SiteUrl: {0}", notification.SiteUrl)); + traceWriter.Trace(Request, "SPWebhook Notification", + TraceLevel.Info, string.Format("WebId: {0}", notification.WebId)); + traceWriter.Trace(Request, "SPWebhook Notification", + TraceLevel.Info, string.Format("ExpirationDateTime: {0}", notification.ExpirationDateTime)); + + }); + + httpResponse = new HttpResponseMessage(HttpStatusCode.OK); + } + } + } + } + else + { + httpResponse = new HttpResponseMessage(HttpStatusCode.Forbidden); + } + } + + return httpResponse; + } + ``` + +1. Save the file. ## Step 3: Debug the webhook receiver 1. Select **F5** to debug the webhook receiver. - -2. When you have the browser open, copy the port number from the address bar. For example: `http://localhost:<_port-number_>` +1. When you have the browser open, copy the port number from the address bar. For example: `http://localhost:<_port-number_>` ## Step 4: Run ngrok proxy 1. Open a console terminal. +1. Go to the extracted ngrok folder. +1. Enter the following with the port number URL from the previous step to start ngrok: -2. Go to the extracted ngrok folder. - -3. Enter the following with the port number URL from the previous step to start ngrok: + ``` + ./ngrok http port-number --host-header=localhost:port-number + ``` - ``` - ./ngrok http port-number --host-header=localhost:port-number - ``` + You should see ngrok running. - You should see ngrok running. - -4. Copy the **Forwarding** HTTPS address. You will use this address as the service proxy for SharePoint to send requests. +1. Copy the **Forwarding** HTTPS address. You will use this address as the service proxy for SharePoint to send requests. ## Step 5: Add webhook subscription using Postman @@ -321,15 +282,12 @@ Now build the webhook receiver controller that handles the incoming requests fro Postman makes it really simple to work with APIs. The first step is to configure Postman to authenticate with Azure AD so you can send API requests to SharePoint. You will use the Azure AD app that you registered in Step 1. 1. Open Postman. You are presented with a **Sidebar** and **Request Editor**. +1. Select the **Authorization** tab in the **Request Editor**. +1. Select **OAuth 2.0** in the **Type** list. +1. Select the **Get New Access Token** button. +1. In the dialog window, enter the following: -2. Select the **Authorization** tab in the **Request Editor**. - -3. Select **OAuth 2.0** in the **Type** list. - -4. Select the **Get New Access Token** button. - -5. In the dialog window, enter the following: - * **Auth URL**: + * **Auth URL**: * `https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2F<_your-sharepoint-tenant-url-without-https_>` * Replace `your-sharepoint-tenant-url-without-https` with your tenant url without the **https** prefix. * **Access Token URL**: `https://login.microsoftonline.com/common/oauth2/token` @@ -338,15 +296,12 @@ Postman makes it really simple to work with APIs. The first step is to configure * **Token name**: sp_webhooks_token * **Grant type**: Authorization Code -6. Select the **Request Token** to sign in, consent, and get the token for the session. - -7. When the token is successfully retrieved, you should see **access\_token** variable added to the **Authorization** tab. - -8. Select the option to **Add token to header**. - -9. Double-click the **access\_token** variable to add the token to the header for the request. +1. Select the **Request Token** to sign in, consent, and get the token for the session. +1. When the token is successfully retrieved, you should see **access\_token** variable added to the **Authorization** tab. +1. Select the option to **Add token to header**. +1. Double-click the **access\_token** variable to add the token to the header for the request. - ![Postman get new access token](../../images/postman-get-new-access-token.png) + ![Postman get new access token](../../images/postman-get-new-access-token.png) ### Get Documents list Id @@ -354,174 +309,158 @@ You need to manage webhooks for the default document library, which is provision 1. Enter the following request URL: - ``` - https://site-collection/_api/web/lists/getbytitle('Documents')?$select=Title,Id - ``` + ```http + https://site-collection/_api/web/lists/getbytitle('Documents')?$select=Title,Id + ``` -2. Replace _site-collection_ with your site collection. - - Postman executes your request and if successful, you should see the result. +1. Replace _site-collection_ with your site collection. -3. Copy the **Id** from the results. Later you will use the **Id** to make webhook requests. + Postman executes your request and if successful, you should see the result. + +1. Copy the **Id** from the results. Later you will use the **Id** to make webhook requests. ### Add webhook subscription Now that you have the required information, construct the query and the request to add a webhook subscription. Use the request editor for the following steps: 1. Change the request to **POST** from **GET**. - -2. Enter the following as the request URL: - - ``` - https://site-collection/_api/web/lists('list-id')/subscriptions - ``` - -3. Replace _site-collection_ with your site collection. - -4. Go to the **Headers** tab. - -5. Make sure you still have the **Authorization** header. If not, you need to request a new access token. - -6. Add the following header **key** > **value** pairs: - * Accept > application/json;odata=nometadata - * Content-Type > application/json - -7. Go to the **Body** tab and select **raw** format. - -8. Paste the following JSON as the body: - - ```json - { - "resource": "https://site-collection/_api/web/lists('list-id')", - "notificationUrl": "https://ngrok-forwarding-address/api/spwebhook/handlerequest", - "expirationDateTime": "2016-10-27T16:17:57+00:00", - "clientState": "A0A354EC-97D4-4D83-9DDB-144077ADB449" - } - ``` - -
- - ![postman add webhook body](../../images/postman-add-webhook-body.png) - -9. Make sure the **expirationDateTime** is at most 6 months from today. - -10. Make sure you are debugging the webhook receiver as in Step 4. - -11. Select **Send** to execute the request. - - If the request is successful, you should see the response from SharePoint that provides the subscription details. The following example shows a response for a newly created subscription: - - ```json - { - "clientState": "A0A354EC-97D4-4D83-9DDB-144077ADB449", - "expirationDateTime": "2016-10-27T16:17:57Z", - "id": "32b95d9-4d20-4a17-bfa3-2957cb38ead8", - "notificationUrl": "https://85557d4b.ngrok.io/api/spwebhook/handlerequest", - "resource": "c34420f9-2ad7-4e54-94c9-b67798d2299b" - } - ``` - -12. Copy the subscription **id**. You will need it for the next set of requests. - -13. Go to the webhook receiver project in Visual Studio and examine the **Output** window. You should see the trace logs that look similar to the following trace, along with other messages: - - ``` - iisexpress.exe Information: 0 : Message='Received client state: A0A354EC-97D4-4D83-9DDB-144077ADB449' - iisexpress.exe Information: 0 : Message='Received validation token: daf2803c-43cf-44c7-8dff-7066eaa40f13' - ``` - - The trace indicates that the webhook received initially received a validation request. If you look at the code, you'll see that it returns the validation token immediately so that SharePoint can validate the request: - - ```cs - if (queryStringParams.AllKeys.Contains("validationtoken")) - { - httpResponse = new HttpResponseMessage(HttpStatusCode.OK); - validationToken = queryStringParams.GetValues("validationtoken")[0].ToString(); - httpResponse.Content = new StringContent(validationToken); - - traceWriter.Trace(Request, "SPWebhooks", - TraceLevel.Info, - string.Format("Received validation token: {0}", validationToken)); - return httpResponse; - } - ``` +1. Enter the following as the request URL: + + ```http + https://site-collection/_api/web/lists('list-id')/subscriptions + ``` + +1. Replace _site-collection_ with your site collection. +1. Go to the **Headers** tab. +1. Make sure you still have the **Authorization** header. If not, you need to request a new access token. +1. Add the following header **key** > **value** pairs: + + * **Accept**: `application/json;odata=nometadata` + * **Content-Type**: `application/json` + +1. Go to the **Body** tab and select **raw** format. +1. Paste the following JSON as the body: + + ```json + { + "resource": "https://site-collection/_api/web/lists('list-id')", + "notificationUrl": "https://ngrok-forwarding-address/api/spwebhook/handlerequest", + "expirationDateTime": "2016-10-27T16:17:57+00:00", + "clientState": "A0A354EC-97D4-4D83-9DDB-144077ADB449" + } + ``` + + ![postman add webhook body](../../images/postman-add-webhook-body.png) + +1. Make sure the **expirationDateTime** is at most 6 months from today. +1. Make sure you are debugging the webhook receiver as in Step 4. +1. Select **Send** to execute the request. + + If the request is successful, you should see the response from SharePoint that provides the subscription details. The following example shows a response for a newly created subscription: + + ```json + { + "clientState": "A0A354EC-97D4-4D83-9DDB-144077ADB449", + "expirationDateTime": "2016-10-27T16:17:57Z", + "id": "32b95d9-4d20-4a17-bfa3-2957cb38ead8", + "notificationUrl": "https://85557d4b.ngrok.io/api/spwebhook/handlerequest", + "resource": "c34420f9-2ad7-4e54-94c9-b67798d2299b" + } + ``` + +1. Copy the subscription **id**. You will need it for the next set of requests. +1. Go to the webhook receiver project in Visual Studio and examine the **Output** window. You should see the trace logs that look similar to the following trace, along with other messages: + + ```console + iisexpress.exe Information: 0 : Message='Received client state: A0A354EC-97D4-4D83-9DDB-144077ADB449' + iisexpress.exe Information: 0 : Message='Received validation token: daf2803c-43cf-44c7-8dff-7066eaa40f13' + ``` + + The trace indicates that the webhook received initially received a validation request. If you look at the code, you'll see that it returns the validation token immediately so that SharePoint can validate the request: + + ```csharp + if (queryStringParams.AllKeys.Contains("validationtoken")) + { + httpResponse = new HttpResponseMessage(HttpStatusCode.OK); + validationToken = queryStringParams.GetValues("validationtoken")[0].ToString(); + httpResponse.Content = new StringContent(validationToken); + + traceWriter.Trace(Request, "SPWebhooks", + TraceLevel.Info, + string.Format("Received validation token: {0}", validationToken)); + return httpResponse; + } + ``` ## Step 6: Get subscription details Now you'll run queries in Postman to get the subscription details. 1. Open the Postman client. +1. Change the request to **GET** from **POST**. +1. Enter the following as the request: -2. Change the request to **GET** from **POST**. - -3. Enter the following as the request: - - ``` - https://site-collection/_api/web/lists('list-id')/subscriptions - ``` - -4. Replace _site-collection_ with your site collection. + ```http + https://site-collection/_api/web/lists('list-id')/subscriptions + ``` -5. Select **Send** to execute the request. +1. Replace _site-collection_ with your site collection. +1. Select **Send** to execute the request. - If successful, you should see SharePoint return the subscriptions for this list resource. Because we just added one, you should at least see one subscription returned. The following example shows a response with one subscription: + If successful, you should see SharePoint return the subscriptions for this list resource. Because we just added one, you should at least see one subscription returned. The following example shows a response with one subscription: - ```json - { - "value": [ - { - "clientState": "A0A354EC-97D4-4D83-9DDB-144077ADB449", - "expirationDateTime": "2016-10-27T16:17:57Z", - "id": "32b95add-4d20-4a17-bfa3-2957cb38ead8", - "notificationUrl": "https://85557d4b.ngrok.io/api/spwebhook/handlerequest", - "resource": "c34420f9-2a67-4e54-94c9-b67798229f9b" - } - ] - } - ``` + ```json + { + "value": [ + { + "clientState": "A0A354EC-97D4-4D83-9DDB-144077ADB449", + "expirationDateTime": "2016-10-27T16:17:57Z", + "id": "32b95add-4d20-4a17-bfa3-2957cb38ead8", + "notificationUrl": "https://85557d4b.ngrok.io/api/spwebhook/handlerequest", + "resource": "c34420f9-2a67-4e54-94c9-b67798229f9b" + } + ] + } + ``` -6. Run the following query to get details of the specific subscription: +1. Run the following query to get details of the specific subscription: - ``` - https://site-collection/_api/web/lists('list-id')/subscriptions('subscription-id') - ``` + ```http + https://site-collection/_api/web/lists('list-id')/subscriptions('subscription-id') + ``` -7. Replace `subscription-id` with your subscription id. +1. Replace `subscription-id` with your subscription id. ## Step 7: Test webhook notification Now add a file to the Documents library and test if you get a notification from SharePoint in the webhook receiver. 1. Go to Visual Studio. +1. In the **SPWebhookController**, place a breakpoint on the following line of code: -2. In the **SPWebhookController**, place a breakpoint on the following line of code: - - ```cs - var requestContent = Request.Content.ReadAsStringAsync().Result; - ``` - -3. Go to the **Documents** library. It is named **Shared Documents** library in your default site collection. - -4. Add a new file. - -5. Go to Visual Studio and wait for the breakpoint to be hit. + ```csharp + var requestContent = Request.Content.ReadAsStringAsync().Result; + ``` - The wait time may vary from a few seconds to up to five minutes. When the breakpoint is hit, the webhook receiver has just received a notification from SharePoint. +1. Go to the **Documents** library. It is named **Shared Documents** library in your default site collection. +1. Add a new file. +1. Go to Visual Studio and wait for the breakpoint to be hit. -6. Select **F5** to continue. + The wait time may vary from a few seconds to up to five minutes. When the breakpoint is hit, the webhook receiver has just received a notification from SharePoint. -7. To see the notification data, look in the **Output** window for the following entries, since you added the notification data into the trace log: +1. Select **F5** to continue. +1. To see the notification data, look in the **Output** window for the following entries, since you added the notification data into the trace log: - ``` - iisexpress.exe Information: 0 : Message='Resource: c34420f9-2a67-4e54-94c9-b6770892299b' - iisexpress.exe Information: 0 : Message='SubscriptionId: 32b95ad9-4d20-4a17-bfa3-2957cb38ead8' - iisexpress.exe Information: 0 : Message='TenantId: 7a17cb7d-6898-423f-8839-45f363076f06' - iisexpress.exe Information: 0 : Message='SiteUrl: /' - iisexpress.exe Information: 0 : Message='WebId: 62b80e0b-f889-4974-a519-cc138413be40' - iisexpress.exe Information: 0 : Message='ExpirationDateTime: 2016-10-27T16:17:57.0000000Z' - ``` + ```console + iisexpress.exe Information: 0 : Message='Resource: c34420f9-2a67-4e54-94c9-b6770892299b' + iisexpress.exe Information: 0 : Message='SubscriptionId: 32b95ad9-4d20-4a17-bfa3-2957cb38ead8' + iisexpress.exe Information: 0 : Message='TenantId: 7a17cb7d-6898-423f-8839-45f363076f06' + iisexpress.exe Information: 0 : Message='SiteUrl: /' + iisexpress.exe Information: 0 : Message='WebId: 62b80e0b-f889-4974-a519-cc138413be40' + iisexpress.exe Information: 0 : Message='ExpirationDateTime: 2016-10-27T16:17:57.0000000Z' + ``` -This project only writes the information to the trace log. However, in your receiver, you send this information into a table or a queue that can process the received data to get information from SharePoint. +This project only writes the information to the trace log. However, in your receiver, you send this information into a table or a queue that can process the received data to get information from SharePoint. With this data, you can construct the URL and use the [GetChanges](https://msdn.microsoft.com/library/office/dn531433.aspx#bk_ListGetChanges) API to get the latest changes. diff --git a/docs/apis/webhooks/lists/create-subscription.md b/docs/apis/webhooks/lists/create-subscription.md index 065537129..bab6f9320 100644 --- a/docs/apis/webhooks/lists/create-subscription.md +++ b/docs/apis/webhooks/lists/create-subscription.md @@ -1,15 +1,12 @@ --- title: Create a new subscription description: Creates a new webhook subscription on a SharePoint list. -ms.date: 02/08/2018 -ms.prod: sharepoint -localization_priority: Priority +ms.date: 10/20/2020 +ms.localizationpriority: high --- +# Create a new subscription - -# Create a new subscription - -Creates a new webhook subscription on a SharePoint list. +Creates a new webhook subscription on a SharePoint list. ## Permissions @@ -19,7 +16,7 @@ The application must have at least edit permissions to the SharePoint list where You must grant the Azure AD app the permissions specified in the following table: -Application | Permission +Application | Permission ------------|------------ Office 365 SharePoint Online|Read and write items and lists in all site collections. @@ -27,13 +24,13 @@ Office 365 SharePoint Online|Read and write items and lists in all site collecti You must grant the SharePoint Add-in the following permission(s) or higher: -Scope | Permission rights +Scope | Permission rights ------|------------ List|Manage ## HTTP request -``` +```http POST /_api/web/lists('list-id')/subscriptions ``` @@ -41,7 +38,7 @@ POST /_api/web/lists('list-id')/subscriptions Include the following properties in the request body. -Name | Type | Description +Name | Type | Description -----|------|------------ resource|string|The URL of the list to receive notifications from. notificationUrl|string|The service URL to send notifications to. @@ -75,7 +72,7 @@ Content-Type: application/json { "id": "a8e6d5e6-9f7f-497a-b97f-8ffe8f559dc7", - "expirationDateTime": "2016-04-27T16:17:57Z", + "expirationDateTime": "2016-04-27T16:17:57Z", "notificationUrl": "https://91e383a5.ngrok.io/api/webhook/handlerequest", "resource": "5c77031a-9621-4dfc-bb5d-57803a94e91d" } @@ -83,9 +80,16 @@ Content-Type: application/json ## URL validation -Before a new subscription is created, SharePoint sends a request with a validation token in the body of the request to the service URL provided. Your service must respond to this request by returning the validation token. +> [!IMPORTANT] +> Before a new subscription is created, SharePoint sends a request with a validation token in the querystring of the request to the notification URL provided. Your service must respond to this request by returning the validation token. If your service fails to validate the request in this way, the subscription is not created.** -If your service fails to validate the request in this way, the subscription is not created. +### Example + +```csharp +{ + return new OkObjectResult(req.Query["validationtoken"].ToString()); +} +``` ## See also diff --git a/docs/apis/webhooks/lists/delete-subscription.md b/docs/apis/webhooks/lists/delete-subscription.md index 5d60d8a5b..397d90237 100644 --- a/docs/apis/webhooks/lists/delete-subscription.md +++ b/docs/apis/webhooks/lists/delete-subscription.md @@ -1,12 +1,9 @@ --- title: Delete a subscription description: Deletes a webhook subscription from a SharePoint list. After deleting the subscription, notifications are no longer delivered. -ms.date: 02/08/2018 -ms.prod: sharepoint -localization_priority: Normal +ms.date: 09/23/2022 +ms.localizationpriority: medium --- - - # Delete a subscription Deletes a webhook subscription from a SharePoint list. After deleting the subscription, notifications are no longer delivered. @@ -19,7 +16,7 @@ The application must have at least edit permissions to the SharePoint list where You must grant the Azure AD app the permissions specified in the following table. A subscription can only be deleted by the Azure AD application that created it. -Application | Permission +Application | Permission ------------|------------ Office 365 SharePoint Online|Read and write items and lists in all site collections. @@ -27,7 +24,7 @@ Office 365 SharePoint Online|Read and write items and lists in all site collecti You must grant the SharePoint Add-in the following permission(s) or higher. A subscription can only be deleted by the SharePoint Add-in that created it. -Scope | Permission rights +Scope | Permission rights ------|------------ List|Manage diff --git a/docs/apis/webhooks/lists/get-subscription.md b/docs/apis/webhooks/lists/get-subscription.md index bb0f36b52..661e9076e 100644 --- a/docs/apis/webhooks/lists/get-subscription.md +++ b/docs/apis/webhooks/lists/get-subscription.md @@ -1,12 +1,9 @@ --- title: Get subscriptions description: Gets one or more webhook subscriptions on a SharePoint list. -ms.date: 02/08/2018 -ms.prod: sharepoint -localization_priority: Normal +ms.date: 09/23/2022 +ms.localizationpriority: medium --- - - # Get subscriptions Gets one or more webhook subscriptions on a SharePoint list. @@ -19,17 +16,17 @@ The application must have at least edit permissions to the SharePoint list where #### If your application is a Microsoft Azure Active Directory (Azure AD) application -You must grant the Azure AD application the permissions specified in the following table. A subscription can only be retrieved by the Azure AD application that created it. +You must grant the Azure AD application the permissions specified in the following table. A subscription can only be retrieved by the Azure AD application that created it. -Application | Permission +Application | Permission ------------|------------ Office 365 SharePoint Online|Read and write items and lists in all site collections. #### If your application is a SharePoint Add-in -You must grant the SharePoint Add-in the following permission(s) or higher. A subscription can only be retrieved by the SharePoint Add-in that created it. +You must grant the SharePoint Add-in the following permission(s) or higher. A subscription can only be retrieved by the SharePoint Add-in that created it. -Scope | Permission rights +Scope | Permission rights ------|------------ List|Manage @@ -39,17 +36,17 @@ The application must have manage list permissions to the SharePoint list where t #### If your application is an Azure AD application -You must grant the Azure AD app the permissions specified in the following table. +You must grant the Azure AD app the permissions specified in the following table. -Application | Permission +Application | Permission ------------|------------ Office 365 SharePoint Online|Have full control of all site collections. #### If your application is a SharePoint Add-in -You must grant the SharePoint Add-in the following permission(s) or higher. +You must grant the SharePoint Add-in the following permission(s) or higher. -Scope | Permission rights +Scope | Permission rights ------|------------ List|Full control @@ -111,7 +108,7 @@ Do not supply a request body for this method. #### Response -This returns a collection of all subscriptions on a SharePoint resource. +This returns a collection of all subscriptions on a SharePoint resource. ```http HTTP/1.1 200 OK diff --git a/docs/apis/webhooks/lists/overview-sharepoint-list-webhooks.md b/docs/apis/webhooks/lists/overview-sharepoint-list-webhooks.md index 0aeab4115..f8d775112 100644 --- a/docs/apis/webhooks/lists/overview-sharepoint-list-webhooks.md +++ b/docs/apis/webhooks/lists/overview-sharepoint-list-webhooks.md @@ -1,19 +1,16 @@ --- title: SharePoint list webhooks description: List webhooks cover the events corresponding to list item changes for a given SharePoint list or a document library. -ms.date: 02/08/2018 -ms.prod: sharepoint -localization_priority: Priority +ms.date: 09/23/2022 +ms.localizationpriority: high --- - - # SharePoint list webhooks The SharePoint list webhooks cover the events corresponding to list item changes for a given SharePoint list or a document library. SharePoint webhooks provide a simple notification pipeline so your application can be aware of changes to a SharePoint list without polling the service. ## Tasks -| Task | HTTP method | +| Task | HTTP method | |-----------------------------------------------------|--------------------------------------------------------| | [Create a new subscription](./create-subscription.md) | `POST /_api/web/lists('list-guid')/subscriptions` | | [Get subscriptions](./get-subscription.md) | `GET /_api/web/lists('list-guid')/subscriptions` | diff --git a/docs/apis/webhooks/lists/update-subscription.md b/docs/apis/webhooks/lists/update-subscription.md index 2b1673568..6ba4aa7a7 100644 --- a/docs/apis/webhooks/lists/update-subscription.md +++ b/docs/apis/webhooks/lists/update-subscription.md @@ -1,33 +1,30 @@ --- title: Update a subscription description: Updates a webhook subscription on a SharePoint list. -ms.date: 02/08/2018 -ms.prod: sharepoint -localization_priority: Normal +ms.date: 09/23/2022 +ms.localizationpriority: medium --- - - # Update a subscription Updates a webhook subscription on a SharePoint list. ## Permissions -The application must have at least edit permissions to the SharePoint list where the subscription will be updated. +The application must have at least edit permissions to the SharePoint list where the subscription will be updated. ### If your application is a Microsoft Azure Active Directory (Azure AD) application You must grant the Azure AD application the permissions specified in the following table. A subscription can only be updated by the Azure AD application that created it. -Application | Permission +Application | Permission ------------|------------ -Office 365 SharePoint Online|Read and write items and lists in all site collections. +Office 365 SharePoint Online|Read and write items and lists in all site collections. ### If your application is a SharePoint Add-in You must grant the SharePoint Add-in the following permission(s) or higher. A subscription can only be updated by the SharePoint Add-in that created it. -Scope | Permission rights +Scope | Permission rights ------|------------ List|Manage @@ -53,11 +50,11 @@ Content-Type: application/json Include the following properties in the request body. -Name | Type | Description +Name | Type | Description -----|------|------------ notificationUrl|string|The service URL to send notifications to. expirationDateTime|date|The date the notification will expire and be deleted. -client-clientState|string|Optional. Opaque string passed back to the client on all notifications.
You can use this for validating notifications or tagging different subscriptions. +clientState|string|Optional. Opaque string passed back to the client on all notifications.
You can use this for validating notifications or tagging different subscriptions. ## Response diff --git a/docs/apis/webhooks/overview-sharepoint-webhooks.md b/docs/apis/webhooks/overview-sharepoint-webhooks.md index ef2ba04a2..190a3a4ea 100644 --- a/docs/apis/webhooks/overview-sharepoint-webhooks.md +++ b/docs/apis/webhooks/overview-sharepoint-webhooks.md @@ -1,27 +1,24 @@ --- title: Overview of SharePoint webhooks description: Build applications that subscribe to receive notifications on specific events that occur in SharePoint. -ms.date: 02/08/2018 -ms.prod: sharepoint -localization_priority: Priority +ms.date: 09/23/2022 +ms.localizationpriority: high --- - - # Overview of SharePoint webhooks SharePoint webhooks enable developers to build applications that subscribe to receive notifications on specific events that occur in SharePoint. When an event is triggered, SharePoint sends an HTTP POST payload to the subscriber. Webhooks are easier to develop and consume than Windows Communication Foundation (WCF) services used by SharePoint Add-in remote event receivers because webhooks are regular HTTP services (web API). -Currently webhooks are only enabled for SharePoint list items. SharePoint list item webhooks cover the events corresponding to list item changes for a given SharePoint list or a document library. SharePoint webhooks provide a simple notification pipeline so that your application can be aware of changes to a SharePoint list without polling the service. For more information, see [SharePoint list webhooks](./lists/overview-sharepoint-list-webhooks.md). +Currently webhooks are only enabled for SharePoint list items. SharePoint list item webhooks cover the events corresponding to list item changes for a given SharePoint list or a document library. SharePoint webhooks provide a simple notification pipeline so that your application can be aware of changes to a SharePoint list without polling the service. For more information, see [SharePoint list webhooks](./lists/overview-sharepoint-list-webhooks.md). ## Creating webhooks -To create a new SharePoint webhook, you add a new subscription to the specific SharePoint resource, such as a SharePoint list. +To create a new SharePoint webhook, you add a new subscription to the specific SharePoint resource, such as a SharePoint list. The following information is required for creating a new subscription: - **Resource**. The resource endpoint URL you are creating the subscription for. For example, a SharePoint List API URL. - **Server notification URL**. Your service endpoint URL. SharePoint sends an HTTP POST to this endpoint when events occur in the specified resource. -- **Expiration date**. The expiration date for your subscription. The expiration date should not be more than 180 days. By default, subscriptions are set to expire 180 days from when they are created. +- **Expiration date**. The expiration date for your subscription. The expiration date should not be more than 180 days. By default, subscriptions are set to expire 180 days from when they are created. You can also include the following information if needed: @@ -145,9 +142,9 @@ If an error occurs while sending the notification to your application, SharePoin ## Expiration -Webhook subscriptions are set to expire after 180 days by default if an **expirationDateTime** value is not specified. +Webhook subscriptions are set to expire after 180 days by default if an **expirationDateTime** value is not specified. -You need to set an expiration date when creating the subscription. The expiration date should be less than 180 days. Your application is expected to handle the expiration date according to your application's needs by updating the subscription periodically. +You need to set an expiration date when creating the subscription. The expiration date should be less than 180 days. Your application is expected to handle the expiration date according to your application's needs by updating the subscription periodically. ## Retry mechanism diff --git a/docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md b/docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md new file mode 100644 index 000000000..1de5d665e --- /dev/null +++ b/docs/apis/webhooks/sharepoint-webhooks-using-azd-template.md @@ -0,0 +1,178 @@ +--- +title: Create Azure Functions for SharePoint webhooks using an azd template +description: Use Azure Developer cli (azd) to deploy an Azure function app that connects to your SharePoint Online + tenant, to register and manage webhooks, and process the notifications from SharePoint. +ms.date: 07/07/2025 +ms.localizationpriority: low +--- +# Azure Functions for SharePoint webhooks using azd + +[Azure Developer CLI (azd)](https://aka.ms/azd) is an open-source tool that accelerates provisioning and deploying app resources in Azure. + +This article uses the [Azure function app for SharePoint webhooks public template](https://github.com/Azure-Samples/azd-functions-sharepoint-webhooks) to deploy an Azure function app that connects to your SharePoint Online tenant, to register and manage [webhooks](overview-sharepoint-webhooks.md), and process the notifications from SharePoint. + +## Prerequisites + +- [Node.js 22](https://www.nodejs.org/) +- [Azure Functions Core Tools](/azure/azure-functions/functions-run-local) +- [Azure Developer CLI (azd)](/azure/developer/azure-developer-cli/install-azd) +- An Azure subscription that trusts the same Microsoft Entra ID directory as the SharePoint tenant + +## Permissions required to provision the resources in Azure + +The account running **azd** must have at least the following roles to successfully provision the resources: + +- Azure role **[Contributor](/azure/role-based-access-control/built-in-roles/privileged#contributor)**: To create all the resources needed +- Azure role **[Role Based Access Control Administrator](/azure/role-based-access-control/built-in-roles/privileged#role-based-access-control-administrator)**: To assign roles (to access the storage account and Application Insights) to the managed identity of the function app + +## Deploy the function app in Azure + +1. Run **azd init** from an empty local (root) folder: + + ```console + azd init --template azd-functions-sharepoint-webhooks + ``` + + Enter an environment name, such as **spofuncs-quickstart** when prompted. In **azd**, the environment is used to maintain a unique deployment context for your app. + +1. Open the file **infra/main.parameters.json**, and set the variables `TenantPrefix` and `siteRelativePath` to match your SharePoint tenant. + + Review the article on [Manage environment variables](/azure/developer/azure-developer-cli/manage-environment-variables) to manage the azd's environment variables. + +1. Finally, run the command **azd up** to build the app, provision the resources in Azure and deploy the app package. + +## Grant the function app access to SharePoint Online + +The authentication to SharePoint is done using `DefaultAzureCredential`, so the credential used depends on whether the function app runs locally, or in Azure. + +If you never heard about `DefaultAzureCredential`, you should familiarize yourself with its concept by referring to the section **Use DefaultAzureCredential for flexibility** in [Credential chains in the Azure Identity client library for JavaScript](/azure/developer/javascript/sdk/authentication/credential-chains). + +### Using its managed identity + +`DefaultAzureCredential` will use a managed identity to authenticate to SharePoint. This may be the existing, system-assigned managed identity of the function app service or a user-assigned managed identity. + +This tutorial assumes the system-assigned managed identity is used. + +#### Grant the SharePoint API permission Sites.Selected to the managed identity + +Navigate to your function app in the [Azure portal](https://portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Web%2Fsites/kind/functionapp) > select **Identity** and note the **Object (principal) ID** of the system-assigned managed identity. + +> [!NOTE] +> In this tutorial, it is **d3e8dc41-94f2-4b0f-82ff-ed03c363f0f8**. + +Then, use one of the scripts below to grant this identity the app-only permission **Sites.Selected** on the SharePoint API: + +> [!IMPORTANT] +> The scripts below require at least the delegated permission [`AppRoleAssignment.ReadWrite.All`](/graph/permissions-reference#approleassignmentreadwriteall) (requires admin consent) + +
+ Using the Microsoft Graph PowerShell SDK + +```powershell +# This script requires the modules Microsoft.Graph.Authentication, Microsoft.Graph.Applications, Microsoft.Graph.Identity.SignIns, which can be installed with the cmdlet Install-Module below: +# Install-Module Microsoft.Graph.Authentication, Microsoft.Graph.Applications, Microsoft.Graph.Identity.SignIns -Scope CurrentUser -Repository PSGallery -Force +Connect-MgGraph -Scope "Application.Read.All", "AppRoleAssignment.ReadWrite.All" +$managedIdentityObjectId = "d3e8dc41-94f2-4b0f-82ff-ed03c363f0f8" # 'Object (principal) ID' of the managed identity +$scopeName = "Sites.Selected" +$resourceAppPrincipalObj = Get-MgServicePrincipal -Filter "displayName eq 'Office 365 SharePoint Online'" # SPO +$targetAppPrincipalAppRole = $resourceAppPrincipalObj.AppRoles | ? Value -eq $scopeName + +$appRoleAssignment = @{ + "principalId" = $managedIdentityObjectId + "resourceId" = $resourceAppPrincipalObj.Id + "appRoleId" = $targetAppPrincipalAppRole.Id +} +New-MgServicePrincipalAppRoleAssignment -ServicePrincipalId $managedIdentityObjectId -BodyParameter $appRoleAssignment | Format-List +``` +
+ +
+ Using az cli in Bash + +```bash +managedIdentityObjectId="d3e8dc41-94f2-4b0f-82ff-ed03c363f0f8" # 'Object (principal) ID' of the managed identity +resourceServicePrincipalId=$(az ad sp list --query '[].[id]' --filter "displayName eq 'Office 365 SharePoint Online'" -o tsv) +resourceServicePrincipalAppRoleId="$(az ad sp show --id $resourceServicePrincipalId --query "appRoles[?starts_with(value, 'Sites.Selected')].[id]" -o tsv)" + +az rest --method POST --uri "https://graph.microsoft.com/v1.0/servicePrincipals/${managedIdentityObjectId}/appRoleAssignments" --headers 'Content-Type=application/json' --body "{ 'principalId': '${managedIdentityObjectId}', 'resourceId': '${resourceServicePrincipalId}', 'appRoleId': '${resourceServicePrincipalAppRoleId}' }" +``` +
+ +#### Grant the managed identity effective access to a SharePoint site + +Navigate to the [Enterprise applications](https://entra.microsoft.com/#view/Microsoft_AAD_IAM/StartboardApplicationsMenuBlade/) > Set the **Application type** filter to **Managed Identities** > select your managed identity and note its **Application ID**. + +> [!NOTE] +> In this tutorial, it is **3150363e-afbe-421f-9785-9d5404c5ae34**. + +Then, use one of the scripts below to grant it the app-only permission **manage** (minimum required to register a webhook) on a specific SharePoint site: + +> [!IMPORTANT] +> The app registration used to run those scripts must have at least the following permissions: +> +> - Delegated permission **Application.ReadWrite.All** in the Graph API (requires admin consent) +> - Delegated permission **AllSites.FullControl** in the SharePoint API (requires admin consent) + +
+ Using PnP PowerShell + +[PnP PowerShell](https://pnp.github.io/powershell/cmdlets/Grant-PnPAzureADAppSitePermission.html) + +```powershell +Connect-PnPOnline -Url "https://YOUR_SHAREPOINT_TENANT_PREFIX.sharepoint.com/sites/YOUR_SHAREPOINT_SITE_NAME" -Interactive -ClientId "YOUR_PNP_APP_CLIENT_ID" +Grant-PnPAzureADAppSitePermission -AppId "3150363e-afbe-421f-9785-9d5404c5ae34" -DisplayName "YOUR_FUNC_APP_NAME" -Permissions Manage +``` +
+ +
+ Using m365 cli in Bash + +[m365 cli](https://pnp.github.io/cli-microsoft365/cmd/spo/site/site-apppermission-add/) + +```bash +targetapp="3150363e-afbe-421f-9785-9d5404c5ae34" +siteUrl="https://YOUR_SHAREPOINT_TENANT_PREFIX.sharepoint.com/sites/YOUR_SHAREPOINT_SITE_NAME" +m365 spo site apppermission add --appId $targetapp --permission manage --siteUrl $siteUrl +``` +
+ +## Call the function app + +For security reasons, when running in Azure, the function app requires an app key to pass in the query string parameter **code**. The app keys are found in the function app service's **App Keys** keys page. + +Most HTTP functions take optional parameters `TenantPrefix` and `siteRelativePath`. If they are not specified, the values in the app's environment variables are used. + +Below is a sample script in PowerShell to call the function app: + +```powershell +# Edit those variables to match your environment +$funchost = "YOUR_FUNC_APP_NAME" +$code = "YOUR_HOST_KEY" +$listTitle = "YOUR_SHAREPOINT_LIST" +$notificationUrl = "https://${funchost}.azurewebsites.net/api/webhooks/service?code=${code}" + +# List all the webhooks registered on a list +Invoke-RestMethod -Method GET -Uri "https://${funchost}.azurewebsites.net/api/webhooks/list?code=${code}&listTitle=${listTitle}" + +# Register a webhook in a list +Invoke-RestMethod -Method POST -Uri "https://${funchost}.azurewebsites.net/api/webhooks/register?code=${code}&listTitle=${listTitle}¬ificationUrl=${notificationUrl}" + +# Show this webhook registered on a list +Invoke-RestMethod -Method GET -Uri "https://${funchost}.azurewebsites.net/api/webhooks/show?code=${code}&listTitle=${listTitle}¬ificationUrl=${notificationUrl}" + +# Remove the webhook from a list +# Step 1: Call the function /webhooks/show to get the webhook id +$webhookId = $(Invoke-RestMethod -Method GET -Uri "https://${funchost}.azurewebsites.net/api/webhooks/show?code=${code}&listTitle=${listTitle}¬ificationUrl=${notificationUrl}").Id +# Step 2: Call the function /webhooks/remove and pass the webhook id +Invoke-RestMethod -Method POST -Uri "https://${funchost}.azurewebsites.net/api/webhooks/remove?code=${code}&listTitle=${listTitle}&webhookId=${webhookId}" +``` + +## Cleanup the resources in Azure + +You can delete all the resources this project created in Azure, by running the command **azd down**. + +Alternatively, you can delete the resource group, that has the azd environment's name by default. + +## See also + +- [Overview of SharePoint webhooks](overview-sharepoint-webhooks.md) diff --git a/docs/apis/webhooks/sharepoint-webhooks-using-azure-functions.md b/docs/apis/webhooks/sharepoint-webhooks-using-azure-functions.md index 7ea7c77c0..967d0e43d 100644 --- a/docs/apis/webhooks/sharepoint-webhooks-using-azure-functions.md +++ b/docs/apis/webhooks/sharepoint-webhooks-using-azure-functions.md @@ -1,19 +1,18 @@ --- title: Using Azure Functions with SharePoint webhooks description: Set up and use Azure Functions for your webhooks to take care of the hosting and scaling of your function. -ms.date: 05/09/2020 -ms.prod: sharepoint -localization_priority: Priority +ms.date: 09/23/2022 +ms.localizationpriority: high --- - - # Using Azure Functions with SharePoint webhooks -[Azure Functions](https://docs.microsoft.com/azure/azure-functions/functions-overview) offers an easy way to host your SharePoint webhooks: you can add your webhook C# or JavaScript code via the browser, and Azure takes care of the hosting and scaling of your function. This guide shows how to set up and use Azure Functions for your webhooks. +[Azure Functions](/azure/azure-functions/functions-overview) offers an easy way to host your SharePoint webhooks: you can add your webhook C# or JavaScript code via the browser, and Azure takes care of the hosting and scaling of your function. + +This guide shows how to set up and use Azure Functions for your webhooks using the Azure portal. Alternatively, you can refer to article [Create Azure Functions for SharePoint webhooks using an azd template](sharepoint-webhooks-using-azd-template.md), to automate the whole process using an **azd** template. ## Create an Azure Function App -The first step you need to do is create an Azure Function App, which is a special Azure Web App focused on hosting Azure Functions. +The first step you need to do is to create an Azure Function App, which is a special Azure Web App focused on hosting Azure Functions. 1. Navigate to [https://portal.azure.com](https://portal.azure.com), search for **function app**. Select **Function App** from the search results. @@ -63,7 +62,7 @@ In our case, we want this Azure Function to behave as a SharePoint webhook servi You can achieve this by replacing the default code with the following code: -```cs +```csharp #r "Newtonsoft.Json" using System.Net; @@ -226,7 +225,7 @@ We'll need to let SharePoint know what webhook URL we're using. To do so, let's 1. Click **Get function URL**. - ![Get Function URL Link](../../images/webhook-azure-function07.png) + ![Log message console](../../images/webhook-azure-function07.png) 1. Click **Copy** to copy the Azure Function App URL to your clipboard. diff --git a/docs/apis/webhooks/webhooks-reference-implementation.md b/docs/apis/webhooks/webhooks-reference-implementation.md index c69946a02..f6285aaf7 100644 --- a/docs/apis/webhooks/webhooks-reference-implementation.md +++ b/docs/apis/webhooks/webhooks-reference-implementation.md @@ -1,46 +1,38 @@ --- title: SharePoint webhooks sample reference implementation -description: This SharePoint Patterns and Practices (PnP) reference implementation shows how you can use SharePoint webhooks in your application. -ms.date: 02/08/2018 -ms.prod: sharepoint -localization_priority: Priority +description: This SharePoint Patterns and Practices (PnP) reference implementation shows how you can use SharePoint webhooks in your application. +ms.date: 06/05/2024 +ms.localizationpriority: high --- - - # SharePoint webhooks sample reference implementation The SharePoint Patterns and Practices (PnP) reference implementation shows how you can use SharePoint webhooks in your application. The webhooks are implemented in an enterprise ready manner using various Microsoft Azure components such as Azure Web Jobs, Azure SQL Server, and Azure Storage Queues for asynchronous web job notification handling. -The reference implementation only works with [SharePoint list webhooks](./lists/overview-sharepoint-list-webhooks.md). +The reference implementation only works with [SharePoint list webhooks](./lists/overview-sharepoint-list-webhooks.md). -You can also follow these steps by watching the video on the SharePoint PnP YouTube Channel: - -
+You can also follow these steps by watching the video on the Microsoft 365 Platform Community (PnP) YouTube Channel: > [!Video https://www.youtube.com/embed/P4a1_EWokwM] -
- **Applies to** Office 365 Multi Tenant (MT). -Microsoft Azure is used to host the various components needed to implement Azure webhooks. +Microsoft Azure is used to host the various components needed to implement SharePoint webhooks. + +Source code and other materials for the reference implementation are available in two flavors: -Source code and other materials for the reference implementation are available in two flavors: - A SharePoint provider-hosted application version -- An Office 365 Azure AD application, which can be found in the [SharePoint developer samples GitHub repository](https://aka.ms/sp-webhooks-sample-reference). +- An Office 365 Azure AD application, which can be found in the [SharePoint developer samples GitHub repository](https://aka.ms/sp-webhooks-sample-reference). ## Deploy the reference implementation -The application shows you how to manage webhooks, specifically for a SharePoint list. It also contains a reference implementation of a webhook service endpoint that you can reuse in your webhook projects. +The application shows you how to manage webhooks, specifically for a SharePoint list. It also contains a reference implementation of a webhook service endpoint that you can reuse in your webhook projects. ![SharePoint webhook reference implementation application](../../images/webhook-sample-application.png) ### Deployment guides -- The [SharePoint web hooks reference implementation deployment guide](https://github.com/SharePoint/sp-dev-samples/blob/master/Samples/WebHooks.List/Deployment%20guide.md) lists the deployment steps used to deploy the SharePoint provider-hosted reference implementation. - -- To deploy the Office 365 Azure AD application, use the steps described at [SharePoint web hooks Azure AD reference implementation deployment guide](https://github.com/SharePoint/sp-dev-samples/blob/master/Samples/WebHooks.List.AzureAD/Deployment%20guide.md), which shows you how to use a Web API function as webhook service. - +- The [SharePoint webhooks reference implementation deployment guide](https://github.com/SharePoint/sp-dev-samples/blob/master/Samples/WebHooks.List/Deployment%20guide.md) lists the deployment steps used to deploy the SharePoint provider-hosted reference implementation. +- To deploy the Office 365 Azure AD application, use the steps described at [SharePoint webhooks Azure AD reference implementation deployment guide](https://github.com/SharePoint/sp-dev-samples/blob/master/Samples/WebHooks.List.AzureAD/Deployment%20guide.md), which shows you how to use a Web API function as webhook service. - If you're more interested in using Azure Functions, see the [Azure Functions guide](https://github.com/SharePoint/sp-dev-samples/blob/master/Samples/WebHooks.List.AzureAD/azure%20functions%20guide.md) for more details on how to use Azure Functions in this reference implementation. ### Introduction to webhooks @@ -51,9 +43,9 @@ Webhooks notify your application about changes in SharePoint that the applicatio The reference implementation works with a SharePoint list. To add a webhook to a SharePoint list, your application first creates a webhook subscription by sending a [`POST /_api/web/lists('list-id')/subscriptions`](./lists/create-subscription.md) request. The request includes the following items: -* A payload that identifies the list that you're adding the webhook for. -* The location of your webhook service URL to send the notifications. -* The expiration date of the webhook. +- A payload that identifies the list that you're adding the webhook for. +- The location of your webhook service URL to send the notifications. +- The expiration date of the webhook. After you've requested SharePoint to add your webhook, SharePoint validates that your webhook service endpoint exists. It sends a validation string to your service endpoint. SharePoint expects that your service endpoint returns the validation string within 5 seconds. If this process fails, the webhook creation is canceled. If you've deployed your service, this works and SharePoint returns an HTTP 201 message on the POST request that the application initially sent. The payload in the response contains the ID of the new webhook subscription. @@ -61,7 +53,7 @@ After you've requested SharePoint to add your webhook, SharePoint validates that Take a look at the reference implementation, and you'll see that all webhook CRUD operations are consolidated in the [WebHookManager](https://github.com/SharePoint/sp-dev-samples/blob/master/Samples/WebHooks.List/SharePoint.WebHooks.Common/WebHookManager.cs) class of the **SharePoint.WebHooks.Common** project. Adding a webhook is done by using the **AddListWebHookAsync** method: -```cs +```csharp /// /// This method adds a webhook to a SharePoint list. Note that you need your webhook endpoint being passed into this method to be up and running and reachable from the internet /// @@ -77,11 +69,9 @@ public async Task AddListWebHookAsync(string siteUrl, string } ``` -
- When making a call to SharePoint, you need to provide authentication information, and in this case you're using a **Bearer** authentication header with an **access token**. To obtain the access token, intercept the token via an **ExecutingWebRequest** event handler: -```cs +```csharp ClientContext cc = null; // Create SharePoint ClientContext object... @@ -92,7 +82,7 @@ cc.ExecutingWebRequest += Cc_ExecutingWebRequest; // Capture the OAuth access token since we want to reuse that one in our REST requests private void Cc_ExecutingWebRequest(object sender, WebRequestEventArgs e) { - this.accessToken = e.WebRequestExecutor.RequestHeaders.Get("Authorization").Replace("Bearer ", ""); + this.accessToken = e.WebRequestExecutor.RequestHeaders.Get("Authorization").Replace("Bearer ", ""); } ``` @@ -119,14 +109,13 @@ In the previous step, your service endpoint was called, but SharePoint only prov ![Async GetChanges](../../images/webhook-sample-async-getchanges.png) -You can learn more about the `GetChanges()` implementation in the **ProcessNotification** method in the [ChangeManager](https://github.com/SharePoint/sp-dev-samples/blob/master/Samples/WebHooks.List/SharePoint.WebHooks.Common/ChangeManager.cs) class of the **SharePoint.WebHooks.Common** project. +You can learn more about the `GetChanges()` implementation in the **ProcessNotification** method in the [ChangeManager](https://github.com/SharePoint/sp-dev-samples/blob/master/Samples/WebHooks.List/SharePoint.WebHooks.Common/ChangeManager.cs) class of the **SharePoint.WebHooks.Common** project. To avoid getting the same change repeatedly, it's important that you inform SharePoint from which point you want the changes. This is done by passing a **changeToken**, which also implies that your service endpoint needs to persist the last used **changeToken** so that it can be used the next time the service endpoint is called. The following are some key things to note about changes: - SharePoint does not call your service in real-time: when a change happens on a list that has a webhook, SharePoint queues a webhook callout. Once each minute, this queue is read and the appropriate service endpoints are called. This batching of requests is important. For example, if a bulk upload of 1000 records occurred at once, batching prevents SharePoint from calling your endpoint 1000 times. So your endpoint is only called once, but when you call the `GetChanges()` method, you get 1000 change events that you need to process. - - To guarantee an immediate response, regardless of the number of changes there, it's important that the workload of your service endpoint runs asynchronously. In the reference implementation, we leveraged the power of Azure: the service serializes the incoming payload and stores it in an Azure Storage queue while there's an Azure web job that runs continuously and checks for messages in the queue. When there are messages in the queue, the web job processes them and also executes your logic asynchronously. ## Complete end-to-end flow @@ -136,14 +125,14 @@ The following diagram describes the complete end-to-end webhook flow. ![Webhooks reference implementation end-to-end flow](../../images/webhook-sample-end-to-end-flow.png) 1. Your application creates a webhook subscription. When it does, it gets the current **changeToken** from the list it created the webhook for. -2. Your application persists the **changeToken** in a persistent storage, such as SQL Azure in this case. -3. A change in SharePoint occurs, and SharePoint calls your service endpoint. -4. Your service endpoint serializes the notification request and stores it in a storage queue. -5. Your web job sees the message in the queue and starts your message processing logic. -6. Your message processing logic retrieves the last used change token from the persistent storage. -7. Your message processing logic uses the `GetChanges()`API to determine what changed. -8. The returned changes are processed and now your application performs what it needs to do based on the changes. -9. Finally, the application persists the last retrieved **changeToken** so that next time it does not receive changes that were already processed. +1. Your application persists the **changeToken** in a persistent storage, such as SQL Azure in this case. +1. A change in SharePoint occurs, and SharePoint calls your service endpoint. +1. Your service endpoint serializes the notification request and stores it in a storage queue. +1. Your web job sees the message in the queue and starts your message processing logic. +1. Your message processing logic retrieves the last used change token from the persistent storage. +1. Your message processing logic uses the `GetChanges()`API to determine what changed. +1. The returned changes are processed and now your application performs what it needs to do based on the changes. +1. Finally, the application persists the last retrieved **changeToken** so that next time it does not receive changes that were already processed. ## Work with webhook renewal @@ -155,14 +144,14 @@ When your service receives a notification, it also gets information about the su ### Reliable but more complex model -Create a web job that on a weekly basis reads all the subscription IDs from the persistent storage. One-by-one extend the found subscriptions each time. +Create a web job that on a weekly basis reads all the subscription IDs from the persistent storage. One-by-one extend the found subscriptions each time. > [!NOTE] > This web job is not part of this reference implementation. -The actual renewal of a SharePoint list webhook can be done by using a [`PATCH /_api/web/lists('list-id')/subscriptions(‘subscriptionID’)`](./lists/update-subscription.md) REST call. +The actual renewal of a SharePoint list webhook can be done by using a [`PATCH /_api/web/lists('list-id')/subscriptions(‘subscriptionID’)`](./lists/update-subscription.md) REST call. -In the reference implementation, updating of webhooks is implemented in the [WebHookManager](https://github.com/SharePoint/sp-dev-samples/blob/master/Samples/WebHooks.List/SharePoint.WebHooks.Common/WebHookManager.cs) class of the **SharePoint.WebHooks.Common** project. +In the reference implementation, updating of webhooks is implemented in the [WebHookManager](https://github.com/SharePoint/sp-dev-samples/blob/master/Samples/WebHooks.List/SharePoint.WebHooks.Common/WebHookManager.cs) class of the **SharePoint.WebHooks.Common** project. Updating a webhook is done by using the **UpdateListWebHookAsync** method: @@ -179,7 +168,7 @@ Updating a webhook is done by using the **UpdateListWebHookAsync** method: /// true if successful, exception in case something went wrong public async Task UpdateListWebHookAsync(string siteUrl, string listId, string subscriptionId, string webHookEndPoint, DateTime expirationDateTime, string accessToken) { - // webhook update code... + // webhook update code... } ``` @@ -187,10 +176,8 @@ public async Task UpdateListWebHookAsync(string siteUrl, string listId, st Because SharePoint is calling out to your webhook service endpoint, your endpoint needs to be reachable by SharePoint. This makes development and debugging slightly more complex. The following are some strategies that you can use to make your life easier: -* During initial development, you provide your own serialized payload to your service processing logic. This makes it possible to completely test your processing logic without deploying the service endpoint (and even without configuring a webhook). - -* If you have access to Azure resources, you can deploy your endpoint to Azure by using a debug build and configuring the Azure App Service for debugging. This allows you to set a remote breakpoint and do remote debugging using Visual Studio. - +- During initial development, you provide your own serialized payload to your service processing logic. This makes it possible to completely test your processing logic without deploying the service endpoint (and even without configuring a webhook). +- If you have access to Azure resources, you can deploy your endpoint to Azure by using a debug build and configuring the Azure App Service for debugging. This allows you to set a remote breakpoint and do remote debugging using Visual Studio. - If you do not want to deploy your service during development time, you need to use a secure tunnel for your service. The idea is that you tell SharePoint that the notification service is located on a shared public endpoint. In the client, you install a component that connects to that shared public service, and whenever a call is made to the public endpoint, the client component is notified and it pushes the payload to your service running on localhost. [ngrok](https://ngrok.com/) is an implementation of such a secure tunnel tool that you can use to debug your webhook service locally. ## See also diff --git a/docs/business-apps/get-started/set-up-sharepoint-site-lists-libraries.md b/docs/business-apps/get-started/set-up-sharepoint-site-lists-libraries.md index fa45843b2..6bdb52272 100644 --- a/docs/business-apps/get-started/set-up-sharepoint-site-lists-libraries.md +++ b/docs/business-apps/get-started/set-up-sharepoint-site-lists-libraries.md @@ -2,8 +2,7 @@ title: Set up your SharePoint site with lists and libraries description: Set up your SharePoint site with lists and libraries ms.date: 6/23/2020 -ms.prod: sharepoint -localization_priority: Priority +ms.localizationpriority: high --- # Set up your SharePoint site with lists and libraries @@ -16,7 +15,7 @@ To use Power Automate and build flows, you need a Microsoft 365 tenant. If you already have an Office 365 tenant, see section **Create Projects list** below. -For step-by-step instructions about how to join the Microsoft 365 Developer Program and sign up and configure your subscription, see the [Office 365 Developer Program documentation](https://docs.microsoft.com/office/developer-program/office-365-developer-program). +For step-by-step instructions about how to join the Microsoft 365 Developer Program and sign up and configure your subscription, see the [Office 365 Developer Program documentation](/office/developer-program/office-365-developer-program). ## Create Projects list diff --git a/docs/business-apps/introduction-to-sharepoint-business-process-integration.md b/docs/business-apps/introduction-to-sharepoint-business-process-integration.md index b3d5adef1..576208048 100644 --- a/docs/business-apps/introduction-to-sharepoint-business-process-integration.md +++ b/docs/business-apps/introduction-to-sharepoint-business-process-integration.md @@ -1,9 +1,9 @@ --- title: Business apps and business process automation description: Business apps and business process automation. -ms.date: 04/30/2020 -ms.prod: sharepoint -localization_priority: Priority +ms.date: 06/28/2022 +ms.service: sharepoint-online +ms.localizationpriority: high --- # Business apps and business process automation @@ -48,4 +48,4 @@ Cross-tool functionality seamlessly moves your data from one operation to anothe ## Next steps * [Get started with Power Automate and SharePoint](./power-automate/get-started/create-your-first-flow.md) -* [Get started with Power Apps and SharePoint](https://docs.microsoft.com/powerapps/maker/canvas-apps/customize-list-form) +* [Get started with Power Apps and SharePoint](/powerapps/maker/canvas-apps/customize-list-form) diff --git a/docs/business-apps/power-apps/get-started/create-your-first-custom-form.md b/docs/business-apps/power-apps/get-started/create-your-first-custom-form.md index 7495c5a0c..0ec652047 100644 --- a/docs/business-apps/power-apps/get-started/create-your-first-custom-form.md +++ b/docs/business-apps/power-apps/get-started/create-your-first-custom-form.md @@ -1,9 +1,8 @@ --- title: Customize a form for a SharePoint list description: Customize a form for a SharePoint list -ms.date: 05/18/2021 -ms.prod: sharepoint -localization_priority: Priority +ms.date: 09/27/2022 +ms.localizationpriority: high --- # Customize a form for a SharePoint list @@ -135,9 +134,3 @@ To hide the **Attachments** field if the project owner is Nestor Wilke, follow t The version of the custom form that appears in SharePoint is the most recently published version. 1. In SharePoint, verify the intended functionality of your app. - -## Next steps - -Congratulations on creating your custom form. - -In the next topic, we will create a standalone app using data from a SharePoint list. diff --git a/docs/business-apps/power-automate/get-started/connect-to-other-services-in-your-flow.md b/docs/business-apps/power-automate/get-started/connect-to-other-services-in-your-flow.md index 82c7fdaef..40d815c10 100644 --- a/docs/business-apps/power-automate/get-started/connect-to-other-services-in-your-flow.md +++ b/docs/business-apps/power-automate/get-started/connect-to-other-services-in-your-flow.md @@ -1,10 +1,10 @@ --- title: Connect your flow to other services description: Connect your flow to 200+ services available in Power Automate, and build an integrated experience to perform actions in the services. -ms.date: 04/30/2020 -ms.prod: sharepoint -localization_priority: Priority -search.app: +ms.date: 09/23/2022 +ms.service: sharepoint-online +ms.localizationpriority: high +search.app: - Flow search.appverid: met150 --- @@ -25,7 +25,7 @@ In this article, we will connect to Microsoft Teams and post a message to one of 1. In your browser, switch to the **flow designer** tab. 1. If you do not have the flow designer tab opened, to open the flow, follow these steps: * Browse to the **Projects** list. - * Select **Automate > Power Automate > See your flows**. + * Select **Integrate** > **Power Automate** > **See your flows**. * If prompted, sign in with your Microsoft 365 account. * In the **My flows** tab, select **Send a customized email when a new SharePoint list item is added** flow. * To edit the flow, in the **flow details** page, in the top command bar, select **Edit**. @@ -73,4 +73,4 @@ In this article, we will connect to Microsoft Teams and post a message to one of ## Next steps -Learn new skills and discover Power Automate with step-by-step guidance by exploring learning paths and modules available here: [Power Automate Learning Paths](https://docs.microsoft.com/learn/browse/?term=Power%20Automate&products=power-automate). +Learn new skills and discover Power Automate with step-by-step guidance by exploring learning paths and modules available here: [Power Automate Learning Paths](/training/browse/?term=Power%20Automate&products=power-automate). diff --git a/docs/business-apps/power-automate/get-started/create-your-first-flow.md b/docs/business-apps/power-automate/get-started/create-your-first-flow.md index 4558afcc2..77b9f7505 100644 --- a/docs/business-apps/power-automate/get-started/create-your-first-flow.md +++ b/docs/business-apps/power-automate/get-started/create-your-first-flow.md @@ -1,10 +1,10 @@ --- title: Send an email when a new item is created or modified in a SharePoint list description: Send an email when a new item is created or modified in a SharePoint list -ms.date: 02/05/2021 -ms.prod: sharepoint -localization_priority: Priority -search.app: +ms.date: 06/28/2022 +ms.service: sharepoint-online +ms.localizationpriority: high +search.app: - Flow search.appverid: met150 --- @@ -22,16 +22,16 @@ Before proceeding with these instructions, make sure your SharePoint site is set ## Create a flow 1. In your SharePoint site, browse to the **Projects** list. -1. To create and manage flows for a list or a library, from the command bar, on the list or library page, select **Automate** > **Power Automate**. Selecting **Power Automate** expands to show you more options: +1. To create and manage flows for a list or a library, from the command bar, on the list or library page, select **Integrate** > **Power Automate**. Selecting **Power Automate** expands to show you more options: * Create a flow * See your flows * Configure flows - > [!NOTE] - > If they are available for the list or library here, you may see other options such as **Set a reminder** and other flows. + ![Create a flow from Projects list](../../../images/lists-integrate-power-automate-create-flow.png) - ![Create a flow from Projects list](../../../images/gs01-create-a-flow-command-bar.png) + > [!NOTE] + > If they are available for the list or library here, you may see other options on the **Automate** menu, such as **Set a reminder** and other flows. 1. Select **Create a flow**. In the **Create a flow** panel, you can explore various templates available for your list. diff --git a/docs/business-apps/power-automate/guidance/customize-page-approvals.md b/docs/business-apps/power-automate/guidance/customize-page-approvals.md index 69edd9f5c..72fe0d715 100644 --- a/docs/business-apps/power-automate/guidance/customize-page-approvals.md +++ b/docs/business-apps/power-automate/guidance/customize-page-approvals.md @@ -1,7 +1,8 @@ --- title: Customize SharePoint page approvals to meet your needs -ms.date: 07/12/2020 -search.app: +description: With the help of flows in Power Automate, you can configure page approval to add to the standard publishing process for a site. The default publishing flow meets your basic needs. +ms.date: 06/28/2022 +search.app: - Flow search.appverid: met150 --- @@ -42,6 +43,4 @@ Occasionally, the default approval action may not help in tracking and auditing ![Parallel approvals in flow](../../../images/parallel-approvals-in-flow.png) -To learn more, see [Create parallel approval workflows with Power Automate](https://docs.microsoft.com/power-automate/parallel-modern-approvals). - - +To learn more, see [Create parallel approval workflows with Power Automate](/power-automate/parallel-modern-approvals). diff --git a/docs/business-apps/power-automate/guidance/manage-list-flows.md b/docs/business-apps/power-automate/guidance/manage-list-flows.md index e83bd78b1..52416dbef 100644 --- a/docs/business-apps/power-automate/guidance/manage-list-flows.md +++ b/docs/business-apps/power-automate/guidance/manage-list-flows.md @@ -1,12 +1,13 @@ --- -title: Manage owners and users in your SharePoint list flows with Power Automate -ms.date: 05/19/2020 -search.app: +title: Manage owners and users in your Microsoft list flows with Power Automate +description: Manage owners and users of your Power Automate flows for Microsoft lists. You can see all users of a flow, add new users or owners, and modify existing users or owners. +ms.date: 06/28/2022 +search.app: - Flow search.appverid: met150 --- -# Manage owners and users in your SharePoint list flows with Power Automate +# Manage owners and users in your Microsoft list flows with Power Automate Flows in Power Automate let you share your flows with others as owners or run-only users. Owners can modify flows, whereas run-only users can run or execute flows. Users' ability to run flows depends entirely on the trigger, specifically: @@ -23,7 +24,7 @@ Now you can add people as owners to that flow. Select the **Users and groups** t ![Add owners to flow](../../../images/add-owners-flow.png) -You can also add the SharePoint list as owners. This means that users who have edit permissions on that list automatically get owner access to the flow. This is a simple way to manage list flows as it helps you to easily share it with your team. +You can also add the Microsoft list as owners. This means that users who have edit permissions on that list automatically get owner access to the flow. This is a simple way to manage list flows as it helps you to easily share it with your team. Select the **SharePoint** tab, select the **Site** from the dropdown, and then select the **list** from the dropdown. The site and list values depend on the trigger and actions you use in your flow. The appropriate sites and lists appear and are available for selection. @@ -39,7 +40,7 @@ For triggers that support run-only users, below the **Owners** card, a **Manage ![Manage run-only users card dropdown](../../../images/manage-run-only-users-card.png) -Here, you can manage the run-only users or assign the users of the SharePoint list as run-only users. This means users who have read permissions to that list can run flows. +Here, you can manage the run-only users or assign the users of the Microsoft list as run-only users. In order to run flows, users must have Edit Permissions on the list. Learn more about [list permissions and permission levels](/sharepoint/understanding-permission-levels#list-permissions-and-permission-levels). ![Manage run-only permissions](../../../images/manage-run-only-permissions.png) diff --git a/docs/business-apps/power-automate/guidance/manage-list-item-file-permissions.md b/docs/business-apps/power-automate/guidance/manage-list-item-file-permissions.md index f848aadf4..2a5f77c7d 100644 --- a/docs/business-apps/power-automate/guidance/manage-list-item-file-permissions.md +++ b/docs/business-apps/power-automate/guidance/manage-list-item-file-permissions.md @@ -1,13 +1,16 @@ --- title: Manage list item and file permissions with Power Automate -ms.date: 07/16/2020 -search.app: +description: "SharePoint connector in Power Automate lets you grant access, create sharing links, or rescind access for items or folders." +ms.date: 12/01/2022 +search.app: - Flow search.appverid: met150 --- # Manage list item and file permissions with Power Automate flows -SharePoint connector in Power Automate provides the following actions to manage permissions of an individual list item in a list or a file in a document library. + +SharePoint connector in Power Automate provides the following actions to manage permissions of an individual list item in a list or a file in a document library. + - Grant access to an item or a folder - Create sharing link for a file or folder - Stop sharing an item or a file @@ -15,7 +18,9 @@ SharePoint connector in Power Automate provides the following actions to manage All of the above actions let you customize permissions for the item or a file to allow the right users to access that item or the file. To grant access or stop sharing, you will need to be a list owner of that list or library. That means, in your flow for these actions, you must connect to the list or library using a list owner user account. ## Grant access to an item or a folder + The 'Grant access to an item or a folder' action requires the following inputs: + - SharePoint site URL - List or library name or identifier - The item or the file identifier for which to grant access @@ -24,22 +29,26 @@ The 'Grant access to an item or a folder' action requires the following inputs: ![Grant access to an item or a folder](../../../images/grant-access-item-file-action-flow.png) -In the flow action, you can also include a message and choose to notify the recipients once they get access to the item or the file. +In the flow action, you can also include a message and choose to notify the recipients once they get access to the item or the file. > [!NOTE] > 'Grant access to an item or a folder' does not support granting access to external users. ### Choosing a permission role to grant access -Depending on the user, you may want to grant them either access to edit or read. You can choose the right access in the Roles property. + +Depending on the user, you may want to grant them either access to edit or read. You can choose the right access in the Roles property. ![Choose the right role to grant access to an item or a file](../../../images/grant-access-item-file-roles-flow.png) -The permission roles map to [simplified standard SharePoint permission groups](https://docs.microsoft.com/sharepoint/modern-experience-sharing-permissions): +The permission roles map to [simplified standard SharePoint permission groups](/sharepoint/modern-experience-sharing-permissions): + - Members -- Owners +- Visitors ### Using custom-defined roles to grant access + In advanced scenarios where you need to specify a custom-defined permission role, you can do so in the flow action by entering a custom value for the *Roles* property in the following format: + ``` role: ``` @@ -47,23 +56,26 @@ role: ![Use a custom role to grant access to an item or a file](../../../images/grant-access-item-file-custom-role-flow.png) If you want to get the role id for the custom-defined role permission, you can do so by navigating to the SharePoint URL in your web browser and then search for that role. + ``` https:///_api/web/roledefinitions ``` For example: + ``` https://contoso.microsoft.com/teams/itweb/_api/web/roledefinitions ``` -You can find the role Id in the *category* property of an role item. +You can find the role Id in the *category* property of an role item. ![SharePoint site role definitions](../../../images/sp-web-roledefinitions.png) ## Grant access using sharing links -Instead of granting users access to files directly, you can provide access to a specific file using [shareable links](https://docs.microsoft.com/sharepoint/modern-experience-sharing-permissions#sharable-links). -You can use the '[Create sharing link for a file or folder](https://docs.microsoft.com/sharepoint/dev/business-apps/power-automate/sharepoint-connector-actions-triggers#create-sharing-link-for-a-file-or-folder)' action to create shareable links for a given file. +Instead of granting users access to files directly, you can provide access to a specific file using [shareable links](/sharepoint/modern-experience-sharing-permissions#sharable-links). + +You can use the '[Create sharing link for a file or folder](/sharepoint/dev/business-apps/power-automate/sharepoint-connector-actions-triggers#create-sharing-link-for-a-file-or-folder)' action to create shareable links for a given file. > [!NOTE] > 'Create sharing link for a file or folder' only supports files or folders in a document library. List items are not supported yet. @@ -71,17 +83,20 @@ You can use the '[Create sharing link for a file or folder](https://docs.microso ![Create sharing link for a file or folder flow action](../../../images/create-sharing-link-file-action-flow.png) When creating a shareable link using the action, you can specify: + - Link type - - Type of sharing link - view and edit or view only + - Type of sharing link - view and edit or view only - Link scope - Who gets access to the link - anyone with the link, including anonymous or people in your organization ## Stop sharing an item or a file + The 'Stop sharing an item or a file' action requires the following inputs: + - SharePoint site address - List or library name or identifier - The item or the file identifier for which to stop sharing ![Stop sharing an item or a file flow action](../../../images/stop-sharing-item-action-flow.png) -Applying this flow action will reset all permissions except on that item or the file except for site owners. +Applying this flow action will remove all permissions on that item or file except for site owners. diff --git a/docs/business-apps/power-automate/guidance/migrate-from-classic-workflows-to-power-automate-flows.md b/docs/business-apps/power-automate/guidance/migrate-from-classic-workflows-to-power-automate-flows.md index dd69f2b5a..c2a03fc9c 100644 --- a/docs/business-apps/power-automate/guidance/migrate-from-classic-workflows-to-power-automate-flows.md +++ b/docs/business-apps/power-automate/guidance/migrate-from-classic-workflows-to-power-automate-flows.md @@ -1,7 +1,9 @@ --- title: Guidance - Migrate from classic workflows to Power Automate flows in SharePoint -ms.date: 07/21/2020 -search.app: +description: This article specifically provides guidance about how to plan for transitioning from classic SharePoint Workflows to Power Automate flows. +ms.date: 05/12/2023 +ms.service: power-automate +search.app: - Flow search.appverid: met150 --- @@ -22,58 +24,60 @@ This article specifically provides guidance about how to plan for transitioning Classic workflows in SharePoint constitutes two workflow systems namely -- SharePoint 2010 workflow +- SharePoint 2010 workflow ([deprecated in November 2020](https://support.microsoft.com/en-us/office/sharepoint-2010-workflow-retirement-1ca3fff8-9985-410a-85aa-8120f626965f)) - SharePoint 2013 workflow While both workflow systems allow users to build and publish workflows in SharePoint, see the following key differences: - SharePoint 2010 workflows, released along with SharePoint Server 2010, are hosted, and executed in SharePoint workflow runtime. - - SharePoint 2013 workflows, released along with SharePoint Server 2013, are hosted in SharePoint, and executed in Workflow Manager, that runs independently. Users primarily use SharePoint Designer to author and publish workflows in SharePoint, while professional developers, looking to extend and build workflows, use Visual Studio to build and publish workflows in SharePoint. +> [!Important] +> After August 1, 2020, new Microsoft 365 customers can use SharePoint 2013 workflows or Power Automate. However, SharePoint 2013 workflows will follow a similar retirement path in the future, so it's highly recommended to use Power Automate or other supported solutions. If you want to learn more about the SharePoint 2013 workflow usage inside your tenant you can use the [Workflow 2013 Assessment tool](https://aka.ms/microsoft365assessmenttool). This tool will assess your tenant on SharePoint 2013 workflow usage and generates a Power BI report with the findings. + +>[!Note] +>The SharePoint Migration Tool (SPMT) lets you migrate SharePoint Server 2010 out-of-the-box workflows and SharePoint Designer 2010 & 2013 workflows to Power Automate. [Learn more about migrating your SharePoint Server and SharePoint Designer workflows with SPMT.](/sharepointmigration/spmt-workflow-overview) + ## Modern workflows with Power Automate flows Since the release of classic workflows, SharePoint and Microsoft 365 apps have evolved to provide compelling, flexible and more performant experiences. Modern experiences in SharePoint integrate with rest of the Microsoft 365 apps and services driving security, productivity, and collaboration. -[Power Automate](https://docs.microsoft.com/power-automate/getting-started) helps users and businesses to create automated workflows between your favorite apps and services to get notifications, collect data, automate business policies and more. +[Power Automate](/power-automate/getting-started) helps users and businesses to create automated workflows between your favorite apps and services to get notifications, collect data, automate business policies and more. > [!VIDEO https://www.youtube.com/embed/hCuxuUaGC6Y] Using Microsoft Power Automate, SharePoint users can use the SharePoint Connector to create automations for when data changes in a list or a library. Users can build simple to complex workflows such as, but not limited to: - Send an email when a new item is created in a list. - - Start approval when a new file is added in a library. -To create and author flows, users primarily use [Power Automate website](https://flow.microsoft.com/en-us/) while users can also [create flows from within SharePoint](https://support.microsoft.com/office/create-a-flow-for-a-list-or-library-in-sharepoint-or-onedrive-a9c3e03b-0654-46af-a254-20252e580d01?ui=en-us&rs=en-us&ad=us) or using the [Power Automate mobile app](https://docs.microsoft.com/power-automate/mobile-create-flow). +To create and author flows, users primarily use [Power Automate website](https://flow.microsoft.com/) while users can also [create flows from within SharePoint](https://support.microsoft.com/office/create-a-flow-for-a-list-or-library-in-sharepoint-or-onedrive-a9c3e03b-0654-46af-a254-20252e580d01?ui=en-us&rs=en-us&ad=us) or using the [Power Automate mobile app](/power-automate/mobile-create-flow). -To learn more about building workflows using Power Automate in SharePoint, start here: Business apps and Business process [automation in SharePoint](https://docs.microsoft.com/sharepoint/dev/business-apps/introduction-to-sharepoint-business-process-integration). +To learn more about building workflows using Power Automate in SharePoint, start here: Business apps and Business process [Business apps and business process automation](../../introduction-to-sharepoint-business-process-integration.md). ## Pain points in moving between classic workflows in SharePoint and Power Automate flows Many people feel there are significant gaps between SharePoint Designer (classic) workflows and Power Automate flows, but the list is not long. Of course, there are some workarounds you should consider in your planning as you move from classic workflows to Power Automate flows. - -- **30 day run limit for flows** – SharePoint Designer workflows can run endlessly, but flows have a 30 day lifespan. Getting beyond this limitation means your flow will need to call itself in a re-entrant way to restart the clock ticking. -- **HTTP Connector** – If you make calls to SharePoint's REST API, then you can use the ['Send HTTP Request to SharePoint'](../guidance/working-with-send-sp-http-request.md) action available in the SharePoint connector. Flow also has a generic HTTP connector (as an action), but it is a Premium connector. If you use HTTP calls extensively, you may want to create a “service account” user with a Power Automate license and run these flows with that user account. This also will make it easier to manage the set of flows you consider "enterprise" flows. -- **Reusable Flows** – Using some modular thinking, you can create a master flow which a flow per list or library can call to do the heavy lifting. (In some ways this is even preferable, as you can edit a flow which is used in many locations centrally.) Alternatively, you can use flow actions to discover all of the lists or libraries which match some criteria and run the flow on them all on a timer rather than based on events. -- **Workflow history storage** – Flows maintain a history in the context of the flow itself in the Power Automate dashboard. If you need tracking in your sites, you can have the flow log information in a list you create. -- **Impersonation** - In SharePoint 2010 workflows, you can add an impersonation step to act as a different user. This capability is not readily available in flows. -While these pain points do exist, you can see there are workarounds for each of them. +- **30 day run limit for flows** – SharePoint Designer workflows can run endlessly, but flows have a 30 day lifespan. Getting beyond this limitation means your flow will need to call itself in a re-entrant way to restart the clock ticking. Depending on the solution you choose to accomplish this, this may require a Premium Power Automate license. +- **HTTP Connector** – If you make calls to SharePoint's REST API, then you can use the ['Send HTTP Request to SharePoint'](../guidance/working-with-send-sp-http-request.md) action available in the SharePoint connector. Flow also has a generic HTTP connector (as an action), but it is a Premium connector. If you use HTTP calls extensively, you may want to create a “service account” user with a Power Automate license and run these flows with that user account. This also will make it easier to manage the set of flows you consider "enterprise" flows. +- **Reusable Flows** – Using some modular thinking, you can create a master flow which a flow per list or library can call to do the heavy lifting. In some ways this is even preferable, as you can edit a flow which is used in many locations centrally. This will however require a Premium Power Automate license. Alternatively, you can use flow actions to discover all of the lists or libraries which match some criteria and run the flow on them all on a timer rather than based on events. +- **Workflow history storage** – Flows maintain an extensively detailed history in the context of the flow itself in the Power Automate dashboard for the runs that have occured in the last 28 days. If you need tracking in your sites, or keep historical logging longer than 28 days, you can have the flow log information in a list you create. +- **Impersonation** - In SharePoint 2010 workflows, you can add an impersonation step to act as a different user. You could achieve similar functionality by using different user accounts with different (elevated) priviledges for certain actions. Alternatively you can consider using an Azure Active Directory Application registration, assigning it permissions and using that to directly call into the APIs. The latter will require a Premium Power Automate license and requires more manual effort to make the calls. + +While these pain points do exist, you can see there are workarounds for each of them. Do beware that some of these workarounds will require a Power Automate Premium license. Read more about the [license implications](/power-platform/admin/power-automate-licensing/faqs#i-have-multiple-flows-running-under-a-shared-service-account-what-licenses-do-i-need) of doing so and [who will require to have a Premium license](/power-platform/admin/power-automate-licensing/faqs#who-needs-to-purchase-a-premium-license). ## Modern approvals with Power Automate flows Approvals are the most common workflow scenario when it comes to automating business processes in SharePoint. Transitioning to Power Automate flows, approvals can be streamlined for data in SharePoint, Dynamics 365, forms, SQL, and so on. You can create approvals in your workflow, and view sent and received requests in a unified Actions center. Power Automate approvals enable users to customize flows and create approvals for the following types: -- [Single approvals](https://docs.microsoft.com/power-automate/modern-approvals) +- [Single approvals](/power-automate/modern-approvals) +- [Sequential approvals](/power-automate/sequential-modern-approvals) +- [Parallel approvals](/power-automate/parallel-modern-approvals) -- [Sequential approvals](https://docs.microsoft.com/power-automate/sequential-modern-approvals) - -- [Parallel approvals](https://docs.microsoft.com/power-automate/parallel-modern-approvals) - -SharePoint approvals such as [page approvals](https://docs.microsoft.com/sharepoint/dev/business-apps/power-automate/guidance/customize-page-approvals), [document approvals](https://docs.microsoft.com/sharepoint/dev/business-apps/power-automate/guidance/require-doc-approval), and [hub association approvals](https://support.microsoft.com/office/set-up-your-sharepoint-hub-site-e2daed64-658c-4462-aeaf-7d1a92eba098#bkmk_managesiteassociationapprovals) are all integrated and powered by Power Automate flows, providing users the flexibility to customize the business process for each of the approval scenarios. +SharePoint approvals such as [page approvals](customize-page-approvals.md), [document approvals](require-doc-approval.md), and [hub association approvals](https://support.microsoft.com/office/set-up-your-sharepoint-hub-site-e2daed64-658c-4462-aeaf-7d1a92eba098#bkmk_managesiteassociationapprovals) are all integrated and powered by Power Automate flows, providing users the flexibility to customize the business process for each of the approval scenarios. ## Authoring classic workflows and flows @@ -85,147 +89,146 @@ See the following tables that compare the workflow terminologies, triggers, and While the following lists show some of the most common workflow capabilities, Power Automate offers many more features, and is actively updated with new features. We highly recommend visiting the following Power Automate websites for guided learning: -- [SharePoint Power Automate Documentation](https://docs.microsoft.com/sharepoint/dev/business-apps/power-automate/sharepoint-connector-actions-triggers) - -- [Learn Power Automate](https://docs.microsoft.com/learn/browse/?products=power-automate&term=Power%20Automate&terms=Power%20Automate) - -- [Power Automate Documentation](https://docs.microsoft.com/power-automate/?utm_source=flow-sidebar&utm_medium=web) +- [Microsoft SharePoint Connector in Power Automate](../sharepoint-connector-actions-triggers.md) +- [Learn Power Automate](/training/browse/?products=power-automate&term=Power%20Automate&terms=Power%20Automate) +- [Power Automate Documentation](/power-automate) ### Workflow concepts -|Workflow concept |SharePoint workflow |Power Automate | -|:-------|:-------|:--------| -| A condition that causes the workflow to run or execute | Start options and events | Trigger | -| Building blocks that allow users to customize workflow with business logic | Actions | Actions | -| Apply and perform conditional business logic in workflows | Conditions | Conditions (available under Actions) | -| Get additional input from users when running manual workflows | Initiation form | Trigger Inputs | +| Workflow concept | SharePoint workflow | Power Automate | +| :------------------------------------------------------------------------- | :----------------------- | :----------------------------------- | +| A condition that causes the workflow to run or execute | Start options and events | Trigger | +| Building blocks that allow users to customize workflow with business logic | Actions | Actions | +| Apply and perform conditional business logic in workflows | Conditions | Conditions (available under Actions) | +| Get additional input from users when running manual workflows | Initiation form | Trigger Inputs | ### Workflow types -|Workflow type |SharePoint workflow |Power Automate flow | -|:-------|:-------|:--------| -| List workflows | Yes | Yes | -| Library workflows | Yes | Yes | -| Reusable workflows | Yes | Not available | -| Site workflows | Yes | Not available | +| Workflow type | SharePoint workflow | Power Automate flow | +| :----------------- | :------------------ | :------------------ | +| List workflows | Yes | Yes | +| Library workflows | Yes | Yes | +| Reusable workflows | Yes | Not available | +| Site workflows | Yes | Not available | ### SharePoint integrations -|SharePoint integration |SharePoint workflow |Power Automate flow | -|:-------|:-------|:--------| -| Create a custom workflow from a list or library | Yes | Yes, only in Modern Experiences | -| Run or start a custom workflow for an item or a file or a folder | Yes | Yes, only in Modern Experiences | -| Create and respond to standard approval for an item or a file | Yes | Yes | -| Create and respond to classic publishing page approvals | Yes | Not available | -| Create and respond to modern page approvals | Not available | Yes | -| Create and manage Hub Site association approval requests | Not available | Yes | +| SharePoint integration | SharePoint workflow | Power Automate flow | +| :--------------------------------------------------------------- | :------------------ | :------------------------------ | +| Create a custom workflow from a list or library | Yes | Yes, only in Modern Experiences | +| Run or start a custom workflow for an item or a file or a folder | Yes | Yes, only in Modern Experiences | +| Create and respond to standard approval for an item or a file | Yes | Yes | +| Create and respond to classic publishing page approvals | Yes | Not available | +| Create and respond to modern page approvals | Not available | Yes | +| Create and manage Hub Site association approval requests | Not available | Yes | ### List triggers -|List trigger |SharePoint workflow |Power Automate flow | -|:-------|:-------|:--------| -| When an item is created | Yes | Yes | -| When an item is modified | Yes | Yes | -| When an item is created or modified | Not available | Yes | -| Site workflows | Yes | Not available | -| When an item is deleted | Not available | Yes | -| For a selected item | Yes | Yes | +| List trigger | SharePoint workflow | Power Automate flow | +| :---------------------------------- | :------------------ | :------------------ | +| When an item is created | Yes | Yes | +| When an item is modified | Yes | Yes | +| When an item is created or modified | Not available | Yes | +| Site workflows | Yes | Not available | +| When an item is deleted | Not available | Yes | +| For a selected item | Yes | Yes | ### List actions -|List action |SharePoint workflow |Power Automate flow | -|:-------|:-------|:--------| -| Get items | Not available | Yes | -| Create an item | Yes | Yes | -| Update an item | Yes | Yes | -| Delete an item | Yes | Yes | -| Copy a list item | Yes | Yes, by reusing ‘Create an item' action | -| Get attachments | Not available | Yes | -| Get attachment content | Not available | Yes | -| Add attachment | Not available | Yes | -| Delete attachment | Not available | Yes | -| Set field value in current item | Yes | Yes, using ‘Update an item’ action | -| Get changes for an item | No | Yes | +| List action | SharePoint workflow | Power Automate flow | +| :------------------------------ | :------------------ | :-------------------------------------- | +| Get items | Not available | Yes | +| Create an item | Yes | Yes | +| Update an item | Yes | Yes | +| Delete an item | Yes | Yes | +| Copy a list item | Yes | Yes, by reusing ‘Create an item' action | +| Get attachments | Not available | Yes | +| Get attachment content | Not available | Yes | +| Add attachment | Not available | Yes | +| Delete attachment | Not available | Yes | +| Set field value in current item | Yes | Yes, using ‘Update an item’ action | +| Get changes for an item | No | Yes | ### File triggers -|List action |SharePoint workflow |Power Automate flow | -|:-------|:-------|:--------| -| When a file is created | Yes, using List triggers | Yes | -| When a file is created in a folder | Not available | Yes | -| When a file is modified | Yes, using List triggers | Yes | -| When a file is created or modified | Not available | Yes | -| When a file is created or modified in a folder | Not available | Yes | -| When a file is deleted | Not available | Yes | -| For a selected file | Yes, using List triggers | Yes | +| List action | SharePoint workflow | Power Automate flow | +| :--------------------------------------------- | :----------------------- | :------------------ | +| When a file is created | Yes, using List triggers | Yes | +| When a file is created in a folder | Not available | Yes | +| When a file is modified | Yes, using List triggers | Yes | +| When a file is created or modified | Not available | Yes | +| When a file is created or modified in a folder | Not available | Yes | +| When a file is deleted | Not available | Yes | +| For a selected file | Yes, using List triggers | Yes | ### File actions -|File action |SharePoint workflow |Power Automate flow | -|:-------|:-------|:--------| -| Get files | Not available | Yes | -| Create file content | Not available | Yes | -| Get file properties | Not available | Yes | -| Create a file | Not available | Yes | -| Create new folder | Not available | Yes | -| Update file properties | Yes, using List triggers | Yes | -| Delete a file | Yes, using List triggers | Yes | -| Copy file | Not available | Yes | -| Copy folder | Not available | Yes | -| Move file | Not available | Yes | -| Get changes for a file (properties only) | No | Yes | +| File action | SharePoint workflow | Power Automate flow | +| :--------------------------------------- | :----------------------- | :------------------ | +| Get files | Not available | Yes | +| Create file content | Not available | Yes | +| Get file properties | Not available | Yes | +| Create a file | Not available | Yes | +| Create new folder | Not available | Yes | +| Update file properties | Yes, using List triggers | Yes | +| Delete a file | Yes, using List triggers | Yes | +| Copy file | Not available | Yes | +| Copy folder | Not available | Yes | +| Move file | Not available | Yes | +| Get changes for a file (properties only) | No | Yes | ### Document management actions -|Document management action |SharePoint workflow |Power Automate flow | -|:-------|:-------|:--------| -| Check in file | Yes | Yes | -| Check out file | Yes | Yes | -| Discard checkout | Yes | Yes | -| Delete drafts | Yes | Not available | -| Wait for change in document check out status | Yes | Not available | +| Document management action | SharePoint workflow | Power Automate flow | +| :------------------------------------------- | :------------------ | :------------------ | +| Check in file | Yes | Yes | +| Check out file | Yes | Yes | +| Discard checkout | Yes | Yes | +| Delete drafts | Yes | Not available | +| Wait for change in document check out status | Yes | Not available | ### Permissions management actions -|Permissions management action |SharePoint workflow |Power Automate flow | -|:-------|:-------|:--------| -| Grant access to an item or a folder | Yes | Yes | -| Stop sharing an item or a file | Yes | Yes | -| Create sharing link for a file or folder | Not available | Yes | +| Permissions management action | SharePoint workflow | Power Automate flow | +| :--------------------------------------- | :------------------ | :------------------ | +| Grant access to an item or a folder | Yes | Yes | +| Stop sharing an item or a file | Yes | Yes | +| Create sharing link for a file or folder | Not available | Yes | ### Approval actions -|Approval action |SharePoint workflow |Power Automate flow | -|:-------|:-------|:--------| -| Set content approval status of an item or a file or a page | Yes | Yes | -| Create and wait for approval for an item or a file | Yes | Yes | -| Include attachments in approval requests | Not available | Yes | -| Respond to approvals | Yes | Yes | -| Create sequential approvals | Yes | Yes | -| Create parallel approvals | Yes | Yes | -| Cancel approvals | Yes | Yes | -| Reassign approvals | Yes | Yes | -| Custom approval buttons | Yes | Yes | -| Unified approval center | Not available | Yes | +| Approval action | SharePoint workflow | Power Automate flow | +| :--------------------------------------------------------- | :------------------ | :------------------ | +| Set content approval status of an item or a file or a page | Yes | Yes | +| Create and wait for approval for an item or a file | Yes | Yes | +| Include attachments in approval requests | Not available | Yes | +| Respond to approvals | Yes | Yes | +| Create sequential approvals | Yes | Yes | +| Create parallel approvals | Yes | Yes | +| Cancel approvals | Yes | Yes | +| Reassign approvals | Yes | Yes | +| Custom approval buttons | Yes | Yes | +| Unified approval center | Not available | Yes | ### Workflow controls capabilities -|Workflow controls capability |SharePoint workflow |Power Automate flow | -|:-------|:-------|:--------| -| Workflow primitives: Loops, do until, switch-case, parallels | Yes | Yes | -| Workflow stage | Yes | Yes, works only with Modern Permissions | -| Schedule-based flows | Yes | Yes | -| Variables | Yes | Yes | -| Email designer and rich text editor | Not available | Yes | -| Versioning of workflows | Not available | Not available | -| Copy/paste actions |Yes | Yes | +| Workflow controls capability | SharePoint workflow | Power Automate flow | +| :----------------------------------------------------------- | :------------------ | :-------------------------------------- | +| Workflow primitives: Loops, do until, switch-case, parallels | Yes | Yes | +| Workflow stage | Yes | Yes, works only with Modern Permissions | +| Schedule-based flows | Yes | Yes | +| Variables | Yes | Yes | +| Email designer and rich text editor | Not available | Yes | +| Versioning of workflows | Not available | Not available | +| Copy/paste actions | Yes | Yes | ## Workflow administration -|Workflow administration |SharePoint workflow |Power Automate flow | -|:-------|:-------|:--------| -| Central location to view all workflows | Yes, only available to view for a given list or library | Yes, 'My flows' lists user flows | -| Share workflows with list or library users | Yes | Yes | -| Share workflows with users | Not available | Yes | -| Save a copy of workflow to create a copy of the workflow | Not available | Yes | -| Workflow versioning | Not available | No | -| Create a workflow with elevated permissions | Yes, by granting permissions to workflow app and then using App Step action and SharePoint Add-ins | Not available + +| Workflow administration | SharePoint workflow | Power Automate flow | +| :------------------------------------------------------- | :------------------------------------------------------------------------------------------------- | :------------------------------- | +| Central location to view all workflows | Yes, only available to view for a given list or library | Yes, 'My flows' lists user flows | +| Share workflows with list or library users | Yes | Yes | +| Share workflows with users | Not available | Yes | +| Save a copy of workflow to create a copy of the workflow | Not available | Yes | +| Workflow versioning | Not available | No | +| Create a workflow with elevated permissions | Yes, by granting permissions to workflow app and then using App Step action and SharePoint Add-ins | Not available | diff --git a/docs/business-apps/power-automate/guidance/require-doc-approval.md b/docs/business-apps/power-automate/guidance/require-doc-approval.md index af7013884..c5c548834 100644 --- a/docs/business-apps/power-automate/guidance/require-doc-approval.md +++ b/docs/business-apps/power-automate/guidance/require-doc-approval.md @@ -1,7 +1,8 @@ --- title: Require approval of documents in SharePoint using Power Automate -ms.date: 05/19/2020 -search.app: +description: Documents that contain sensitive information often require approvals. With the content approval feature in SharePoint, you can put a simple approval process for documents in a specific document library. Using this content approval process, documents pending approval will not be visible to users until they are approved. +ms.date: 06/28/2022 +search.app: - Flow search.appverid: met150 --- @@ -51,7 +52,7 @@ The following actions occur: Using the following template, create a flow in Power Automate. -1. In the SharePoint library, from the command bar, select **Automate** > **Power Automate** > **Create a flow**. +1. In the SharePoint library, from the command bar, select **Integrate** > **Power Automate** > **Create a flow**. 1. Next, select the template: **When a new file is added in SharePoint, complete a custom action**. ![File add custom action](../../../images/create-flow-template-file-added.png) @@ -83,10 +84,10 @@ You must ensure you enter the correct site and library name. However, you can ge - Using the *Id* property from the *trigger output* - Comments - Using the *comments* property from the *approval response* - - ETAG -- Using the *ETag* property from the *Get file metadata* action output +- ETAG + - Using the *ETag* property from the *Get file metadata* action output -You can now use the content approval status action to approve and reject the document based on the approval response. +You can now use the content approval status action to approve or reject the document based on the approval response. The end result is that: @@ -100,4 +101,3 @@ The end result is that: ![Email approval status](../../../images/output-content-approval-status.png) This is an effective way to automate document approval in SharePoint using Power Automate! Use this procedure for list items and pages as well. - diff --git a/docs/business-apps/power-automate/guidance/working-with-get-items-and-get-files.md b/docs/business-apps/power-automate/guidance/working-with-get-items-and-get-files.md index 5656ad992..284490333 100644 --- a/docs/business-apps/power-automate/guidance/working-with-get-items-and-get-files.md +++ b/docs/business-apps/power-automate/guidance/working-with-get-items-and-get-files.md @@ -1,7 +1,8 @@ --- title: In-depth analysis into 'Get items' and 'Get files' SharePoint actions for flows in Power Automate -ms.date: 03/11/2020 -search.app: +description: In this article, learn more about the SharePoint actions get items & get files actions with Power Automate. +ms.date: 06/28/2022 +search.app: - Flow search.appverid: met150 --- @@ -15,7 +16,7 @@ The **Get items** and **Get files** SharePoint actions for flows in Power Automa First, and of primary consideration, the **Get items** action only works with lists, whereas the **Get files** action only works with libraries. ## Item limits -The default item limit is 100 and items are paginated by default as well. +The default item limit is 100 and items are paginated by default as well. If you are using the default options, and simply specifying the site address and list or library name, Power Automate returns 100 items from the list or library. @@ -29,7 +30,7 @@ If you go beyond 5,000 item limit, Power Automate fails and generates an error d ## Limit items to a specific folder By default, this action returns all items or files in the list or library, recursively, from all folders, if available. You can change this behavior by doing the following: -* To select a specific folder in the list or library, use _Limit Entries_ to Folder property. +* To select a specific folder in the list or library, use _Limit Entries_ to Folder property. * To limit entries to that specific folder or within all sub-folders, use _Include Nested Items_ property. ![Limit entries to folder in Get items action](../../../images/flow-get-items-limit-entries-to-folder.png) @@ -65,7 +66,7 @@ Other examples: * startswith(Title, 'A') and Start_x0020_Date gt 'formatDateTime(utcNow(),'yyyy-MM-dd')' * formatDateTime(utcNow(),'yyyy-MM-dd') is an expression. * Country/Title eq 'New Zealand' - * Country is a lookup column in the list and Title is a column in the referenced list. + * Country is a lookup column in the list and Title is a column in the referenced list. ![ODATA filter queries in Get items action](../../../images/flow-get-items-filter-query.png) @@ -91,14 +92,6 @@ We support the following query methods and operators. * eq * ne -### Date and time functions -* day() -* month() -* year() -* hour() -* minute() -* second() - ## Order by query To order items based off of a column either in ascending or descending order, you can also specify an order by query. For example: @@ -111,4 +104,5 @@ Spaces in the column name are replaced with `_x0020_` (0 is numeral zero). The format is the column name followed by asc or desc depending on ascending or descending order, respectively. - +### Known Limitation +While using Get items on lists with more than 5000 items with a filter query, you may observe that no records are returned if there are no items matching the filter query in the first 5000 items. To fix this, enable Pagination on Get items from the action settings menu when working with lists with more than 5000 items. diff --git a/docs/business-apps/power-automate/guidance/working-with-send-sp-http-request.md b/docs/business-apps/power-automate/guidance/working-with-send-sp-http-request.md index 208b87abc..18c911428 100644 --- a/docs/business-apps/power-automate/guidance/working-with-send-sp-http-request.md +++ b/docs/business-apps/power-automate/guidance/working-with-send-sp-http-request.md @@ -1,12 +1,13 @@ --- title: Working with the SharePoint Send HTTP Request flow action in Power Automate -ms.date: 03/11/2020 -search.app: +description: In Power Automate, the SharePoint Send HTTP Request flow action lets you construct and execute SharePoint REST API queries. +ms.date: 01/27/2023 +search.app: - Flow search.appverid: met150 --- - # Working with the SharePoint Send HTTP Request flow action in Power Automate + In Power Automate, the SharePoint Send HTTP Request flow action lets you construct and execute SharePoint REST API queries. This action is particularly useful in cases where the existing SharePoint flow actions do not handle your requirements, or the action you are looking for is not yet available in the SharePoint connector. ![Send an HTTP Request to SharePoint action](../../../images/flow-send-http-request-to-sp-action.png) @@ -15,14 +16,18 @@ To work effectively with the SharePoint Send HTTP Request action, see the follow > [!NOTE] > This is a developer-focused action. You must understand how SharePoint REST API works and also how to parse JSON strings in Power Automate. +> +> Additionally, this action only supports SharePoint REST APIs (excluding any deprecated APIs), if you need to access another Microsoft service, you will need to leverage the "HTTP with Microsoft Entra ID" connector. ## Get to know the SharePoint REST/OData APIs -SharePoint has many APIs. The focus here is the REST/OData APIs. For the complete set of REST/OData APIs, see [Get to know the SharePoint REST service](https://docs.microsoft.com/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service#bk_learnmore). + +SharePoint has many APIs. The focus here is the REST/OData APIs. For the complete set of REST/OData APIs, see [Get to know the SharePoint REST service](/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service#bk_learnmore). Although, in some cases, you can use the SharePoint 2010 REST APIs *(_vti_bin/listdata.svc)*, we recommend using REST/OData APIs instead. ## Use JSON light -SharePoint REST/OData APIs support [JSON light](https://www.microsoft.com/microsoft-365/blog/2014/08/13/json-light-support-rest-sharepoint-api-released/). This means that you can set headers in your API request that inform SharePoint whether to include any metadata in the response. In many cases, you do not require the metadata. Metadata makes things simpler to parse the output of the action. + +SharePoint REST/OData APIs support [JSON light](https://www.microsoft.com/en-us/microsoft-365/blog/2014/08/13/json-light-support-rest-sharepoint-api-released/). This means that you can set headers in your API request that inform SharePoint whether to include any metadata in the response. In many cases, you do not require the metadata. Metadata makes things simpler to parse the output of the action. To do this, just add the following header: @@ -31,6 +36,7 @@ Accept: application/json; odata=nometadata ``` ## Parse the response + If you execute a GET request, you generally want to parse the response. The default response is JSON, making execution simpler. Parse the response by querying the body of the action, and then parsing through the JSON array or object depending on your response. diff --git a/docs/business-apps/power-automate/sharepoint-connector-actions-triggers.md b/docs/business-apps/power-automate/sharepoint-connector-actions-triggers.md index f182faa93..6566e5ef0 100644 --- a/docs/business-apps/power-automate/sharepoint-connector-actions-triggers.md +++ b/docs/business-apps/power-automate/sharepoint-connector-actions-triggers.md @@ -1,7 +1,9 @@ --- title: Microsoft SharePoint Connector for Power Automate -ms.date: 11/30/2020 -search.app: +description: In Power Automate, Microsoft SharePoint Connector supports the following flow triggers and actions. +ms.date: 10/23/2024 +ms.service: power-automate +search.app: - Flow search.appverid: met150 --- @@ -24,13 +26,13 @@ Triggers the flow when you create an item, and each time you modify it in a Shar ### When an item or a file is modified -Triggers the flow when you modify an item or a file in a SharePoint list or a document library. +Triggers the flow when you modify an item or a file in a SharePoint list or a document library. For more info about how to use this trigger, see this tutorial video: [Introducing 'when an item or file modified' trigger and 'Get changes' action](https://youtu.be/AaWB3xlhJdc) ### When an item is deleted -Triggers the flow when you delete an item in a list. To get the properties of a deleted item, you must connect this trigger to the associated SharePoint site on which it is expected to run, using a site collection user account. +Triggers the flow when you delete an item in a list. To get the properties of a deleted item, you must connect this trigger to the associated SharePoint site on which it is expected to run, using a site collection admin account. ### For a selected item @@ -39,25 +41,36 @@ Allows users of lists to trigger a flow after selecting an item in a list. > [!NOTE] > Only flows within the default environment can be executed manually from a SharePoint list. +### When a file is classified by a content understanding model +Triggers the flow when a Microsoft Syntex content understanding model classifies a file, shown in the classification date property of the file. + +For more info about when Microsoft Syntex and how it classifies files see: [Introduction to Microsoft Microsoft Syntex](/microsoft-365/contentunderstanding) + ### When a file is created (properties only) -Triggers the flow when you create a file in a document library, and returns only the custom file properties associated with that file. +Triggers the flow when you create a file in a document library and returns only the custom file properties associated with that file. -### When a file is created in a folder +### When a file is created in a folder [deprecated] + +> [!NOTE] +> This trigger is deprecated and may not work as expected. Triggers the flow when you create a file in a SharePoint folder. This trigger does not run if you add or update a file in a subfolder inside the folder this trigger is operating on. If the flow is required to trigger on subfolders, create different flows for one or more subfolder(s). ### When a file is created or modified (properties only) -Triggers the flow when you create a file, and each time you modify the file properties in a library. Returns only the custom file properties associated with that file. +Triggers the flow when you create a file, and each time you modify the file properties in a library. Specify a value in the "Folder" property to target a specific folder; otherwise, the trigger applies to the entire library. Returns only the custom file properties associated with that file. + +### When a file is created or modified in a folder [deprecated] -### When a file is created or modified in a folder (properties only) +> [!NOTE] +> This trigger is deprecated and may not work as expected. -Triggers the flow when you create a file, and each time you modify the file properties in the selected SharePoint folder. The trigger does not activate if you add or update a file in a subfolder. If the flow is required to trigger on subfolders, create different flows for one or more subfolder(s). +Triggers when a file is created, and also each time it is modified in a SharePoint folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created. ### When a file is deleted -Triggers the flow when you delete a file in a document library. You can optionally specify a folder to watch. When you delete a folder, the trigger activates only once for the deleted folder, including its subfolders. To get the properties of the deleted file, you must connect this trigger to the associated SharePoint site on which the trigger is epxected to run, using a site collection user account. +Triggers the flow when you delete a file in a document library. You can optionally specify a folder to watch. When you delete a folder, the trigger activates only once for the deleted folder, including its subfolders. To get the properties of the deleted file, you must connect this trigger to the associated SharePoint site on which the trigger is expected to run, using a site collection admin account. ### For a selected file @@ -86,7 +99,7 @@ Cancels hub join request. If applicable, specify the same Approval Correlation I ### Check in file -Checks in a checked out file in a document library, which makes the version of the document available to others. +Checks in a checked-out file in a document library, which makes the version of the document available to others. ### Check out file @@ -96,7 +109,10 @@ Checks out a file in a document library to prevent others from editing the docum Copies a file. Works similarly to the **Copy to** command in SharePoint libraries. After copying, returns info about the new file. -### Copy file (deprecated) +### Copy file [deprecated] + +> [!NOTE] +> This action is deprecated and may not work as expected. Copies a file to a SharePoint site. @@ -156,14 +172,14 @@ Returns the list of attachments for the specified list item. To get to the conte Gets all the columns or file properties changed since and until a specified time interval. To get all the columns changed when an item or a file is modified: - Use the _when an item or file is modified_ trigger, and, -- Use the _Trigger Window Start Token_ & _Trigger Window End Token_ outputs from the _when an item or file is modified_ trigger to infer what columnns changed since last time flow checked for item or file updates. +- Use the _Trigger Window Start Token_ & _Trigger Window End Token_ outputs from the _when an item or file is modified_ trigger to infer what columns changed since the last time flow checked for item or file updates. For more info about how to use this action, see this tutorial video: [Introducing 'when an item or file modified' trigger and 'Get changes' action](https://youtu.be/AaWB3xlhJdc) > [!NOTE] -> - The list or library should have versioning configured in order to infer what columns or properties got modified since last change. -> - Only column changes are suported for lists and libraries. -> - File content changes are not supported. +> - The list or library should have versioning configured in order to infer what columns or properties got modified since last change. +> - Only column changes are supported for lists and libraries. +> - File content changes are not supported. > - Attachment changes are not supported. > - _Trigger Window Start Token_ & _Trigger Window End Token_ are only available when you use _when an item or file is modified_ trigger. @@ -221,7 +237,7 @@ Grants access to an item or a folder in SharePoint to specific people. ### Join hub site -Joins the requested site to the hub site. An Approval Token is required to complete the join successfully, if that hub requires approval. If applicable, specify the same Approval Correlation Id as used in the **Set hub site join status to pending** action. +Joins the requested site to the hub site. An Approval Token is required to complete the join successfully if that hub requires approval. If applicable, specify the same Approval Correlation Id as used in the **Set hub site join status to pending** action. ### List folder @@ -241,7 +257,7 @@ Moves a folder. Works similarly to the **Move to** command in SharePoint librari ### Resolve person -Returns a single matching user value so it can be assigned to a column of type person. If there are no matches, or multiple matches, this action errors out. +Returns a single matching user value so it can be assigned to a column of type person. If there are no matches or multiple matches, this action errors out. ### Send an HTTP request to SharePoint @@ -292,7 +308,7 @@ The following tables list all of the actions and triggers that are supported for | When a file is deleted | No | No | Yes2 | | Resolve Person | No | No | Yes | | Set content approval status | No | No | Yes | - + > [!NOTE] > 1. Does not support “Limit Columns by View”. > 1. While this trigger is supported for SharePoint 2019, flows created using this trigger may encounter the following issues: @@ -309,34 +325,36 @@ The following tables list all of the actions and triggers that are supported for | Get folder metadata | Yes | Yes | Yes | | Get folder metadata using path | Yes | Yes | Yes | | Get file content | Yes | Yes | Yes | -| Create file | Yes | Yes | Yes | +| Create file | Yes1 | Yes1 | Yes1 | | Update file | Yes | Yes | Yes | -| Copy file (deprecated)1| Yes | Yes | Yes | +| Copy file [deprecated]2| Yes | Yes | Yes | | List folder | Yes | Yes | Yes | | Extract folder | Yes | Yes | Yes | | Get attachments | Yes | Yes | Yes | | Add attachment | Yes | Yes | Yes | | Delete attachment | Yes | Yes | Yes | -| Get items | Yes2 | Yes2 | Yes2 | -| Get item | Yes3 | Yes3 | Yes3 | -| Create item | Yes3 | Yes3 | Yes3 | -| Update item | Yes3 | Yes3 | Yes3 | +| Get items | Yes3 | Yes3 | Yes3 | +| Get item | Yes4 | Yes4 | Yes4 | +| Create item | Yes4 | Yes4 | Yes4 | +| Update item | Yes4 | Yes4 | Yes4 | | Delete item | Yes | Yes | Yes | | Send an HTTP request to SharePoint | Yes | Yes | Yes | > [!NOTE] -> 1. This action includes "(deprecated)" in its display name. The "Copy file" action is different from this action. +> 1. Does not support creating a large file by uploading it as a set of chunks. +> 1. This action includes "[deprecated]" in its display name. The "Copy file" action is different from this action. > 1. This action only supports OData parameters, which excludes parameters such as "Limit Entries to Folder", "Include Nested Items", and "Limit Columns by View". > 1. Does not support “Limit Columns by View”. -### Deprecated triggers +### Deprecated triggers and actions These triggers are deprecated and are no longer actively maintained. While they are still present in the Microsoft SharePoint Connector, we recommend not utilizing deprecated triggers or actions in any new applications or solutions. -| Trigger | Supported Version | Suggested Alternative | -| :-- | :-- | :-- | -| When a file is created in a folder | SharePoint 2019 | When a file is created (properties only) | -| When a file is created or modified in a folder | SharePoint 2019 | When a file is created or modified (properties only) | +| Name | Type | Supported Version | Suggested Alternative | +| :-- | :-- | :-- | :-- | +| When a file is created in a folder [deprecated] | Trigger |SharePoint 2019 | When a file is created (properties only) | +| When a file is created or modified in a folder [deprecated] | Trigger | SharePoint 2019 | When a file is created or modified (properties only) | +| Copy file [deprecated] | Action | SharePoint 2019 | Copy file | ## Known limitations @@ -350,9 +368,9 @@ When you build a Power Automate flow to be triggered for an item, or for creatin ### Move files and flow runs -When you move one or more files from one document library to another, the original file is moved from the source library to the destination library. Moving the file does not alter any custom metadata, including when the file was created and modified. Hence, this action does not trigger any flows for those file updates associated in the library where it was moved. +When you move one or more files from one document library to another, the original file is moved from the source library to the destination library. Moving the file does not alter any custom metadata, including when the file was created and modified. Hence, this action does not trigger any flows for those file updates associated with the library where it was moved. -### Syncing files to your OneDrive for business and SharePoint document libraries +### Syncing files to your OneDrive for Business and SharePoint document libraries When users sync one or more files from one document library to another, the original file is moved (synced) from your client to the destination library. Syncing the file will not alter any custom metadata including when the file was created and modified. Hence, this action will not trigger any flows for those file syncs in that library or in your OneDrive for business. diff --git a/docs/community/community.md b/docs/community/community.md index 8b0297006..79d2ffccc 100644 --- a/docs/community/community.md +++ b/docs/community/community.md @@ -1,23 +1,23 @@ --- title: SharePoint Developer Community (SharePoint PnP) resources description: The SharePoint Development Community (also known as the SharePoint PnP community) is an open-source initiative coordinated by SharePoint engineering. -ms.date: 02/14/2020 -ms.prod: sharepoint -localization_priority: Priority +ms.date: 06/09/2022 +ms.service: sharepoint-online +ms.localizationpriority: high --- -# SharePoint Developer Community (SharePoint PnP) resources +# Microsoft 365 Platform Community (PnP) resources around SharePoint Framework -The SharePoint Development Community (also known as the SharePoint PnP community) is an open-source initiative coordinated by SharePoint engineering. This community controls SharePoint development documentation, samples, reusable controls, and other relevant open-source initiatives related to SharePoint development. +The Microsoft 365 Platform Community (also known as M365 PnP community) is an open-source initiative coordinated by Microsoft 365 engineering. This community controls SharePoint development documentation, samples, reusable controls, and other relevant open-source initiatives related to SharePoint development. ## Blog posts, videos, and social media -- [SharePoint Developer Blog](https://developer.microsoft.com/en-us/office/blogs/) - Latest developer news around SharePoint and Office 365 +- [SharePoint Developer Blog](https://developer.microsoft.com/office/blogs/) - Latest developer news around SharePoint and Office 365 - [SharePoint Developer Videos](https://aka.ms/spdev-videos) - Latest guidance videos, training videos, and community call recordings - [Microsoft 365 Dev Twitter](https://twitter.com/Microsoft365Dev) - Official communication channel for SharePoint, Office 365, Windows 10 and Enterprise Mobility + Security developer topics - [Microsoft 365 PnP Twitter](https://twitter.com/m365pnp) - Community account for Microsoft 365 and SharePoint topics - [Microsoft 365 Dev Facebook](https://www.facebook.com/Microsoft365Developer) - Official communication channel for SharePoint, Office 365, Windows 10 and Enterprise Mobility + Security developer topics -- [Microsoft 365 PnP Facebook](https://www.facebook.com/OfficeDevPnP/) - Community account for SharePoint and Office 365 developer topics +- [Microsoft 365 PnP Facebook](https://www.facebook.com/Microsoft365/community) - Community account for SharePoint and Office 365 developer topics ## GitHub @@ -37,15 +37,15 @@ Found an issue related to SharePoint development around the APIs, documentation, There are numerous community calls for SharePoint development, and you can choose which of them you'd like to join based on your interest and availability. Each call has live demos from SharePoint Engineering, MVPs, or other community members. > [!TIP] -> If you are interested in doing a live demo in any of our community calls, please reach out by leaving a comment on this page and we'll get you a spot for 10-15 minutes for demonstrating your SharePoint development topic(s). +> If you are interested in doing a live demo in any of our community calls, please reach out by [requesting a demo slot](https://aka.ms/community/request/demo) and we'll get you a spot for 10-15 minutes for demonstrating your Microsoft 365 & Power Platform development topic(s). > > **Do's & Dont's**: Interested in presenting during one of the community calls? Keep in mind these are community calls. The focus of these demos should be on learning and topics beneficial to the community. Please refrain from commercial activities such as selling or promoting products or services. Commercial activities in the community calls are not well received by the community and in certain instances may result in stopping the demo early. In your request to present, please be descriptive about what you intend to show to avoid any confusion. If you are not sure if what you want to present is appropriate, just ask in the submission. | Community call | When | Description | Microsoft Teams Link | | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [Monthly community call](https://aka.ms/sppnp-call) | Second Tuesday of each month at 8:00 AM PT / 3:00 PM GMT | Monthly community call covering the latest changes in SharePoint development-related topics within the last month, including news, UserVoice updates, and community contributions | [Direct MS Teams link to meeting](https://aka.ms/spdev-call-join) | -| [Special interest group call for SharePoint Framework](https://aka.ms/spdev-spfx-call) | Bi-weekly on Thursdays at 7:00 AM PT / 2:00 PM GMT | SharePoint Engineering updates, SharePoint Framework, PnPJS, CLI for Microsoft 365, and reusable SPFx controls | [Direct MS Teams link to meeting](https://aka.ms/spdev-spfx-call-join) | -| [Special interest group call for general SharePoint development](https://aka.ms/spdev-sig-call) | Bi-weekly on Thursdays at 7:00 AM PT / 2:00 PM GMT | SharePoint Engineering updates, end-to-end solution designs, provisioning, PnP CSOM, and PnP PowerShell | [Direct MS Teams link to meeting](https://aka.ms/spdev-sig-call-join) | +| [Microsoft 365 & Power Platform Call (Microsoft Speakers)](https://aka.ms/community/ms-speakers-call-invite) | Weekly on Tuesdays at 8:00 AM PT / 3:00 PM GMT | Community call with Microsoft speakers covering the latest news from Microsoft engineerung on the Microsoft 365 & Power Platform topics including news, UserVoice updates, and demos | [Direct MS Teams link to meeting](https://aka.ms/community/ms-speakers-call-join) | +| [Viva Connections and SharePoint Framework community call](https://aka.ms/spdev-spfx-call) | Bi-weekly on Thursdays at 7:00 AM PT / 2:00 PM GMT | SharePoint Engineering updates, SharePoint Framework, PnPJS, CLI for Microsoft 365, and reusable SPFx controls | [Direct MS Teams link to meeting](https://aka.ms/spdev-spfx-call-join)| +| [Microsoft 365 & Power Platform Development Community call](https://aka.ms/community/m365-powerplat-dev-call-invite) | Bi-weekly on Thursdays at 7:00 AM PT / 2:00 PM GMT | Latest on Latest on PnP Framework and Core SDK extension, PnP PowerShell, yo Teams, Microsoft Graph Toolkit, Independent Publisher Connector Updates plus community demos | [Direct MS Teams link to meeting](https://aka.ms/community/m365-powerplat-dev-call-join) | ## What’s the supportability statement around PnP open-source components and solutions? diff --git a/docs/community/contribute.md b/docs/community/contribute.md index 48d6ee952..dfe50aef8 100644 --- a/docs/community/contribute.md +++ b/docs/community/contribute.md @@ -1,9 +1,8 @@ --- title: SharePoint Developer Community contribution description: Contribution options towards the SharePoint Developer Community. -ms.date: 02/14/2020 -ms.prod: sharepoint -localization_priority: Normal +ms.date: 06/07/2022 +ms.localizationpriority: medium --- # SharePoint Developer Community - How to contribute @@ -15,7 +14,7 @@ There are multiple ways to contribute to the SharePoint Developer Community (Sha * Do a live demo of your sample, solution, or architecture design in the SharePoint community calls. * Report and fix issues within the GitHub repositories in the [SharePoint GitHub Organization](http://github.com/sharepoint). * Report issues in the GitHub issue lists to help others find where they can assist. -* Provide input on new feature requests within [SharePoint Developer UserVoice](https://sharepoint.uservoice.com/forums/329220-sharepoint-dev-platform). +* Provide input on new feature requests within [Feedback Portal: SharePoint](https://feedbackportal.microsoft.com/feedback/forum/06735c62-321c-ec11-b6e7-0022481f8472).. ## FAQ diff --git a/docs/community/open-source-projects.md b/docs/community/open-source-projects.md index 8263182cd..e3f81365e 100644 --- a/docs/community/open-source-projects.md +++ b/docs/community/open-source-projects.md @@ -1,9 +1,8 @@ --- title: SharePoint Developer Community open source projects description: Open-source projects coordinated by the SharePoint PnP initiative -ms.date: 09/07/2020 -ms.prod: sharepoint -localization_priority: Priority +ms.date: 06/07/2022 +ms.localizationpriority: high --- # SharePoint Developer Community - Open-source projects @@ -13,10 +12,10 @@ There are numerous open-source projects that are coordinated by the SharePoint P | Repository | Description | |--------|--------| | [SharePoint Starter kit](https://github.com/SharePoint/sp-starter-kit) | A starter kit for showing how to extend modern experiences in SharePoint Online by extending them with modern extensibility options. | -| [SharePoint Provisioning Service templates](https://github.com/SharePoint/sp-dev-provisioning-templates) | Tenant templates used by the [SharePoint Provisioning Service](https://provisioning.sharepointpnp.com) to easily provision sample content and structures demonstrating what's possible with modern SharePoint experiences. | +| [SharePoint Provisioning Service templates](https://github.com/SharePoint/sp-dev-provisioning-templates) | Tenant templates previously used by the Look Book Services to easily provision sample content and structures demonstrating what's possible with modern SharePoint experiences. | | [CLI for Microsoft 365](https://pnp.github.io/cli-microsoft365/) | A cross-platform command-line interface (CLI) that allows users on any platform to manage their Microsoft 365 and SharePoint Framework projects. | | [Office 365 Developer PnP Core Component](https://github.com/SharePoint/PnP-Sites-Core) | An extension component that encapsulates commonly used remote CSOM/REST operations as reusable extension methods on out-of-the box CSOM objects. | -| [PnP PowerShell cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets?view=sharepoint-ps) | Allow you to perform complex provisioning and artifact management actions for SharePoint. The commands use CSOM and can work against both SharePoint Online as well as SharePoint on-premises. | +| [PnP PowerShell cmdlets](/powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets) | Allow you to perform complex provisioning and artifact management actions for SharePoint. The commands use CSOM and can work against both SharePoint Online as well as SharePoint on-premises. | | [PnP remote provisioning schema](https://github.com/SharePoint/PnP-provisioning-schema) | Designed to be used as remote creation instructions for the remote provisioning engine for Office 365. | | [SharePoint Modernization tooling and guidance](https://github.com/SharePoint/sp-dev-modernization) | Tools like page transformation (classic page to modern page) and a modernization scanner do make it easy to move your classic sites into the modern SharePoint world. | | [PnPjs](https://pnp.github.io/pnpjs/) | A fluent JavaScript API for consuming SharePoint and Office 365 REST APIs in a type-safe way. | diff --git a/docs/community/repositories.md b/docs/community/repositories.md index adf1a9db8..7f09fcba3 100644 --- a/docs/community/repositories.md +++ b/docs/community/repositories.md @@ -1,9 +1,8 @@ --- title: SharePoint Developer GitHub repositories description: List of different SharePoint Developer GitHub repositories and their description -ms.date: 03/29/2018 -ms.prod: sharepoint -localization_priority: Priority +ms.date: 09/23/2022 +ms.localizationpriority: high --- # SharePoint Developer GitHub repositories @@ -20,13 +19,13 @@ There are numerous SharePoint Developer GitHub repositories, which all have diff | Repository | Description | |--------|--------| -| [sp-dev-docs](https://github.com/SharePoint/sp-dev-docs) | Source for SharePoint dev documentation exposed at https://docs.microsoft.com/sharepoint/dev/ | +| [sp-dev-docs](https://github.com/SharePoint/sp-dev-docs) | Source for SharePoint dev documentation exposed at `https://learn.microsoft.com/sharepoint/dev/` | | [sp-dev-fx-webparts](https://github.com/SharePoint/sp-dev-fx-webparts) | Samples and tutorial code around SharePoint Framework client-side web parts | | [sp-dev-fx-extensions](https://github.com/SharePoint/sp-dev-fx-extensions) | Samples and tutorial code around SharePoint Framework extensions | | [sp-dev-modernization](https://github.com/SharePoint/sp-dev-modernization) | Solutions, tools and script to help you modernize your sites | | [sp-dev-solutions](https://github.com/SharePoint/sp-dev-solutions) | More polished and fine-tuned reusable solutions built with the SharePoint Framework | -| [sp-dev-list-formatting](https://github.com/SharePoint/sp-dev-list-formatting) | Various [column formatting](https://docs.microsoft.com/sharepoint/dev/declarative-customization/column-formatting) json files shared among the community | -| [sp-dev-site-scripts](https://github.com/SharePoint/sp-dev-site-scripts) | Various [Site Script and Site Design](https://docs.microsoft.com/sharepoint/dev/declarative-customization/site-design-overview) json files shared among the community | +| [sp-dev-list-formatting](https://github.com/SharePoint/sp-dev-list-formatting) | Various [column formatting](../declarative-customization/column-formatting.md) json files shared among the community | +| [sp-dev-site-scripts](https://github.com/SharePoint/sp-dev-site-scripts) | Various [Site Script and Site Design](../declarative-customization/site-design-overview.md) json files shared among the community | | [sp-dev-fx-controls-react](https://github.com/SharePoint/sp-dev-fx-controls-react) | Reusable content controls for SharePoint Framework solutions built with React | | [sp-dev-fx-property-controls](https://github.com/SharePoint/sp-dev-fx-property-controls) | Reusable property pane controls for use in SharePoint Framework web parts | | [sp-dev-gdpr-activity-hub](https://github.com/SharePoint/sp-dev-gdpr-activity-hub) | A reference solution for the business case of GDPR demonstrating an SPFx implementation with Power BI and modern sites | @@ -40,14 +39,14 @@ There are numerous SharePoint Developer GitHub repositories, which all have diff |--------|--------| | [pnp](https://github.com/SharePoint/pnp) | Main repository for SharePoint Add-ins, Microsoft Graph, and other samples | | [pnp-sites-core](https://github.com/SharePoint/pnp-sites-core) | Office Dev PnP CSOM Core component - Extension component for native SharePoint Client-Side Object Model | -| [pnp-powershell](https://github.com/SharePoint/pnp-powershell) | Source code for [SharePoint PnP PowerShell cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets?view=sharepoint-ps) | +| [pnp-powershell](https://github.com/SharePoint/pnp-powershell) | Source code for [SharePoint PnP PowerShell cmdlets](/powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets) | | [pnp-provisioning-schema](https://github.com/SharePoint/PnP-Provisioning-Schema) | PnP provisioning engine schema repository | | [pnp-tools](https://github.com/SharePoint/PnP-Tools) | Repository for tools and scripts targeted primarily for IT pros and for on-premises SharePoint 2013 and SharePoint 2016 | | [pnp-partner-pack](https://github.com/SharePoint/PnP-Partner-Pack) | Packaged guidance with detailed instructions about setting things up in Office 365 and Azure | | [pnp-js-core](https://github.com/SharePoint/PnP-JS-Core) | Office Dev PnP Core component for JavaScript | | [pnp-transformation](https://github.com/SharePoint/PnP-Transformation) | Material specifically for the transformation process. Currently, includes samples around InfoPath replacement and transformation tooling from farm solutions to the add-in model | -| [pnp-js-provisioning](https://github.com/SharePoint/pnp-js-provisioning) | Repository for planned JavaScript provisioning library | -| [pnp-provisioning-templates](https://github.com/SharePoint/PnP-Provisioning-Templates) | Repository for provisioning templates. +| [pnp-js-provisioning](https://github.com/pnp/sp-js-provisioning) | Repository for planned JavaScript provisioning library | +| [pnp-provisioning-templates](https://github.com/SharePoint/PnP-Provisioning-Templates) | Repository for provisioning templates. | [pnp-guidance](https://github.com/SharePoint/PnP-Guidance) | Old repository on guidance, presentations, and articles that were partially synced to MSDN | | [pnp-identitymodel](https://github.com/SharePoint/PnP-IdentityModel) | Open source replacement of Microsoft.IdentityModel.Extensions.dll | diff --git a/docs/community/social-media.md b/docs/community/social-media.md index 57f729dce..de4293a18 100644 --- a/docs/community/social-media.md +++ b/docs/community/social-media.md @@ -1,11 +1,11 @@ --- title: Social Media +description: Please monitor and follow the Microsoft 365 community and Microsoft 365, Office, and SharePoint developers on social media. author: andrewconnell ms.author: v-johnco -ms.date: 2/5/2020 +ms.date: 06/03/2022 ms.audience: Developer -ms.prod: sharepoint -localization_priority: Priority +ms.localizationpriority: high --- # SharePoint Development on Social Media diff --git a/docs/declarative-customization/column-formatting.md b/docs/declarative-customization/column-formatting.md index 9cf23d9f5..7e933a74c 100644 --- a/docs/declarative-customization/column-formatting.md +++ b/docs/declarative-customization/column-formatting.md @@ -1,15 +1,15 @@ --- title: Use column formatting to customize SharePoint description: Customize how fields in SharePoint lists and libraries are displayed by constructing a JSON object that describes the elements that are displayed when a field is included in a list view, and the styles to be applied to those elements. -ms.date: 03/22/2021 -localization_priority: Priority +ms.date: 09/08/2022 +ms.localizationpriority: high --- # Use column formatting to customize SharePoint -You can use column formatting to customize how fields in SharePoint lists and libraries are displayed. To do this, you construct a JSON object that describes the elements that are displayed when a field is included in a list view, and the styles to be applied to those elements. The column formatting does not change the data in the list item or file; it only changes how it’s displayed to users who browse the list. Anyone who can create and manage views in a list can use column formatting to configure how view fields are displayed. +You can use column formatting to customize how fields in SharePoint lists and libraries are displayed. To do this, you construct a JSON object that describes the elements that are displayed when a field is included in a list view, and the styles to be applied to those elements. The column formatting doesn't change the data in the list item or file; it only changes how it’s displayed to users who browse the list. Anyone who can create and manage views in a list can use column formatting to configure how view fields are displayed. -For example, a list with the fields Title, Effort, Assigned To, and Status with no customizations applied might look like this: +For example, a list with the fields Title, Effort, Assigned To, and Status with no customizations applied might look like this: ![SharePoint list with four unformatted columns](../images/sp-columnformatting-none.png) @@ -22,19 +22,19 @@ A list with the appearance of the **Effort**, **Assigned To**, and **Status** fi ## How is column formatting different than the Field Customizer? -Both column formatting and [SharePoint Framework Field Customizer](https://docs.microsoft.com/sharepoint/dev/spfx/extensions/get-started/building-simple-field-customizer) extensions enable you to customize how fields in SharePoint lists are displayed. The Field Customizer is more powerful because you can use it to write any code that you want to control how a field is displayed. +Both column formatting and [SharePoint Framework Field Customizer](../spfx/extensions/get-started/building-simple-field-customizer.md) extensions enable you to customize how fields in SharePoint lists are displayed. The Field Customizer is more powerful because you can use it to write any code that you want to control how a field is displayed. -Column formatting is more easily and broadly applied. However, it is less flexible, because it does not allow for custom code; it only allows for certain predefined elements and attributes. +Column formatting is more easily and broadly applied. However, it's less flexible, because it doesn't allow for custom code; it only allows for certain predefined elements and attributes. The following table compares column formatting and the Field Customizer. | Field type | Column formatting | Field Customizer | | ------------- |:-------------| :-----| | Conditional formatting based on item values and value ranges | Supported | Supported | -| Action links | Support for static hyperlinks that do not launch script | Support for any hyperlink, including those that invoke custom script | +| Action links | Support for static hyperlinks that don't launch script | Support for any hyperlink, including those that invoke custom script | | Data visualizations | Support for simple visualizations that can be expressed using HTML and CSS | Support for arbitrary data visualizations | -If you can accomplish your scenario by using column formatting, it’s typically quicker and easier to do that than to use a Field Customizer. Anyone who can create and manage views in a list can use column formatting to create and publish customizations. Use a Field Customizer for more advanced scenarios that column formatting does not support. +If you can accomplish your scenario by using column formatting, it’s typically quicker and easier to do that than to use a Field Customizer. Anyone who can create and manage views in a list can use column formatting to create and publish customizations. Use a Field Customizer for more advanced scenarios that column formatting doesn't support. ## Get started with column formatting @@ -51,7 +51,7 @@ To preview the formatting, select **Preview**. To commit your changes, select ** The easiest way to use column formatting is to start from an example and edit it to apply to your specific field. The following sections contain examples that you can copy, paste, and edit for your scenarios. There are also several samples available in the [SharePoint/sp-dev-column-formatting repository](https://github.com/SharePoint/sp-dev-column-formatting). > [!NOTE] -> All examples in this document refer to the JSON schema used in SharePoint Online. To format columns on SharePoint 2019, please use `https://developer.microsoft.com/json-schemas/sp/v1/column-formatting.schema.json` as the schema. +> All examples in this document refer to the JSON schema used in SharePoint Online and SharePoint Server Subscription Edition starting with the Version 22H2 feature update. To format columns in SharePoint 2019 or SharePoint Server Subscription Edition before the Version 22H2 feature update, please use `https://developer.microsoft.com/json-schemas/sp/v1/column-formatting.schema.json` as the schema. ## Display field values (basic) @@ -174,7 +174,7 @@ The following image shows a field with conditional date formatting applied: ![Status field with the Overdue text colored red](../images/sp-columnformatting-overdue.png) -This example colors the current field red when the value inside an item's DueDate is before the current date/time. Unlike some of the previous examples, this example applies formatting to one field by looking at the value inside another field. Note that DueDate is referenced using the `[$FieldName]` syntax. FieldName is assumed to be the internal name of the field. This example also takes advantage of a special value that can be used in date/time fields - `@now`, which resolves to the current date/time, evaluated when the user loads the list view. +This example colors the current field red when the value inside an item's DueDate is before the current date/time. Unlike some of the previous examples, this example applies formatting to one field by looking at the value inside another field. Note that `DueDate` is referenced using the `[$FieldName]` syntax. FieldName is assumed to be the internal name of the field. This example also takes advantage of a special value that can be used in date/time fields - `@now`, which resolves to the current date/time, evaluated when the user loads the list view. > [!NOTE] > If you have spaces in the field name, those are defined as `_x0020_`. For example, a field named "Due Date" should be referenced as `$Due_x0020_Date`. @@ -193,7 +193,7 @@ This example colors the current field red when the value inside an item's DueDat ### Formatting items based on arbitrary dates (advanced) -To compare the value of a date/time field against a date that's not `@now`, follow the pattern in the following example. The following example colors the current field red if the due date was <= tomorrow. This is accomplished using date math. You can add milliseconds to any date and the result will be a new date. For example, to add a day to a date, you'd add (24\*60\*60\*1000 = 86,400,000). +To compare the value of a date/time field against a date that's not `@now`, follow the pattern in the following example. The following example colors the current field red if the due date was <= tomorrow. This is accomplished using date math. You can add milliseconds to any date and the result will be a new date. For example, to add a day to a date, you'd add (24\*60\*60\*1000 = 86,400,000). This example demonstrates an alternate syntax to express a conditional expression, using the ternary (`?`) operator inside an abstract syntax tree. @@ -289,7 +289,9 @@ Here's the same sample from above, using the Excel-style expression syntax: ## Create clickable actions -You can use column formatting to provide hyperlinks that go to other webpages, or start custom functionality. This functionality is limited to static links that can be parameterized with values from fields in the list. You can't use column formatting to output links to protocols other than `http://`, `https://`, or `mailto:`. +You can use column formatting to provide hyperlinks that go to other webpages, or start custom functionality. This functionality is limited to static links that can be parameterized with values from fields in the list. You can't use column formatting to output links to protocols other than `http://`, `https://`, `mailto:` or `tel:`. + +`tel:` protocol only allows digits, `*+#` special characters and `.-/()` visual separators. ### Turn field values into hyperlinks (basic) @@ -322,7 +324,7 @@ The following image shows action buttons added to a field. You can use column formatting to render quick action links next to fields. The following example, intended for a person field, renders two elements inside the parent `
` element: - A `` element that contains the person’s display name. -- An `` element that opens a mailto: link that creates an email with a subject and body populated dynamically via item metadata. The `` element is styled using the `ms-Icon`, `ms-Icon—Mail`, and `ms-QuickAction` [Fluent UI](https://developer.microsoft.com/fluentui) classes to make it look like a clickable email icon. +- An `` element that opens a mailto: link that creates an email with a subject and body populated dynamically via item metadata. The `` element is styled using the `ms-Icon`, `ms-Icon—Mail`, and `ms-QuickAction` [Fluent UI](https://developer.microsoft.com/fluentui) classes to make it look like a clickable email icon. ```JSON { @@ -338,6 +340,9 @@ You can use column formatting to render quick action links next to fields. The f }, { "elmType": "a", + "style": { + "text-decoration": "none" + }, "attributes": { "iconName": "Mail", "class": "sp-field-quickActions", @@ -472,7 +477,7 @@ Here's the same sample from above, using the Excel-style expression syntax: "elmType": "span", "attributes": { "class": "=if([$After] > [$Before], 'sp-field-trending--up', 'sp-field-trending--down')", - "iconName": "=if([$After] > [$Before], 'SortUp', "if([$After] < [$Before], 'SortDown', ''))" + "iconName": "=if([$After] > [$Before], 'SortUp', if([$After] < [$Before], 'SortDown', ''))" } }, { @@ -483,56 +488,6 @@ Here's the same sample from above, using the Excel-style expression syntax: } ``` -## Create a button to launch a Flow - -The following screenshot shows a list with a Flow button added to the Action column: - -![screenshot of the sample](../images/sp-columnformatting-flow.png) - -You can use column formatting to create buttons that, when selected, run Flows on the corresponding list item. The Flow Launch Panel will be displayed after choosing the button and the Flow will just run. - -To use the sample below, you must substitute the ID of the Flow you want to run. This ID is contained within the `customRowAction` attribute inside the `button` element. To obtain a Flow's ID: - -1. Choose Flow > See your flows in the SharePoint list where the Flow is configured. -2. Choose the Flow you want to run. -3. Copy the ID from the end of the URL. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "button", - "customRowAction": { - "action": "executeFlow", - "actionParams": "{\"id\": \"edf627d9-20f4-45ba-8bc9-4494bf2ff1be\"}" - }, - "attributes": { - "class": "ms-fontColor-themePrimary ms-fontColor-themeDarker--hover" - }, - "style": { - "border": "none", - "background-color": "transparent", - "cursor": "pointer" - }, - "children": [ - { - "elmType": "span", - "attributes": { - "iconName": "Flow" - }, - "style": { - "padding-right": "6px" - } - }, - { - "elmType": "span", - "txtContent": "Send to Manager" - } - ] -} -``` - -Additionally, you can use `headerText` and `runFlowButtonText` options within the `actionParams` property to customize portions of the Flow panel itself! See the [button elements](https://docs.microsoft.com/sharepoint/dev/declarative-customization/column-formatting#button-elements) portion of the Detailed syntax reference for more details. - ## Formatting multi-value fields You can use column formatting to apply styles to each member of a multi-value field of type Person, Lookup and Choice. @@ -550,7 +505,8 @@ This example uses the `length` operator to detect the number of members of the f "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", "elmType": "a", "style": { - "display": "=if(length(@currentField) > 0, 'flex', 'none')" + "display": "=if(length(@currentField) > 0, 'flex', 'none')", + "text-decoration": "none" }, "attributes": { "href": { @@ -599,7 +555,7 @@ The following image shows an example of constructing a simple sentence from the ![Screenshot of a field reads "North America, APAC, and Europe"](../images/sp-columnformatting-multi-value-1.png) -This examples uses operator `loopIndex` and `length` to identify the last member of the field, and attribute `forEach` to duplicate HTML elements. +This example uses operator `loopIndex` and `length` to identify the last member of the field, and attribute `forEach` to duplicate HTML elements. ```json { @@ -633,11 +589,12 @@ This examples uses operator `loopIndex` and `length` to identify the last member ``` ### Complex HTML elements formatting + The following image shows an example of building a list of users with pictures, email addresses and a simple counter for the number of members at the top. ![List with name "Owners" and 3 rows where each user in the field has a profile picture, name and email displayed, and a small gray counter of owners at top left corner that has a different color when it says 0.](../images/sp-columnformatting-multi-value-2.png) -This examples uses operator `loopIndex` to control the margins all rows but the first one, and attribute `forEach` to build the list of members. +This example uses operator `loopIndex` to control the margins all rows but the first one, and attribute `forEach` to build the list of members. ```json { @@ -683,7 +640,7 @@ This examples uses operator `loopIndex` to control the margins all rows but the { "elmType": "img", "attributes": { - "src": "=[$person.picture]" + "src": "=getUserImage([$person.email], 'S')" }, "style": { "width": "3em", @@ -724,194 +681,6 @@ This examples uses operator `loopIndex` to control the margins all rows but the } ``` -## Custom cards on hover - -The following image shows a list with a custom hover added to a List: - -On hover - Metadata on the column "Status" is made available in view formatting - -![Preview Image 1](../images/HoverImage-1.png) - -On hover - Metadata on the column "Status" is made available in column formatting - -![Preview Image 2](../images/HoverImage-2.png) - - - -You can use column and view formatting to define custom call out that can be commissioned basis user defined actions like click or hover - -This example uses customCardProps, openOnEvent, directionalHint and isBeakVisible - -```JSON - -{ - "elmType": "div", - "style": { - "font-size": "12px" - }, - "txtContent": "[$Status]", - "customCardProps": { - "formatter": { - "elmType": "div", - "txtContent": "Define your formatter options inside the customCarProps/formatter property" - }, - "openOnEvent": "hover", - "directionalHint": "bottomCenter", - "isBeakVisible": true, - "beakStyle" : { - "backgroundColor": "white" - } - } -} -``` -## Default cards on hover - -Users can now have profile card or file hover card on formatters too, some of the things users can now do - - 1) Profile card or File Hover card on any column - 2) Profile card or Hover card with view formatting - -Hover on a filename with formatting with default file card - -![Preview Image 3](../images/HoverImage-3.png) - - -Hover on a person column with formatting with default Profile card - -![Preview Image 4](../images/HoverImage-4.png) - -Both the example uses defaultHoverField - -```JSON - -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "div", - "children": [ - { - "elmType": "img", - "style": { - "width": "32px", - "height": "32px", - "overflow": "hidden", - "border-radius": "50%", - "margin": "2px" - }, - "attributes": { - "src": "='/_layouts/15/userphoto.aspx?size=S&accountname=' + [$Editor.email]", - "title": "[$Editor.title]" - } - }, - { - "elmType": "span", - "style": { - "vertical-align": "middle", - "margin-left": "2px" - }, - "txtContent": "[$Editor.title]" - } - ], - "defaultHoverField": "[$Editor]" -} - -``` - - -## Column formatter reference - -Users can refer to a column's formatter JSON inside another column/view formatter and use it along with other elements to build a custom column visualization. This can be done by using `columnFormatterReference` property. - -The following image shows a list with a Gallery layout referencing the Category column formatter: -Gallery layout referring Category column - -List layout with Category column formatted - -``` JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/tile-formatting.schema.json", - "height": 127, - "width": 254, - "hideSelection": false, - "formatter": { - "elmType": "div", - "attributes": { - "class": "sp-card-container" - }, - "children": [ - { - "elmType": "button", - "attributes": { - "class": "sp-card-defaultClickButton" - }, - "customRowAction": { - "action": "defaultClick" - } - }, - { - "elmType": "div", - "attributes": { - "class": "ms-bgColor-white sp-css-borderColor-neutralLight sp-card-borderHighlight sp-card-subContainer" - }, - "children": [ - { - "elmType": "div", - "attributes": { - "class": "sp-card-displayColumnContainer" - }, - "children": [ - { - "elmType": "p", - "attributes": { - "class": "ms-fontColor-neutralSecondaryAlt sp-card-label" - }, - "txtContent": "[!Title.DisplayName]" - }, - { - "elmType": "p", - "attributes": { - "title": "[$Title]", - "class": "ms-fontColor-neutralPrimary sp-card-content sp-card-highlightedContent" - }, - "txtContent": "=if ([$Title] == '', '–', [$Title])" - } - ] - }, - { - "elmType": "div", - "attributes": { - "class": "sp-card-lastTextColumnContainer" - }, - "children": [ - { - "elmType": "p", - "attributes": { - "class": "ms-fontColor-neutralSecondaryAlt sp-card-label" - }, - "txtContent": "[!Category.DisplayName]" - }, - { - "elmType": "div", - "attributes": { - "class": "sp-card-content" - }, - "style": { - "height": "32px", - "font-size":"12px" - }, - "children": [ - { - "columnFormatterReference": "[$Category]" - } - ] - } - ] - } - ] - } - ] - } -} -``` - ## Supported column types The following column types support column formatting: @@ -936,6 +705,10 @@ The following column types support column formatting: * Title (in Lists) * Yes/No * Managed Metadata +* Average Rating +* Likes +* Approval Status +* Attachments The following are currently **not** supported: @@ -966,1010 +739,28 @@ You can use the following predefined classes for several common scenarios. > [!NOTE] > The icons shown above for the `sp-field-severity` classes are **NOT** part of the class. Only the background color is included. Icons can be added by using the `iconName` attribute. -In addition to the classes listed above, the classes (such as the theme color, typography, grid system, etc.) defined by the Fluent UI can be used. For details, see the [Fluent UI website](https://developer.microsoft.com/fluentui#/styles/web/colors/products). +In addition to the classes listed above, the classes (such as the theme color, typography, grid system, etc.) defined by the Fluent UI can be used. For details, see the [Fluent UI website](https://developer.microsoft.com/fluentui#/styles/web/colors/products). ### Predefined icons -You can use predefined icons from Fluent UI. For details, see the [Fluent UI website](https://developer.microsoft.com/fluentui#/styles/web/icons). +You can use predefined icons from Fluent UI. For details, see the [Fluent UI website](https://developer.microsoft.com/fluentui#/styles/web/icons). ## Creating custom JSON -Creating custom column formatting JSON from scratch is simple if user understands the schema, Monaco Editor is integrated in the formatting pane with pre-filled JSON column schema reference to assist in creation of column formatting, Monaco editor has validation and autocomplete to help in crafting right JSON. User can start adding JSON after the first line that defines the schema location. +Creating custom column formatting JSON from scratch is simple if user understands the schema, Monaco Editor is integrated in the formatting pane with pre-filled JSON column schema reference to help creation of column formatting, Monaco editor has validation and autocomplete to help in crafting right JSON. User can start adding JSON after the first line that defines the schema location. > [!TIP] > At any point, select **Ctrl**+**Space** for property/value suggestions. > [!TIP] -> You can start from a HTML using [**formatter helper tool**](https://pnp.github.io/sp-dev-list-formatting/tools/), which can convert HTML and CSS into formatter JSON with inline styles. +> You can start from a HTML using [**formatter helper tool**](https://pnp.github.io/List-Formatting/tools/), which can convert HTML and CSS into formatter JSON with inline styles. > [!TIP] > SharePoint Patterns and Practices provides a free web part, [Column Formatter](https://github.com/SharePoint/sp-dev-solutions/blob/master/solutions/ColumnFormatter/docs/documentation/docs/getting-started.md), that can be used to edit and apply formats directly in the browser. -## Detailed syntax reference - -### elmType - -Specifies the type of element to create. Valid elements include: - -- div -- span -- a -- img -- svg -- path -- button - -Any other value will result in an error. - -#### button elements - -`Button` elements can be used to launch a specific action on the parent item. Every `button` element has a required property, `customRowAction`, that specifies an `action` that's taken when the button is clicked. This action must be one of the following values: - -- **defaultClick**: buttons with this action will do the same thing as clicking the list item in an uncustomized view. Below is an example of a button that, when clicked, simulates a click on the item, which results in opening the list item. Adding this example button to a document library simulates a click on the file or folder, which results in the file or folder being opened. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "button", - "txtContent": "Open this item", - "customRowAction": { - "action": "defaultClick" - } -} - -``` - -- **share**: Clicking the button will open the sharing dialog. Below is an example of this type of button. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "button", - "txtContent": "Share this item", - "customRowAction": { - "action": "share" - } -} - -``` - -- **delete**: Clicking the button will open the delete confirmation dialog. -- **editProps**: Clicking the button will open the item properties page in edit mode. -- **openContextMenu**: Clicking the button will open the item's default context menu. -- **executeFlow**: Clicking the button will launch the specified Flow, specified by ID inside the `actionParams` attribute. For an example of this, see the [Create a button to launch a Flow](https://docs.microsoft.com/sharepoint/dev/declarative-customization/column-formatting#create-a-button-to-launch-a-flow) section in this document. Below is an example of this type of button. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", - "elmType": "button", - "txtContent": "It's Flow Time!", - "customRowAction": { - "action": "executeFlow", - "actionParams": "{\"id\":\"f7ecec0b-15c5-419f-8211-302a5d4e94f1\", \"headerText\":\"It's Flow Time!\",\"runFlowButtonText\":\"Do it\"}" - } -} -``` - -The `actionParams` attribute can have the following options when using the `executeFlow` action: -- **id**: ID of the Flow to launch _(required)_ -- **headerText**: Sets the text at the top of the flow panel _(optional)_ -- **runFlowButtonText**: Sets the text of the primary button in the flow panel _(optional)_ - -### txtContent - -An optional property that specifies the text content of the element specified by `elmType`. The value of this property can either be a string (including special strings) or an Expression object. - -### style - -An optional property that specifies style attributes to apply to the element specified by `elmType`. This is an object with name-value pairs that correspond to CSS names and values. The values of each property in the style object can either be a string (including special strings) or an Expression object. The following style attributes are allowed. - -```JS -'background-color' -'fill' -'background-image' -'border' -'border-bottom' -'border-bottom-color' -'border-bottom-style' -'border-bottom-width' -'border-color' -'border-left' -'border-left-color' -'border-left-style' -'border-left-width' -'border-right' -'border-right-color' -'border-right-style' -'border-right-width' -'border-style' -'border-top' -'border-top-color' -'border-top-style' -'border-top-width' -'border-width' -'outline' -'outline-color' -'outline-style' -'outline-width' -'border-bottom-left-radius' -'border-bottom-right-radius' -'border-radius' -'border-top-left-radius' -'border-top-right-radius' -'box-decoration-break' -'box-shadow' -'box-sizing' - -'overflow-x' -'overflow-y' -'overflow-style' -'rotation' -'rotation-point' - -'opacity' -'cursor' - -'height' -'max-height' -'max-width' -'min-height' -'min-width' -'width' - -'flex-grow' -'flex-shrink' -'flex-flow' -'flex-direction' -'flex-wrap' -'flex' -'justify-content' -'align-items' - -'box-align' -'box-direction' -'box-flex' -'box-flex-group' -'box-lines' -'box-ordinal-group' -'box-orient' -'box-pack' - -'font' -'font-family' -'font-size' -'font-style' -'font-variant' -'font-weight' -'font-size-adjust' -'font-stretch' - -'grid-columns' -'grid-rows' - -'margin' -'margin-bottom' -'margin-left' -'margin-right' -'margin-top' - -'column-count' -'column-fill' -'column-gap' -'column-rule' -'column-rule-color' -'column-rule-style' -'column-rule-width' -'column-span' -'column-width' -'columns' - -'padding' -'padding-bottom' -'padding-left' -'padding-right' -'padding-top' - -'bottom' -'clear' -'clip' -'display' -'float' -'left' -'overflow' -'position' -'right' -'top' -'visibility' -'z-index' - -'border-collapse' -'border-spacing' -'caption-side' -'empty-cells' -'table-layout' - -'color' -'direction' -'letter-spacing' -'line-height' -'text-align' -'text-decoration' -'text-indent' -'text-transform' -'unicode-bidi' -'vertical-align' -'white-space' -'word-spacing' -'hanging-punctuation' -'punctuation-trim' -'text-align-last' -'text-justify' -'text-outline' -'text-overflow' -'text-shadow' -'text-wrap' -'word-break' -'word-wrap' -``` - -The following example shows the value of a style object. In this example, two style properties (`padding` and `background-color`) will be applied. The `padding` value is a hard-coded string value. The `background-color` value is an Expression that is evaluated to either red (`#ff0000`) or green (`#00ff00`) depending on whether the value of the current field (specified by `@currentField`) is less than 40. For more information, see the Expression object section. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "div", - "style": { - "padding": "4px", - "background-color": { - "operator": "?", - "operands": [ - { - "operator": "<", - "operands": [ - "@currentField", - 40 - ] - }, - "#ff0000", - "#00ff00" - ] - } - } -} -``` - -Here's the same sample from above, using the Excel-style expression syntax: - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "div", - "style": { - "padding": "4px", - "background-color": "=if(@currentField < 40, '#ff0000', '#00ff00')" - } -} -``` - -### attributes - -An optional property that specifies additional attributes to add to the element specified by `elmType`. This is an object with name-value pairs. Attribute names must be one of the following: - -- href -- rel -- src -- class -- target -- title -- role -- iconName -- d -- aria -- data-interception -- viewBox -- preserveAspectRatio - -Any other attribute name will result in an error. Attribute values can either be Expression objects or strings. The following example adds two attributes (`target` and `href`) to the element specified by `elmType`. The `target` attribute is hard-coded to a string. The `href` attribute is an expression that will be evaluated at runtime to http://finance.yahoo.com/quote/ + the value of the current field (`@currentField`). - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "target": "_blank", - "href": "='http://finance.yahoo.com/quote/' + @currentField" -} -``` - -### children - -An optional property that specifies child elements of the element specified by `elmType`. The value is specified as an array of `elm` objects. There can be an arbitrary level of nesting. If an element has the `txtContent` property, the child properties are ignored. - -### debugMode - -An optional property that is meant for debugging. It outputs error messages and logs warnings to the console. - -### forEach - -An optional property that allows an element to duplicate itself for each member of a specific multi-value field. The value of `"forEach"` property should be in the format of either `"iteratorName in @currentField"` or `"iteratorName in [$FieldName]"`. - -`iteratorName` represents the name of iterator variable that is used to represent the current member of the multi-value field. The name of the iterator can be any combination of alphanumeric characters and underscore (`_`) that does not start with a digit. - -The field used in the loop must be in a supported field type with multi-value option enabled: Person, Lookup, and Choice. - -In the element with `forEach` or its children elements, the iterator variable can be referred as if it is a new field. The index of the iterator can be accessed with `loopIndex` operator. - -`forEach` cannot be applied to the root element, and will render no element if there is no value in the field. - -See [here](#formatting-multi-value-fields) for examples. - -### Expressions - -Values for `txtContent`, style properties, and attribute properties can be expressed as expressions, so that they are evaluated at runtime based on the context of the current field (or row). Expression objects can be nested to contain other Expression objects. - -Expressions can be written using Excel-style expressions in SharePoint Online, or by using Abstract Syntax Tree expressions in SharePoint Online and SharePoint 2019. - -#### Excel-style expressions - -All Excel-style expressions begin with an equal (`=`) sign. This style of expression is only available in SharePoint Online (not SharePoint 2019). - -This simple conditional expression evaluates to `none` if `@me` is not equal to `[$Author.email]`, and evaluates to \`\` otherwise: -```JSON -=if(@me != [$Author.email], 'none', '') -``` - -More complex if/else statements can be written like this: -```JSON -=if([$Sentiment] <= 0.3, 'sp-field-severity--blocked', if([$Sentiment] < 0.9,'sp-field-severity--warning','sp-field-severity--good')) -``` - -Non-conditional operators that take one or two operands can be written like this: -```JSON -=[$foo] * -7 -``` -```JSON -=sin(@currentField) -``` -```JSON -=toString(60 + (sin(6.2831853 * @currentField) * 60)) -``` - -#### Abstract Syntax Tree expressions - -The following example contains an Expression object that performs the following expression: - -`(@currentField > 40) ? '100%' : (((@currentField * 2.5).toString() + '%')` - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "operator": "?", - "operands": [ - { - "operator": ">", - "operands": [ - "@currentField", - "40" - ] - }, - "100%", - { - "operator": "+", - "operands": [ - { - "operator": "toString()", - "operands": [ - { - "operator": "*", - "operands": [ - "@currentField", - 2.5 - ] - } - ] - }, - "%" - ] - } - ] -} -``` - -### Operators - -Operators specify the type of operation to perform. The following operators are valid values: - -- \+ -- \- -- / -- \* -- < -- \> -- \% -- == -- != -- <= -- \>= -- || -- && -- toString() -- Number() -- Date() -- cos -- sin -- ? -- : -- toLocaleString() -- toLocaleDateString() -- toLocaleTimeString() -- indexOf -- toLowerCase -- join -- length -- abs -- loopIndex -- floor -- ceiling -- pow -- substring -- getDate -- getMonth -- getYear -- toUpperCase -- lastIndexOf -- startsWith -- endsWith -- replace -- padStart -- padEnd - -**Binary arithmetic operators** - The following are the standard arithmetic binary operators that expect two operands: - -- \+ -- \- -- / -- \* -- < -- \> -- \% -- == -- != -- <= -- \>= - -**Unary operators** - The following are standard unary operators that expect only one operand: - -- **toString()**: returns a string representing the object - - `"txtContent": "=toString(45)"` results in _"45"_ - -- **Number()**: returns the numeric value, if the operand is not a number, NaN is returned - - `"txtContent": "=Number('365')"` results in _365_ - - `"txtContent": "=Number('Wowee')"` results in _NaN_ - - `"txtContent": "=Number(Date('12/26/1981'))"` results in _378190800000_ - -- **Date()**: returns a datetime object from the parameter (converts strings or numbers to dates, sensitive to locale) - - `"txtContent": "=Date('12/26/1981')"` results in _12/26/1981, 12:00:00 AM_ - -- **cos**: returns the cosine of the specified angle which should be specified in radians - - `"txtContent": "=cos(5)"` results in _0.28366218546322625_ - -- **sin**: returns the sine of a number - - `"txtContent": "=sin(90)"` results in _0.8939966636005579_ - -- **toLocaleString()**: returns a language sensitive representation of a date - - `"txtContent":"=toLocaleString(@now)"` results vary based on user's locale, but en-us looks like _"2/5/2019, 1:22:24 PM"_ - -- **toLocaleDateString()**: returns a language sensitive representation of just the date portion of a date - - `"txtContent":"=toLocaleDateString(@now)"` results vary based on user's locale, but en-us looks like _"2/5/2019"_ - -- **toLocaleTimeString()**: returns a language sensitive representation of just the time portion of a date - - `"txtContent":"=toLocaleTimeString(@now)"` results vary based on user's locale, but en-us looks like _"1:22:24 PM"_ - -- **toLowerCase**: returns the value converted to lower case (only works on strings) - _Only available in SharePoint Online_ - - `"txtContent":"=toLowerCase('DogFood')"` results in _"dogfood"_ - -- **abs**: returns the absolute value for a given number - _Only available in SharePoint Online_ - - `"txtContent":"=abs(-45)"` results in _45_ - -- **length**: returns the number of items in an array (multi-select person or choice field), for all other value types it returns 1 when true and 0 when false. It does NOT provide the length of a string value (*see the `indexOf` workaround explained later on for such operation*). - _Only available in SharePoint Online_ - - `"txtContent":"=length(@currentField)"` might result in _2_ if there are 2 selected values - - `"txtContent":"=length('Some Text')"` results in _1_ - - `"txtContent":"=length('')"` results in _0_ - - `"txtContent":"=length(45)"` results in _1_ - - `"txtContent":"=length(0)"` results in _0_ - -- **floor**: returns the largest integer less than or equal to a given number. - _Only available in SharePoint Online_ - - `"txtContent":"=floor(45.5)"` results in _45_ - -- **ceiling**: rounds the given number up to the next largest whole number or integer. - _Only available in SharePoint Online_ - - `"txtContent":"=ceiling(45.5)"` results in _46_ - -- **getDate**: returns the day of the month of the given date. - _Only available in SharePoint Online_ - - `"txtContent":"=getDate(Date('12/26/1981'))"` results in _26_ - -- **getMonth**: returns the month in the specified date according to local time, as a zero-based value (where zero indicates the first month of the year). - _Only available in SharePoint Online_ - - `"txtContent":"=getMonth(Date('12/26/1981'))"` results in _11_ - -- **getYear**: returns the year of the given date. - _Only available in SharePoint Online_ - - `"txtContent":"=getYear(Date('12/26/1981'))"` results in _1981_ - -- **toUpperCase**: returns the value converted to upper case (only works on strings) - _Only available in SharePoint Online_ - - `"txtContent":"=toUpperCase('DogFood')"` results in _"DOGFOOD"_ - -**Binary operators** - The following are operators that expect two operands: - -- **indexOf**: takes 2 operands. The first is the text you would like to search within, the second is the text you would like to search for. Returns the index value of the first occurrence of the search term within the string. Indexes start at 0. If the search term is not found within the text, -1 is returned. This operator is case-sensitive. - _Only available in SharePoint Online_ - - `"txtContent": "=indexOf('DogFood', 'Dog')"` results in _0_ - - `"txtContent": "=indexOf('DogFood', 'F')"` results in _3_ - - `"txtContent": "=indexOf('DogFood', 'Cat')"` results in _-1_ - - `"txtContent": "=indexOf('DogFood', 'f')"` results in _-1_ - -- **join**: takes 2 operands. The first is an array (multi-select person or choice field) and the second is the separating string. Returns a string concatenation of the array values separated by the separating string. - _Only available in SharePoint Online_ - - `"txtContent": "=join(@currentField, ', ')"` might result in _"Apple, Orange, Cherry"_ (depending on the selected values) - - `"txtContent": "=join(@currentField.title, '|')"` might result in _"Chris Kent|Vesa Juvonen|Jeff Teper"_ (depending on the selected persons) - -- **pow**: returns the base to the exponent power. - _Only available in SharePoint Online_ - - `"txtContent":"=pow(2,3)"` results in _8_ - -- **lastIndexOf**: returns the position of the last occurrence of a specified value in a string - - `"txtContent": "=lastIndexOf('DogFood DogFood', 'Dog')"` results in _8_ - - `"txtContent": "=lastIndexOf('DogFood DogFood', 'F')"` results in _11_ - - `"txtContent": "=lastIndexOf('DogFood DogFood', 'Cat')"` results in _-1_ - - `"txtContent": "=lastIndexOf('DogFood DogFood', 'f')"` results in _-1_ - -- **startsWith**: determines whether a string begins with the characters of a specified string - - `"txtContent":"=startsWith('DogFood', 'Dog')"` results in _true_ - - `"txtContent":"=startsWith('DogFood', 'Food')"` results in _false_ - -- **endsWith**: determines whether a string ends with the characters of a specified string - - `"txtContent":"=endsWith('DogFood', 'Dog')"` results in _false_ - - `"txtContent":"=endsWith('DogFood', 'Food')"` results in _true_ - -**Ternary operators** - The following are operators that expect three operands: - -- **substring**: returns the part of the string between the start and end indices. - _Only available in SharePoint Online_ - - `"txtContent":"=substring('DogFood', 3, 4)"` results in _F_ - - `"txtContent":"=substring('DogFood', 4, 3)"` results in _F_ - - `"txtContent":"=substring('DogFood', 3, 6)"` results in _Foo_ - - `"txtContent":"=substring('DogFood', 6, 3)"` results in _Foo_ - - The substring() method returns the part of the string between the start and end indexes, or to the end of the string. - -- **replace**: searches a string for a specified value and returns a new string where the specified value is replaced. Only the first instance of the value will be replaced. - - `"txtContent":"=replace('Hello world', 'world', 'everyone')"` results in _Hello everyone_ - -- **padStart**: pads the current string with another string until the resulting string reaches the given length. The padding is applied from the start of the current string. - - `"txtContent":"=padStart('DogFood', 10, 'A')"` results in _AAADogFood_ - - `"txtContent":"=padStart('DogFood', 10, 'AB')"` results in _ABADogFood_ - - `"txtContent":"=padStart('DogFood', 5, 'A')"` results in _DogFood_ - -- **padEnd**: pads the current string with a given string until the resulting string reaches the given length. The padding is applied from the end of the current string. - - `"txtContent":"=padEnd('DogFood', 10, 'A')"` results in _DogFoodAAA_ - - `"txtContent":"=padEnd('DogFood', 10, 'AB')"` results in _DogFoodABA_ - - `"txtContent":"=padEnd('DogFood', 5, 'A')"` results in _DogFood_ - -**Conditional operator** - The conditional operator is: - -- **?**: Conditional operations written in Abstract Tree Syntax use `?` as the operator. This is to achieve an expression equivalent to a ? b : c, where if the expression a evaluates to true, then the result is b, else the result is c. For Excel style expressions you write these with an `if` statement. Regardless, there are 3 operands. The first is the condition to evaluate. The second is the result when the condition is true. The third is the result when the condition is false. - - `"txtContent":"=if(4 < 5, 'yes', 'no')"` results in _"yes"_ - - `"txtContent":"=if(4 > 5, 'yes', 'no')"` results in _"no"_ - -**Multi-value field-related operators** - The following operators are only used in a context with multi-value field of type Person, Lookup, or Choice. - -- length -- join -- loopIndex - -`length`, when provided with a field name, returns the number of members in a multi-valued field. When a single-value field is provided, `length` will return 1 when there is a value in that field. - -`join` concatenates values in a multi-value field with a specified separator. The first operand shall point to a value in a multi-value field, e.g. `"@currentField.lookupValue"`, `"[$AssignedTo.title]"`. The second operand shall be a string literal that is the separator that joins the values together. - -`loopIndex`, when provided with a name of iterator variable, returns the current index (starting from 0) of the iterator. The name of iterator must be provided as a string literal. `loopIndex` would only work within the element with respective `forEach` enabled or its children elements. - -See [here](#formatting-multi-value-fields) for examples. - -**String related operators** - Some of the previously detailed operators can be used when working with string values - -- \+ -- indexOf ( *for string length workaround* ) - -`+` can be used when there is a need to concatenate strings, for instance : `"txtContent": "=[$column1] + ' ' + [$column2] + 'some other text"` - -`indexOf` Since the operator `length` doesn't work for string value types ( it will return 1 or 0 ), `indexOf` can serve us as a nice workaround to get the length of a string, for instance: `indexOf([$column1] + '^', '^')`. We will use `'^'` or any other character we may want to use to find out the end of the string. - -### operands - -Specifies the parameters, or operands for an expression. This is an array of Expression objects or base values. - -### Special string values - -The values for `txtContent`, styles, and attributes can be either strings or Expression objects. A few special string patterns for retrieving values from the fields in the list and the user's context are supported. - -#### "@currentField" - -Will evaluate to the value of the current field. - -Some field types are represented as objects. To output a value from an object, refer to a particular property inside that object. For example, if the current field is a person/group field, specify `@currentField.title` to retrieve the person's name, which is normally displayed in list views. The following are the field types that are represented as objects with a list of their properties. - -> [!NOTE] -> The `@currentField.title` returns a person's name by default. However, if the person field's Show Field has been adjusted, it may change the value of the `title` property. For example, a person field with the Show Field configured as Department will have the person's department for the `title` property. - -**People fields** - -The people field object has the following properties (with example values): - -```JSON -{ - "id": "122", - "title": "Kalya Tucker", - "email": "kaylat@contoso.com", - "sip": "kaylat@contoso.com", - "picture": "https://contoso.sharepoint.com/kaylat_contoso_com_MThumb.jpg?t=63576928822", - "department":"Human Resources", - "jobTitle":"HR Manager" -} -``` -People field can have profile hover cards along with formatting - -```json -{ - "elmType": "div", - "txtContent": "[$Editor.title]", - "defaultHoverField": "[$Editor]" -} -``` -**Date/Time fields** - -The value of Date/Time fields can be retrieved a few different ways, depending on the date format you'd like to display. The following methods for converting date values to specific formats are supported: - -* `toLocaleString()` - Displays a date type fully expanded with date and time. -* `toLocaleDateString()` - Displays a date type with just the date. -* `toLocaleTimeString()` - Displays a date type with just the time. - -For example, the following JSON will display the current field (assuming it's a date field) as a date and time string. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "div", - "txtContent": { - "operator": "toLocaleString()", - "operands" : ["@currentField"] - } -} -``` - -Here's the same sample from above, using the Excel-style expression syntax: -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "div", - "txtContent": "=toLocaleString(@currentField)" -} -``` - -**Location fields** - -The location field object has the following properties (with example values): - -```JSON -{ - "Address": { - "City": "Knoxville", - "CountryOrRegion": "United States", - "State": "TN", - "Street": "963 Worlds Fair Park Dr" - }, - "Coordinates": { - "Latitude": "35.961673736572266", - "Longitude": "-83.92420959472656" - }, - "DisplayName": "World's Fair Park", - "LocationUri": "https://www.bingapis.com/api/v6/localentities/8346bf26-6da4-104c-6ba5-2334b83f6ac8?setLang=en" -} -``` - -> [!NOTE] -> Location fields do not currently have a "Format this column" option in the list view and formats applied directly to these fields will need to be done through field settings. - -
- -The following example shows how a location field might be used on a current field. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", - "elmType": "div", - "style": { - "display": "block" - }, - "children": [ - { - "elmType": "a", - "txtContent": "@currentField.DisplayName", - "attributes": { - "href": "='https://www.bing.com/maps?cp=' + @currentField.Coordinates.Latitude + '~' + @currentField.Coordinates.Longitude + '&lvl=17&sV=2'", - "target": "_blank", - "title": "=@currentField.Coordinates.Latitude + ', ' + @currentField.Coordinates.Longitude" - }, - "style": { - "display": "block" - } - }, - { - "elmType": "div", - "txtContent": "@currentField.Address.Street" - }, - { - "elmType": "div", - "txtContent": "=@currentField.Address.City + ', ' + @currentField.Address.State" - }, - { - "elmType": "div", - "txtContent": "@currentField.Address.CountryOrRegion" - } - ] -} -``` - - -**Lookup fields** - -The lookup field object has the following properties (with example values): - -```JSON -{ - "lookupId": "100", - "lookupValue": "North America", -} -``` - -
- -The following example shows how a lookup field might be used on a current field. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "a", - "txtContent": "@currentField.lookupValue", - "attributes": { - "href": { - "operator": "+", - "operands": [ - "https://contoso.sharepoint.com/teams/Discovery/Lists/Regions/DispForm.aspx?ID=", - "@currentField.lookupId" - ] - }, - "target": "_blank" - } -} -``` - -**Hyperlink fields** - -The hyperlink field object has the following property (with example value): - -```JSON -{ - "desc": "SharePoint Patterns and Practices", -} -``` - -
- -To reference the URL value, use `@currentField`. - -The following example shows how a hyperlink field might be used on a current field. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "a", - "txtContent": "@currentField.desc", - "attributes": { - "href": "@currentField", - "target": "_blank" - } -} -``` - -**Image fields** - -The image field object has the following properties (with example values): - -```JSON -{ - "fileName": "image.png", - "id": "6bb1d843-0633-4c9a-9a16-90bc5abd1d8e", - "serverRelativeUrl": "/teams/Discovery/SiteAssets/Lists/ad6ed939-0db2-4d85-8a39-8f3497f41eee/image.png", - "serverUrl": "https://contoso.sharepoint.com" -} - -``` - -
- -The following example shows how an image field can be used on a current field. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "img", - "attributes": { - "src": "@currentField.serverRelativeUrl", - "alt": "@currentField.fileName" - }, - "style": { - "width": "100%", - "max-width": "100%" - } -} -``` - - -#### "[$FieldName]" - -The column is formatted within the context of the entire row. You can use this context to reference the values of other fields within the same row by specifying the **internal name** of the field surrounded by square brackets and preceded by a dollar sign: `[$InternalName]`. For example, to get the value of a field with an internal name of "MarchSales", use `[$MarchSales]`. - -If the value of a field is an object, the object's properties can be accessed. For example, to access the "Title" property of a person field named "SalesLead", use "[$SalesLead.title]". - -#### "[!FieldName]" - -In column and view formatting, you can refer to any field's metadata by specifying the **internal name** of the field surrounded by square brackets and preceded by a exclamation mark: `[!InternalName]`. - -Currently field's display name is available in this metadata, and can be accessed using DisplayName property: `[!SalesLead.DisplayName]`. - - -#### "@currentWeb" - -This will evaluate to the absolute URL for the site. This is equivalent to the `webAbsoluteUrl` value within the page context. This value is only available in SharePoint Online. - -#### "@me" - -This will evaluate to the email address of the current logged in user. - -This field can be used to display the current user's email address, but more likely it will be used within conditions. The following is an example of setting the color for a person field to red when it is equal to the current logged in user and blue otherwise: - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "div", - "txtContent": "@currentField.title", - "style": { - "color": { - "operator": "?", - "operands": [ - { - "operator": "==", - "operands": [ - "@me", - "@currentField.email" - ] - }, - "red", - "blue" - ] - } - } -} -``` - -Here's the same sample from above, using the Excel-style expression syntax: - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "div", - "txtContent": "@currentField.title", - "style": { - "color": "=if(@me == @currentField.email, 'red', 'blue')" - } -} -``` - -#### "@now" - -This will evaluate to the current date and time. - -#### "@rowIndex" - -This will evaluate to the rendered index of a row within a view. This value is based on render position and will remain consistent based on position even as views are sorted and filtered. Indexes start at 0. This value is only available in SharePoint Online. - -Here's an example of using the value within a view format to apply alternating styles to rows: - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json", - "additionalRowClass": "=if(@rowIndex % 2 == 0,'ms-bgColor-themeLighter ms-bgColor-themeLight--hover','')" -} -``` - -#### "@window.innerHeight" - -This will evaluate to a number equal to the height of the browser window (in pixels) when the list was rendered. - -#### "@window.innerWidth" - -This will evaluate to a number equal to the width of the browser window (in pixels) when the list was rendered. - -#### Thumbnails - -In a document library, there is a series of tokens that can be used to retrieve the URL to the thumbnail of a file, including: - -- `@thumbnail.small`, `@thumbnail.medium`, and `@thumbnail.large` evaluate to the thumbnail URL in 3 different predefined sizes. -- `@thumbnail.` evaluates to the URL to the largest thumbnails that is not larger than the bounding size in both width and height. For example, `@thumbnail.150` evaluates to the URL to a thumbnail not larger than 150×150 pixels. -- `@thumbnail.x` evaluates to the URL to the largest thumbnail that is not larger than the bounding width and bounding height. For example, `@thumbnail.100x200` evaluates to the URL to a thumbnail not wider than 100 pixels and not higher than 200 pixels. - -These tokens will yield no value on non-file items including folders. - -> [!NOTE] -> The aspect ratio of thumbnail generated is the same as how the file looks like, changing the bounding sizes will not affect the aspect ratio of the thumbnail. - -> [!TIP] -> Thumbnails are only available for a list of supported file formats. It means that sometimes the URL generated is not accessible due to lack of support on certain formats. However, if a valid thumbnail token is set as the _only_ `src` attribute of an `img` tag, we will take care of it and hide the image when it is not available. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", - "elmType": "img", - "attributes": { - "src": "@thumbnail.200x150", - "alt": "='Thumbnail of file ' + [$FileLeafRef]" - }, - "style": { - "width": "100%", - "max-width": "100%" - } -} -``` -Default file hover card using FileLeafRef - -```JSON - { - "elmType": "img", - "style": { - "width": "100%", - "height": "100%", - "display": "=if([$File_x0020_Type] == '', 'none', '')" - }, - "attributes": { - "src": "@thumbnail.300x300" - }, - "defaultHoverField": "[$FileLeafRef]" -} - ``` - -#### displayValue - -The following column types can use displayValue property to get the default rendered value, based on the column setting -* Date/Time -* Number -* Yes/No -* Currency - -```JSON - { - "elmType": "div", - "txtContent": "@currentField.displayValue" -} -``` -This also works with field name -```JSON - { - "elmType": "div", - "txtContent": "[$FieldName.displayValue]" -} -``` - -#### columnFormatterReference - -This will be replaced with the referenced column's formatter JSON. Multi level reference is not supported. - -```JSON -{ - "columnFormatterReference": "[$FieldName]" -} -``` - ## See also - [Column formatting](https://support.office.com/article/Column-formatting-1f927342-2bed-4745-b727-ff8b7ff96b22?ui=en-US&rs=en-US&ad=US) +- [View formatting](./view-formatting.md) +- [Advanced formatting concepts](./formatting-advanced.md) +- [Formatting syntax reference](./formatting-syntax-reference.md) diff --git a/docs/declarative-customization/customize-default-site-design.md b/docs/declarative-customization/customize-default-site-design.md index 2745f3259..afffc07db 100644 --- a/docs/declarative-customization/customize-default-site-design.md +++ b/docs/declarative-customization/customize-default-site-design.md @@ -1,66 +1,60 @@ ---- -title: Customize default site designs in SharePoint -description: Customize the default site designs in either the SharePoint Team site or Communication site template. -ms.date: 06/18/2020 -localization_priority: Priority ---- - -# Customize a default site design - -SharePoint contains several site designs already available in the SharePoint Online site templates. These are the default site designs. You can modify them by using PowerShell or the REST APIs to control the entire site provisioning experience. For example, you can ensure that your company theme is applied to every site that gets created, or you can make sure a logging mechanism always runs regardless of which site design is chosen. - -## Apply a site design to the default site designs - -To customize the default site designs, apply a new one with the PowerShell **Add-SPOSiteDesign** cmdlet or the **CreateSiteDesign** REST API. Specify the **IsDefault** switch to apply the site design as the default. - -The WebTemplate ID for a group-connected Team site is 64; for a Communication site it is 68. - -The following example shows how to use the **IsDefault** switch to apply the Contoso company theme to the default site designs. The site script referenced by ID contains the JSON script to apply the correct theme. - -```powershell -C:\> Add-SPOSiteDesign ` - -Title "Contoso company theme" ` - -WebTemplate "68" ` - -SiteScripts "89516c6d-9f4d-4a57-ae79-36b0c95a817b" ` - -Description "Applies standard company theme to site" ` - -IsDefault -``` - -
- -```javascript -RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.CreateSiteDesign", {info:{Title:"Contoso company theme", Description:"Applies standard company theme to site", SiteScriptIds:["89516c6d-9f4d-4a57-ae79-36b0c95a817b"], WebTemplate:"68", IsDefault: true}}); -``` - -### Which default site designs are updated? - -In the previous example, the **WebTemplate** value of `"68"` refers to the SharePoint Online Communication site template. That template contains the following default site designs: - -- Topic -- Showcase -- Blank - -When you apply a new site design, it updates all three default site designs at the same time. - -The SharePoint Online Team site template contains only one default site design named **Team**. In this case, when you apply a default site design, only the **Team** site design is updated. - -## Restore the default site designs - -To restore a site design to the defaults, remove the site design that you applied. In the previous example, if the site design created had the ID `db752673-18fd-44db-865a-aa3e0b28698e`, you would remove it as shown in the following example. - -```powershell -C:\> Remove-SPOSiteDesign db752673-18fd-44db-865a-aa3e0b28698e -``` - -
- -```javascript -RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.DeleteSiteDesign", {id:"db752673-18fd-44db-865a-aa3e0b28698e"}); -``` - -> [!NOTE] -> If you're not sure which site design is the default, run the **Get-SPOSiteDesign** cmdlet. It will list all site designs, and indicates which ones are defaults. - -## See also - -- [SharePoint site design and site script overview](site-design-overview.md) +--- +title: Customize default site templates in SharePoint +description: Customize the default site templates for the SharePoint Team site or Communication site template. +ms.date: 06/28/2022 +ms.localizationpriority: high +--- + +# Customize a default site template + +SharePoint offers several [site templates that are already available](https://support.microsoft.com/office/apply-and-customize-sharepoint-site-templates-39382463-0e45-4d1b-be27-0e96aeec8398). These are the default site templates and they can be modified by using PowerShell or the REST APIs to control the entire site provisioning experience. For example, you can ensure that your company theme is applied to every site that gets created, or you can make sure a logging mechanism always runs regardless of which site template is chosen. + +## Apply a site script to a default site template + +To customize a default site template, apply a new template script using PowerShell **Add-SPOSiteDesign** cmdlet or the **CreateSiteDesign** REST API. Specify the **IsDefault** switch to apply the site template as the default template. + +| Parameter | Value | Site template type | +| :------------------- | :------------------- |:----------------| +| WebTemplate | 64 | Team site template | +| WebTemplate | 1 | Team site (with group creation disabled) | +| WebTemplate | 68 | Communication site template | +| WebTemplate | 69 | Channel site template | + +The following example shows how to use the **IsDefault** switch to apply the Contoso company theme to the default site templates. The site script referenced by ID contains the JSON script to apply the correct theme. + +```powershell +C:\> Add-SPOSiteDesign ` + -Title "Contoso company theme" ` + -WebTemplate "68" ` + -SiteScripts "89516c6d-9f4d-4a57-ae79-36b0c95a817b" ` + -Description "Applies standard company theme to site" ` + -IsDefault +``` + +```javascript +RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.CreateSiteDesign", {info:{Title:"Contoso company theme", Description:"Applies standard company theme to site", SiteScriptIds:["89516c6d-9f4d-4a57-ae79-36b0c95a817b"], WebTemplate:"68", IsDefault: true}}); +``` + +### Which default site templates are updated? + +The default site template for a communication site is the **Topic** template. The default for a team site is the **Team collaboration** template. When you apply a new default site template, it updates the Microsoft-provided default templates. + +## Restore the default site templates + +To restore a site template to the defaults, remove the site template script that you applied. In the previous example, if the site template created had the ID `db752673-18fd-44db-865a-aa3e0b28698e`, you would remove it as shown in the following example. + +```powershell +C:\> Remove-SPOSiteDesign db752673-18fd-44db-865a-aa3e0b28698e +``` + +```javascript +RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.DeleteSiteDesign", {id:"db752673-18fd-44db-865a-aa3e0b28698e"}); +``` + +> [!NOTE] +> If you're not sure which site template is the default, run the **Get-SPOSiteDesign** cmdlet. It will list all site templates, and indicates which ones are defaults. + +## See also + +- [SharePoint site template and site script overview](site-design-overview.md) +- [Browse and customize Microsoft-provided site templates](https://support.microsoft.com/office/apply-and-customize-sharepoint-site-templates-39382463-0e45-4d1b-be27-0e96aeec8398) diff --git a/docs/declarative-customization/formatting-advanced.md b/docs/declarative-customization/formatting-advanced.md new file mode 100644 index 000000000..5a4d79813 --- /dev/null +++ b/docs/declarative-customization/formatting-advanced.md @@ -0,0 +1,376 @@ +--- +title: Advanced formatting concepts +description: Advanced formatting concepts +ms.date: 07/16/2025 +ms.localizationpriority: high +--- +# Advanced formatting concepts + +You can use some of the following features to make your view and column formatting more information-rich and interactive. + +## Create a button to launch a Flow + +The following screenshot shows a list with a Flow button added to the Action column: + +![screenshot of the sample](../images/sp-columnformatting-flow.png) + +You can use column formatting to create buttons that, when selected, run Flows on the corresponding list item. For flows that are [solution-aware](/power-automate/overview-solution-flows), the Flow Launch Panel will be displayed after choosing the button, and you must select Run Flow to start the flow. For flows that aren't solution-aware, the Flow Launch Panel will be displayed after selecting the button, and the Flow will just run. + +To use the sample below, you must substitute the ID of the Flow you want to run. This ID is contained within the `actionParams` property of the `customRowAction` attribute inside the `button` element. + +To obtain the ID of a flow that is solution-aware: + +1. Select **Flow > See your flows** in the SharePoint list where the Flow is configured. +1. If applicable, [switch to the environment](/power-platform/admin/working-with-environments#switch-the-environment) in which the Flow is hosted. +1. Select the Solutions area. +1. Select the solution in which the Flow was created. +1. Filter for Cloud flows and select the Flow you want to run. +1. Select Export > Get flow identifier. +1. Copy the ID. + +To obtain the ID of a flow that isn't solution-aware: + +1. Switch to the environment in which the Flow is hosted. +1. Select the Flow you want to run. +1. Select Export > Get flow identifier. +1. Copy the ID. + + ```JSON + { + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "button", + "customRowAction": { + "action": "executeFlow", + "actionParams": "{\"id\": \"edf627d9-20f4-45ba-8bc9-4494bf2ff1be\"}" + }, + "attributes": { + "class": "ms-fontColor-themePrimary ms-fontColor-themeDarker--hover" + }, + "style": { + "border": "none", + "background-color": "transparent", + "cursor": "pointer" + }, + "children": [ + { + "elmType": "span", + "attributes": { + "iconName": "Flow" + }, + "style": { + "padding-right": "6px" + } + }, + { + "elmType": "span", + "txtContent": "Send to Manager" + } + ] + } + ``` + +Additionally, you can use `headerText` and `runFlowButtonText` options within the `actionParams` property to customize portions of the Flow panel itself! See the [button elements](./formatting-syntax-reference.md#customrowaction) portion of the Detailed syntax reference for more details. + +## Custom cards on hover + +The following image shows a list with a custom hover added to a List: + +On hover - Metadata on the column "Status" is made available in view formatting: + +![Preview Image 1](../images/HoverImage-1.png) + +On hover - Metadata on the column "Status" is made available in column formatting: + +![Preview Image 2](../images/HoverImage-2.png) + +You can use formatting to define a custom callout that can be commissioned user-defined basis, actions like click or hover. + +This example uses `customCardProps`, `openOnEvent`, `directionalHint`, and `isBeakVisible`: + +```JSON +{ + "elmType": "div", + "style": { + "font-size": "12px" + }, + "txtContent": "[$Status]", + "customCardProps": { + "formatter": { + "elmType": "div", + "txtContent": "Define your formatter options inside the customCardProps/formatter property" + }, + "openOnEvent": "hover", + "directionalHint": "bottomCenter", + "isBeakVisible": true, + "beakStyle" : { + "backgroundColor": "white" + } + } +} +``` + +## Default cards on hover + +Users can now have a profile card or a file hover card on formatters too. Some of the things users can now do: + +- Profile card or File Hover card on any column +- Profile card or Hover card with view formatting + +Hover on a filename with formatting with the default file card: + +![Preview Image 3](../images/HoverImage-3.png) + +Hover on a person column with formatting with the default Profile card: + +![Preview Image 4](../images/HoverImage-4.png) + +This example uses `defaultHoverField`: + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "div", + "children": [ + { + "elmType": "img", + "style": { + "width": "32px", + "height": "32px", + "overflow": "hidden", + "border-radius": "50%", + "margin": "2px" + }, + "attributes": { + "src": "=getUserImage([$Editor.email], 's')", + "title": "[$Editor.title]" + } + }, + { + "elmType": "span", + "style": { + "vertical-align": "middle", + "margin-left": "2px" + }, + "txtContent": "[$Editor.title]" + } + ], + "defaultHoverField": "[$Editor]" +} +``` + +## Column formatter reference + +Users can refer to a column's formatter JSON inside another column/view formatter and use it along with other elements to build a custom column visualization. This can be done by using `columnFormatterReference` property. + +The following image shows a list with a Gallery layout referencing the Category column formatter: + +![Gallery layout referring Category column](../images/sp-columnformatting-formatter-reference-1.png) + +![List layout with Category column formatted](../images/sp-columnformatting-formatter-reference-2.png) + +``` JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/tile-formatting.schema.json", + "height": 127, + "width": 254, + "hideSelection": false, + "formatter": { + "elmType": "div", + "attributes": { + "class": "sp-card-container" + }, + "children": [ + { + "elmType": "button", + "attributes": { + "class": "sp-card-defaultClickButton" + }, + "customRowAction": { + "action": "defaultClick" + } + }, + { + "elmType": "div", + "attributes": { + "class": "ms-bgColor-white sp-css-borderColor-neutralLight sp-card-borderHighlight sp-card-subContainer" + }, + "children": [ + { + "elmType": "div", + "attributes": { + "class": "sp-card-displayColumnContainer" + }, + "children": [ + { + "elmType": "p", + "attributes": { + "class": "ms-fontColor-neutralSecondaryAlt sp-card-label" + }, + "txtContent": "[!Title.DisplayName]" + }, + { + "elmType": "p", + "attributes": { + "title": "[$Title]", + "class": "ms-fontColor-neutralPrimary sp-card-content sp-card-highlightedContent" + }, + "txtContent": "=if ([$Title] == '', '–', [$Title])" + } + ] + }, + { + "elmType": "div", + "attributes": { + "class": "sp-card-lastTextColumnContainer" + }, + "children": [ + { + "elmType": "p", + "attributes": { + "class": "ms-fontColor-neutralSecondaryAlt sp-card-label" + }, + "txtContent": "[!Category.DisplayName]" + }, + { + "elmType": "div", + "attributes": { + "class": "sp-card-content" + }, + "style": { + "height": "32px", + "font-size":"12px" + }, + "children": [ + { + "columnFormatterReference": "[$Category]" + } + ] + } + ] + } + ] + } + ] + } +} +``` + +## Inline Editing + +With inline editing, formatters have the ability to load field editors to edit field data on an item. +Users need to have edit permissions on the list item, and the field type should belong to a set of supported types for this feature to work. + +A special JSON property `inlineEditField` is used with value as the field internal name __`[$FieldName]`__ at the target element in the JSON. + +```json +{ + "elmType": "div", + "inlineEditField": "[$FieldName]", + "txtContent": "[$FieldName]" +} +``` + +![Inline Editing using inlineEditField property](../images/sp-columnformatting-inline-editing.gif) + +This allows the users to edit items in-place, within the view, without navigating away to grid-based editing or to an item edit form. + +### Supported Field Types + +List of supported field types for inline editing: + +- Single line text +- Multiline text (without RTF) +- Number +- DateTime +- Choice and MultiChoice +- User and Multiuser +- Lookup + +### Hover Borders and Customizations + +The inline editing adds a hover border on the elements to indicate that these elements have an associated action. The default border is `neutralSecondary`, and on click, the editor appears with a `themePrimary` border. These border colors can be overridden via setting style on the same element with `inlineEditField` by using some special attributes - `--inline-editor-border-width`, `--inline-editor-border-style`, `--inline-editor-border-radius`, and `--inline-editor-border-color`. + +```json +{ + "elmType": "div", + "inlineEditField": "[$FieldName]", + "txtContent": "[$FieldName]", + "style": { + "--inline-editor-border-color": "transparent transparent red transparent", + "border-color": "gray", + "border-width": "1px", + "border-style": "solid" + } +} +``` + +## Set multiple field values of an Item using customRowAction + +With the new `setValue` and `customRowAction` properties, formatters can render action buttons that modify the item internally without opening editors or forms. `setValue` also allows setting multiple field values of the item at once. + +The below JSON will set the value of `FieldInternalName_1`, `FieldInternalName_2`, and `FieldInternalName_3`with the values provided: + +```json +{ + "elmType": "div", + "txtContent": "[$FieldName]", + "customRowAction":{ + "action": "setValue", + "actionInput": { + "FieldInternalName_1": "FieldValue_1", + "FieldInternalName_2": "FieldValue_2", + "FieldInternalName_3": "=if([$Status] == 'Completed', 'yes', 'no')" + } + } +} +``` + +### Supported Field Types + +- Single line text +- Multiline text (without RTF) +- Number +- DateTime +- Choice and MultiChoice +- User and Multiuser + +### Value Field values in `actionInput`: + +- Text values: + - a valid string like `"Choice 1"` + - value from other columns: `[$ColumnName]` + - an [expression](./formatting-syntax-reference.md#expressions) such as: + + ``` + "if([$column]> 10, "Choice A", "Choice B")" + ``` + + or + + ``` + {operator: "+", operands" : ["Choice", "A"]} + ``` + +- Number: + - a valid number + - value from other columns: `[$ColumnName]` + - an [expression](./formatting-syntax-reference.md#expressions) +- Date values: + - a date string + - `@now` token + - [expressions](./formatting-syntax-reference.md#expressions) that return a date using built-in date functions + - `addDays` and `addMinutes`, two new functions to support [expressions](./formatting-syntax-reference.md#expressions) like seven days from today + - an empty string `""` clears the field value +- Multi-Choice and Multi-Person: + - Multi-value fields are special, as they need an array value to save multiple values. + - `appendTo`, `removeFrom`, and `replace`, three functions that can operate on multivalue fields. + - `appendTo([$MultiChoiceField], 'MyValue')` + - `removeFrom([$MultiUserField], @me)`: removes all occurrences that match the second parameter + - `replace([$MultiChoiceField], 'Choice 1', 'Choice 3')`: replaces all occurrences of the second parameter with the third. +- Person field values: + - user name or email + - An empty string `""` clears the field value + - an [expression](./formatting-syntax-reference.md#expressions) which returns these values + + > [!NOTE] + > A query runs with the string value provided on the people column, and the first person in the returned results is used. diff --git a/docs/declarative-customization/formatting-syntax-reference.md b/docs/declarative-customization/formatting-syntax-reference.md new file mode 100644 index 000000000..bf3f244cf --- /dev/null +++ b/docs/declarative-customization/formatting-syntax-reference.md @@ -0,0 +1,1229 @@ +--- +title: Formatting syntax reference +description: Formatting syntax reference +ms.date: 02/19/2025 +ms.localizationpriority: high +--- + +# Formatting syntax reference + +## elmType + +Specifies the type of element to create. Valid elements include: + +- `div` +- `span` +- `a` +- [`img`](#img-src-security) +- `svg` +- `path` +- `button` +- `p` +- [`filepreview`](#filepreview) + +Any other value will result in an error. + +### filepreview + +Use the special `elmType` `filepreview` with the `src` attribute set to [`@thumbnail.`](#thumbnails) to view thumbnails for files in your document library. + +If the thumbnail loads successfully, a small [brand type icon](https://developer.microsoft.com/fluentui#/styles/web/office-brand-icons) is visible on the bottom left. If the thumbnail fails to load (or if the file type doesn't support thumbnails), a [file type icon](https://developer.microsoft.com/fluentui#/styles/web/file-type-icons) is shown instead. + +```json +"elmType": "filepreview", +"attributes": { + "src": "@thumbnail.medium" +} +``` + +### img src security + +Images from the following domains are allowed: + +- tenant domain, configured multi-geo domains and vanity domains (`company.sharepoint.com`) +- `cdn.office.net`, `akamaihd.net`, `static2.sharepointonline.com` CDNs + +Most other external image sources are blocked by default in custom formatters. To include external images and allow specific domains or CDNs, the domain needs to be added to a site-level setting. For more information see: [Allow or restrict the ability to embed content on SharePoint pages](https://support.microsoft.com/office/allow-or-restrict-the-ability-to-embed-content-on-sharepoint-pages-e7baf83f-09d0-4bd1-9058-4aa483ee137b) + +## txtContent + +An optional property that specifies the text content of the element specified by `elmType`. The value of this property can either be a string (including special strings) or an Expression object. + +## style + +An optional property that specifies style attributes to apply to the element specified by `elmType`. This is an object with name-value pairs that correspond to CSS names and values. The values of each property in the style object can either be a string (including special strings) or an Expression object. The following style attributes are allowed. + +> [!CAUTION] +> Float style prop no longer supported in custom formatter. Users are encouraged to use Gallery View as a more stable alternative. + +```javascript +'background-color' +'fill' +'background-image' +'border' +'border-bottom' +'border-bottom-color' +'border-bottom-style' +'border-bottom-width' +'border-color' +'border-left' +'border-left-color' +'border-left-style' +'border-left-width' +'border-right' +'border-right-color' +'border-right-style' +'border-right-width' +'border-style' +'border-top' +'border-top-color' +'border-top-style' +'border-top-width' +'border-width' +'outline' +'outline-color' +'outline-style' +'outline-width' +'border-bottom-left-radius' +'border-bottom-right-radius' +'border-radius' +'border-top-left-radius' +'border-top-right-radius' +'box-decoration-break' +'box-shadow' +'box-sizing' + +'overflow-x' +'overflow-y' +'overflow-style' +'rotation' +'rotation-point' + +'opacity' +'cursor' + +'height' +'max-height' +'max-width' +'min-height' +'min-width' +'width' + +'flex-grow' +'flex-shrink' +'flex-flow' +'flex-direction' +'flex-wrap' +'flex' +'justify-content' +'align-items' + +'box-align' +'box-direction' +'box-flex' +'box-flex-group' +'box-lines' +'box-ordinal-group' +'box-orient' +'box-pack' + +'font' +'font-family' +'font-size' +'font-style' +'font-variant' +'font-weight' +'font-size-adjust' +'font-stretch' + +'grid-columns' +'grid-rows' + +'margin' +'margin-bottom' +'margin-left' +'margin-right' +'margin-top' + +'column-count' +'column-fill' +'column-gap' +'column-rule' +'column-rule-color' +'column-rule-style' +'column-rule-width' +'column-span' +'column-width' +'columns' + +'padding' +'padding-bottom' +'padding-left' +'padding-right' +'padding-top' + +'bottom' +'clear' +'clip' +'display' +'float' (Deprecated) +'left' +'overflow' +'position' +'right' +'top' +'visibility' +'z-index' + +'border-collapse' +'border-spacing' +'caption-side' +'empty-cells' +'table-layout' + +'color' +'direction' +'letter-spacing' +'line-height' +'text-align' +'text-decoration' +'text-indent' +'text-transform' +'unicode-bidi' +'vertical-align' +'white-space' +'word-spacing' +'hanging-punctuation' +'punctuation-trim' +'text-align-last' +'text-justify' +'text-outline' +'text-overflow' +'text-shadow' +'text-wrap' +'word-break' +'word-wrap' + +'stroke' +'fill-opacity' + +'--inline-editor-border-width' +'--inline-editor-border-style' +'--inline-editor-border-radius' +'--inline-editor-border-color' + +'-webkit-line-clamp' + +'object-fit' +'transform' // Only translate(arg) and translate(arg, arg) are currently supported +``` + +The following example shows the value of a style object. In this example, two style properties (`padding` and `background-color`) will be applied. The `padding` value is a hard-coded string value. The `background-color` value is an Expression that is evaluated to either red (`#ff0000`) or green (`#00ff00`) depending on whether the value of the current field (specified by `@currentField`) is less than 40. For more information, see the [Expression object section](#expressions). + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "div", + "style": { + "padding": "4px", + "background-color": { + "operator": "?", + "operands": [ + { + "operator": "<", + "operands": [ + "@currentField", + 40 + ] + }, + "#ff0000", + "#00ff00" + ] + } + } +} +``` + +Here's the same sample from above, using the Excel-style expression syntax: + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "div", + "style": { + "padding": "4px", + "background-color": "=if(@currentField < 40, '#ff0000', '#00ff00')" + } +} +``` + +## attributes + +The `attributes` optional property specifies more attributes to add to the element specified by `elmType`. This is an object with name-value pairs. Attribute names must be one of the following: + +- href +- rel +- src +- class +- target +- title +- role +- iconName +- d +- aria +- data-interception +- viewBox +- preserveAspectRatio +- draggable + +Any other attribute name will result in an error. Attribute values can either be Expression objects or strings. The following example adds two attributes (`target` and `href`) to the element specified by `elmType`. The `target` attribute is hard-coded to a string. The `href` attribute is an expression that will be evaluated at runtime to `http://finance.yahoo.com/quote/` + the value of the current field (`@currentField`). + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "target": "_blank", + "href": "='http://finance.yahoo.com/quote/' + @currentField" +} +``` + +## children + +The `children` optional property specifies child elements of the element specified by `elmType`. The value is specified as an array of `elm` objects. There can be an arbitrary level of nesting. If an element has the `txtContent` property, the child properties are ignored. + +## debugMode + +The `debugMode` optional property is meant for debugging. It outputs error messages and logs warnings to the console. + +## forEach + +The `forEach` optional property allows an element to duplicate itself for each member of a specific multi-value field or an array. The value of `"forEach"` property should be in the format of either `"iteratorName in @currentField"` or `"iteratorName in [$FieldName]"` or `"iteratorName in Expression-Returning-An-Array"`. + +`iteratorName` represents the name of the iterator variable that is used to represent the current member of the multi-value field. The name of the iterator can be any combination of alphanumeric characters and an underscore (`_`) that doesn't start with a digit. + +The field used in the loop must be in a supported field type with multi-value options enabled: Person, Lookup, and Choice. An expression returning an array can also be used. + +In the element with `forEach` or its children elements, the iterator variable can be referred to as if it's a new field. The index of the iterator can be accessed with `loopIndex` operator. + +`forEach` can't be applied to the root element, and will render no element if there's no value in the field. + +See [Formatting multi-value fields](column-formatting.md#formatting-multi-value-fields) for examples. + +## customRowAction + +`button` elements can be used to launch a specific action on the parent item. Every `button` element has a required property, `customRowAction`, that specifies an `action` that's taken when the button is selected. This action must be one of the following values: + +- **defaultClick**: buttons with this action will do the same thing as clicking the list item in an uncustomized view. The following example demonstrates a button that, when selected, simulates a selection on the item, which results in opening the list item. Adding this example button to a document library simulates a selection on the file or folder, which results in the file or folder being opened. + + ```json + { + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "button", + "txtContent": "Open this item", + "customRowAction": { + "action": "defaultClick" + } + } + ``` + +- **share**: Selecting the button will open the sharing dialog. The following is an example of this type of button: + + ```json + { + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "button", + "txtContent": "Share this item", + "customRowAction": { + "action": "share" + } + } + ``` + +- **delete**: Selecting the button will open the delete confirmation dialog. +- **editProps**: Selecting the button will open the item properties page in edit mode. +- **openContextMenu**: Selecting the button will open the item's default context menu. +- **setValue**: Selecting the element will update the item with the field values provided. + + ```json + { + "elmType": "div", + "txtContent": "[$FieldName]", + "customRowAction":{ + "action": "setValue", + "actionInput": { + "FieldInternalName_1": "FieldValue_1", + "FieldInternalName_2": "FieldValue_2" + } + } + } + ``` + +- **executeFlow**: Selecting the button will launch the specified Flow, specified by ID inside the `actionParams` attribute. For an example of this, see [Create a button to launch a Flow](./formatting-advanced.md#create-a-button-to-launch-a-flow). The following example demonstrates this type of button: + + ```json + { + "$schema": "https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", + "elmType": "button", + "txtContent": "It's Flow Time!", + "customRowAction": { + "action": "executeFlow", + "actionParams": "{\"id\":\"f7ecec0b-15c5-419f-8211-302a5d4e94f1\", \"headerText\":\"It's Flow Time!\",\"runFlowButtonText\":\"Do it\"}" + } + } + ``` + + The `actionParams` attribute can have the following options when using the `executeFlow` action: + + - **id**: ID of the Flow to launch _(required)_ + - **headerText**: Sets the text at the top of the flow panel _(optional)_ + - **runFlowButtonText**: Sets the text of the primary button in the flow panel _(optional)_ + +- **embed**: Clicking on the button will open a callout with content embedded in it. The content will be determined by the URL provided in the `src` attribute in `actionInput`. You can also control the `height` and `width` of the callout using the `actionInput`. + + > [!NOTE] + > + > - The `src` needs to be just the `url` part of an embeddable code generated by an app (usually found in the `src` attribute of the `iframe` element). + > - This action is only available in the newer version of the Microsoft Lists App. + + For more information about allowing or restricting domains, see [Allow or restrict the ability to embed content on SharePoint Lists using custom formatters](https://go.microsoft.com/fwlink/p/?linkid=2258033). + + + ```json + { + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "button", + "customRowAction": { + "action": "embed", + "actionInput": { + "src": "https://www.relecloud.com/embed/ll00hWQMJxQ", + "height": "350", + "width": "700" + } + }, + "txtContent": "Click here to open recipe video 👩‍🍳" + } + ``` + + The `actionInput` attribute can have the following options when using the `embed` action: + + - **src**: The URL of the content you want to embed. _(required)_ + - **height**: The height of the callout within which the embedded content will render. The default value is 300. _(optional)_ + - **width**: The width of the callout within which the embedded content will render. The default value is 300. _(optional)_ + +## customCardProps + +Add a custom card to the element, that shows up on hover or `click` event. The following customizations are available: + +- `"formatter"`: JSON object that defines formatting for custom cards. +- `"openOnEvent"`: Event on which the customCard should open. + - Valid values: `click`, `hover` +- `"directionalHint"`: Specify the direction relative to the target in which the custom card will be positioned. This is the preferred location but it isn't guaranteed depending on space. + - Valid values: `bottomAutoEdge`, `bottomCenter`, `bottomLeftEdge`, `bottomRightEdge`, `leftBottomEdge`, `leftCenter`, `leftTopEdge`, `rightBottomEdge`, `rightCenter`, `rightTopEdge`, `topAutoEdge`, `topCenter`, `topLeftEdge`, `topRightEdge` +- `"isBeakVisible"`: Specify if the beak is to be shown or not. +- `"beakStyle"`: Specifies the style object for the custom card's beak. + +## defaultHoverField + +Adds the profile card for the people fields or file hovercard for files in the document library. + +- `"defaultHoverField": "[$Editor]"` adds a profile card for the editor field +- `"defaultHoverField": "[$FileLeafRef]"` adds a file hover card in documentLibrary + +## columnFormatterReference + +This will be replaced with the referenced column's formatter JSON. Multi-level reference isn't supported. + +References for multi-choice column formatter templates and column formatters not based on templates are not supported. + +```json +{ + "columnFormatterReference": "[$FieldName]" +} +``` + +## inlineEditField + +Adds the field editor for the referenced column. + +```json +{ + "elmType": "div", + "inlineEditField": "[$FieldName]", + "txtContent": "[$FieldName]" +} +``` + +## filePreviewProps + +The `filePreviewProps` is an optional property that allows overriding the default styles of file type icon and brand type icon in `filepreview`.elmType. + +The `fileTypeIconClass` and `brandTypeIconClass` can be used to provide CSS class names to the file type icon and the brand type icon elements respectively. + +The `fileTypeIconStyle` and `brandTypeIconStyle` can be used to provide [styles](#style) to the file type icon and the brand type icon respectively. These styles will take precedence over the same styles coming from the CSS classes provided by the above two properties. + +```json +"elmType": "filepreview", +"attributes": { + "src": "@thumbnail.medium", + }, +"filePreviewProps": { + "fileTypeIconClass": "sp-css-borderColor-neutralLight", + "fileTypeIconStyle": { + "width": "100px" + }, + "brandTypeIconClass": "sp-css-borderColor-neutralLight", + "brandTypeIconStyle": { + "width": "68px" + } +} +``` + +## Expressions + +Values for `txtContent`, style properties, and attribute properties can be expressed as expressions so that they're evaluated at runtime based on the context of the current field (or row). Expression objects can be nested to contain other Expression objects. + +Expressions can be written using Excel-style expressions in SharePoint Online and SharePoint Server Subscription Edition starting with the 22H2 feature update, or by using Abstract Syntax Tree expressions in SharePoint Online, SharePoint Server Subscription Edition, and SharePoint Server 2019. + +All fields in `ViewFields` can be referred to in expressions, even if it's marked `Explicit`. + +### Excel-style expressions + +All Excel-style expressions begin with an equal (`=`) sign. This style of expression is only available in SharePoint Online and SharePoint Server Subscription Edition starting with the 22H2 feature update. This style of expression isn't available in SharePoint Server 2019 or SharePoint Server Subscription Edition prior to the 22H2 feature update. + +This simple conditional expression evaluates to `none` if `@me` isn't equal to `[$Author.email]`, and evaluates to `''` otherwise: + +```json +=if(@me != [$Author.email], 'none', '') +``` + +More complex if/else statements can be written like the following: + +```json +=if([$Sentiment] <= 0.3, 'sp-field-severity--blocked', if([$Sentiment] < 0.9,'sp-field-severity--warning','sp-field-severity--good')) +``` + +Non-conditional operators that take one or two operands can be written like the following: + +```json +=[$foo] * -7 +``` + +```json +=sin(@currentField) +``` + +```json +=toString(60 + (sin(6.2831853 * @currentField) * 60)) +``` + +### Abstract Syntax Tree expressions + +The following example contains an Expression object that performs the expression: + +`(@currentField > 40) ? '100%' : (((@currentField * 2.5).toString() + '%')` + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "operator": "?", + "operands": [ + { + "operator": ">", + "operands": [ + "@currentField", + "40" + ] + }, + "100%", + { + "operator": "+", + "operands": [ + { + "operator": "toString()", + "operands": [ + { + "operator": "*", + "operands": [ + "@currentField", + 2.5 + ] + } + ] + }, + "%" + ] + } + ] +} +``` + +## Operators + +Operators specify the type of operation to perform. Valid operator values include: + +- `+` +- `-` +- `/` +- `*` +- `<` +- `>` +- `%` +- `==` +- `!=` +- `<=` +- `>=` +- `||` +- `&&` +- `toString()` +- `Number()` +- `Date()` +- `cos` +- `sin` +- `?` +- `:` +- `toLocaleString()` +- `toLocaleDateString()` +- `toLocaleTimeString()` +- `indexOf` +- `toLowerCase` +- `join` +- `length` +- `abs` +- `loopIndex` +- `floor` +- `ceiling` +- `pow` +- `substring` +- `getDate` +- `getMonth` +- `getYear` +- `toUpperCase` +- `lastIndexOf` +- `startsWith` +- `endsWith` +- `replace` +- `replaceAll` +- `padStart` +- `padEnd` +- `getThumbnailImage` +- `getUserImage` +- `addDays` +- `addMinutes` +- `appendTo` +- `removeFrom` +- `split` + +**Binary arithmetic operators** - The standard arithmetic binary operators that expect two operands include are: + +- `+` +- `-` +- `/` +- `*` +- `<` +- `>` +- `%` +- `==` +- `!=` +- `<=` +- `>=` + +**Unary operators** - The standard unary operators that expect only one operand are: + +- `toString()`: returns a string representing the object + - `"txtContent": "=toString(45)"` results in _"45"_ +- `Number()`: returns the numeric value, if the operand isn't a number, NaN is returned + - `"txtContent": "=Number('365')"` results in _365_ + - `"txtContent": "=Number('Wowee')"` results in _NaN_ + - `"txtContent": "=Number(Date('12/26/1981'))"` results in _378190800000_ +- `Date()`: returns a datetime object from the parameter (converts strings or numbers to dates, sensitive to locale) + - `"txtContent": "=Date('12/26/1981')"` results in _12/26/1981, 12:00:00 AM_ +- `cos`: returns the cosine of the specified angle that should be specified in radians + - `"txtContent": "=cos(5)"` results in _0.28366218546322625_ +- `sin`: returns the sine of a number + - `"txtContent": "=sin(90)"` results in _0.8939966636005579_ +- `toDateString()`: returns a date in a short-friendly format + - `"txtContent": "=toDateString(@now)"` result doesn't vary based on the user's locale and it will look like _"Wed Aug 03 2022"_ +- `toLocaleString()`: returns a language-sensitive representation of a date + - `"txtContent":"=toLocaleString(@now)"` results vary based on the user's locale, but en-us looks like _"2/5/2019, 1:22:24 PM"_ +- `toLocaleDateString()`: returns a language-sensitive representation of just the date portion of a date + - `"txtContent":"=toLocaleDateString(@now)"` results vary based on the user's locale, but en-us looks like _"2/5/2019"_ +- `toLocaleTimeString()`: returns a language-sensitive representation of just the time portion of a date + - `"txtContent":"=toLocaleTimeString(@now)"` results vary based on the user's locale, but en-us looks like _"1:22:24 PM"_ +- `toLowerCase`: returns the value converted to lower case (only works on strings) - _Only available in SharePoint Online_ + - `"txtContent":"=toLowerCase('DogFood')"` results in _"dogfood"_ +- `abs`: returns the absolute value for a given number - _Only available in SharePoint Online_ + - `"txtContent":"=abs(-45)"` results in _45_ +- `length`: returns the number of items in an array (multi-select person or choice field), for all other value types it returns 1 when true and 0 when false. It does NOT provide the length of a string value (*see the `indexOf` workaround explained later on for such operation*). - _Only available in SharePoint Online_ + - `"txtContent":"=length(@currentField)"` might result in _2_ if there are two selected values + - `"txtContent":"=length('Some Text')"` results in _1_ + - `"txtContent":"=length('')"` results in _0_ + - `"txtContent":"=length(45)"` results in _1_ + - `"txtContent":"=length(0)"` results in _0_ +- `floor`: returns the largest integer less than or equal to a given number. - _Only available in SharePoint Online_ + - `"txtContent":"=floor(45.5)"` results in _45_ +- `ceiling`: rounds the given number up to the next largest whole number or integer. - _Only available in SharePoint Online_ + - `"txtContent":"=ceiling(45.5)"` results in _46_ +- `getDate`: returns the day of the month of the given date. - _Only available in SharePoint Online_ + - `"txtContent":"=getDate(Date('12/26/1981'))"` results in _26_ +- `getMonth`: returns the month in the specified date according to local time, as a zero-based value (where zero indicates the first month of the year). - _Only available in SharePoint Online_ + - `"txtContent":"=getMonth(Date('12/26/1981'))"` results in _11_ +- `getYear`: returns the year of the given date. - _Only available in SharePoint Online_ + - `"txtContent":"=getYear(Date('12/26/1981'))"` results in _1981_ +- `toUpperCase`: returns the value converted to upper case (only works on strings) - _Only available in SharePoint Online_ + - `"txtContent":"=toUpperCase('DogFood')"` results in _"DOGFOOD"_ + +**Binary operators** - The following are operators that expect two operands: + +- `indexOf`: takes two operands. The first is the text (or array) you would like to search within, the second is the text you would like to search for. Returns the index value of the first occurrence of the search term within the string (or array). Indexes start at 0. If the search term isn't found within the text (or array), -1 is returned. This operator is case-sensitive. - _Only available in SharePoint Online_ + - `"txtContent": "=indexOf('DogFood', 'Dog')"` results in _0_ + - `"txtContent": "=indexOf('DogFood', 'F')"` results in _3_ + - `"txtContent": "=indexOf('DogFood', 'Cat')"` results in _-1_ + - `"txtContent": "=indexOf('DogFood', 'f')"` results in _-1_ +- `join`: takes two operands. The first is an array (multi-select person or choice field) and the second is the separating string. Returns a string concatenation of the array values separated by the separating string. - _Only available in SharePoint Online_ + - `"txtContent": "=join(@currentField, ', ')"` might result in _"Apple, Orange, Cherry"_ (depending on the selected values) + - `"txtContent": "=join(@currentField.title, '|')"` might result in _"Megan Bowen|Alex Wilber"_ (depending on the selected persons) +- `pow`: returns the base to the exponent power. - _Only available in SharePoint Online_ + - `"txtContent":"=pow(2,3)"` results in _8_ +- `lastIndexOf`: returns the position of the last occurrence of a specified value in a string (or array) + - `"txtContent": "=lastIndexOf('DogFood DogFood', 'Dog')"` results in _8_ + - `"txtContent": "=lastIndexOf('DogFood DogFood', 'F')"` results in _11_ + - `"txtContent": "=lastIndexOf('DogFood DogFood', 'Cat')"` results in _-1_ + - `"txtContent": "=lastIndexOf('DogFood DogFood', 'f')"` results in _-1_ +- `startsWith`: determines whether a string begins with the characters of a specified string + - `"txtContent":"=startsWith('DogFood', 'Dog')"` results in _true_ + - `"txtContent":"=startsWith('DogFood', 'Food')"` results in _false_ +- `endsWith`: determines whether a string ends with the characters of a specified string + - `"txtContent":"=endsWith('DogFood', 'Dog')"` results in _false_ + - `"txtContent":"=endsWith('DogFood', 'Food')"` results in _true_ +- `getUserImage`: returns a URL pointing to user's profile image for a given email and preferred size + - `"src":"=getUserImage('kaylat@contoso.com', 'small')"` returns a URL pointing to user's profile picture in small resolution + - `"src":"=getUserImage('kaylat@contoso.com', 's')"` returns a URL pointing to user's profile picture in small resolution + - `"src":"=getUserImage('kaylat@contoso.com', 'medium')"` returns a URL pointing to user's profile picture in medium resolution + - `"src":"=getUserImage('kaylat@contoso.com', 'm')"` returns a URL pointing to user's profile picture in medium resolution + - `"src":"=getUserImage('kaylat@contoso.com', 'large')"` returns a URL pointing to user's profile picture in large resolution + - `"src":"=getUserImage('kaylat@contoso.com', 'l')"` returns a URL pointing to user's profile picture in large resolution +- `appendTo`: returns an array with the given entry appended to the given array + - `"txtContent": "=appendTo(@currentField, 'Choice 4')"` returns an array with 'Choice 4' added to the @currentField array + - `"txtContent": "=appendTo(@currentField, 'kaylat@contoso.com')"` returns an array with 'kaylat@contoso.com' added to the @currentField array +- `removeFrom`: returns an array with the given entry removed from the given array, if present + - `"txtContent": "=removeFrom(@currentField, 'Choice 4')"` returns an array with 'Choice 4' removed from the @currentField array + - `"txtContent": "=removeFrom(@currentField, 'kaylat@contoso.com')"` returns an array with 'kaylat@contoso.com' removed from the @currentField array +- `split`: divides the given string into an ordered list of substrings by searching for the given pattern, and returns an array of these substrings + - `"txtContent": "=split('Hello World', ' ')"` returns an array with two strings - 'Hello' and 'World' +- `addDays`: returns a datetime object with days added (or deducted) from the given datetime value + - `"txtContent": "=addDays(Date('11/14/2021'), 3)"` returns a 11/17/2021, 12:00:00 AM + - `"txtContent": "=addDays(Date('11/14/2021'), -1)"` returns a 11/13/2021, 12:00:00 AM +- `addMinutes`: returns a datetime object with minutes added (or deducted) from the given datetime value + - `"txtContent": "=addMinutes(Date('11/14/2021'), 3)"` returns a 11/14/2021, 12:03:00 AM + - `"txtContent": "=addMinutes(Date('11/14/2021'), -1)"` returns a 11/13/2021, 11:59:00 AM + +**Ternary operators** - The following are operators that expect three operands: + +- `substring`: returns the part of the string between the start and end indices. - _Only available in SharePoint Online_ + - `"txtContent":"=substring('DogFood', 3, 4)"` results in _F_ + - `"txtContent":"=substring('DogFood', 4, 3)"` results in _F_ + - `"txtContent":"=substring('DogFood', 3, 6)"` results in _Foo_ + - `"txtContent":"=substring('DogFood', 6, 3)"` results in _Foo_ + + The substring() method returns the part of the string between the start and end indexes or to the end of the string. + +- `replace`: searches a string (or array) for a specified value and returns a new string (or array) where the specified value is replaced. For strings, only the first instance of the value will be replaced. + - `"txtContent":"=replace('Hello world', 'world', 'everyone')"` results in _Hello everyone_ + - `"txtContent":"=replace([$MultiChoiceField], 'Choice 1', 'Choice 2')"` returns an array replacing Choice 1 with Choice 2 + - `"txtContent":"=replace([$MultiUserField], @me, 'kaylat@contoso.com')"` returns an array replacing @me with 'kaylat@contoso.com' +- `replaceAll`: searches a string for a specified value and returns a new string (or array) where the specified value is replaced. For strings, all instances of the value will be replaced. + - `"txtContent":"=replaceAll('H-e-l-l-o W-o-r-l-d', '-', '')"` results in _Hello World_ +- `padStart`: pads the current string with another string until the resulting string reaches the given length. The padding is applied from the start of the current string. + - `"txtContent":"=padStart('DogFood', 10, 'A')"` results in _AAADogFood_ + - `"txtContent":"=padStart('DogFood', 10, 'AB')"` results in _ABADogFood_ + - `"txtContent":"=padStart('DogFood', 5, 'A')"` results in _DogFood_ +- `padEnd`: pads the current string with a given string until the resulting string reaches the given length. The padding is applied from the end of the current string. + - `"txtContent":"=padEnd('DogFood', 10, 'A')"` results in _DogFoodAAA_ + - `"txtContent":"=padEnd('DogFood', 10, 'AB')"` results in _DogFoodABA_ + - `"txtContent":"=padEnd('DogFood', 5, 'A')"` results in _DogFood_ +- `getThumbnailImage`: returns a URL pointing to an image for a given image field and preferred size. + - `"src":"=getThumbnailImage([$ImageField], 400, 200)"` results in a URL pointing to an image for a given image field with 400 width and 200 height + +**Conditional operator** - The conditional operator is: + +- `?`: Conditional operations written in Abstract Tree Syntax use `?` as the operator. This is to achieve an expression equivalent to `a ? b : c`, where if the expression `a` evaluates to true, then the result is `b`, else the result is `c`. For Excel-style expressions, you write these with an `if` statement. Regardless, there are three operands. The first is the condition to evaluate. The second is the result when the condition is true. The third is the result when the condition is false. + - `"txtContent":"=if(4 < 5, 'yes', 'no')"` results in _"yes"_ + - `"txtContent":"=if(4 > 5, 'yes', 'no')"` results in _"no"_ + +**Multi-value field-related operators** - The following operators are only used in a context with multi-value fields of type Person, Lookup, or Choice. + +- `length` +- `join` +- `loopIndex` + +`length`, when provided with a field name, returns the number of members in a multi-valued field. When a single-value field is provided, `length` will return 1 when there's a value in that field. + +`join` concatenates values in a multi-value field with a specified separator. The first operand shall point to a value in a multi-value field, for example `"@currentField.lookupValue"`, `"[$AssignedTo.title]"`. The second operand shall be a string literal that is the separator that joins the values together. + +`loopIndex`, when provided with the name of the iterator variable, returns the current index (starting from 0) of the iterator. The name of the iterator must be provided as a string literal. `loopIndex` would only work within the element with respective `forEach` enabled or its children elements. + +For examples, see [Formatting multi-value fields](column-formatting.md#formatting-multi-value-fields). + +**String-related operators** - Some of the previously detailed operators can be used when working with string values: + +- `+` +- `indexOf` (*for string length workaround*) + +`+` can be used when there's a need to concatenate strings, for instance: + +```txt +"txtContent": "=[$column1] + ' ' + [$column2] + 'some other text'" +``` + +`indexOf` Since the operator `length` doesn't work for string value types (it will return 1 or 0), `indexOf` can serve us as a nice workaround to get the length of a string, for instance: `indexOf([$column1] + '^', '^')`. We'll use `'^'` or any other character to use to find out the end of the string. + +## Operands + +Specifies the parameters, or operands for an expression. This is an array of Expression objects or base values. + +## Special string values + +The values for `txtContent`, styles, and attributes can be either strings or Expression objects. A few special string patterns for retrieving values from the fields in the list and the user's context are supported. + +### "@currentField" + +Will evaluate the value of the current field. + +Some field types are represented as objects. To output a value from an object, refer to a particular property inside that object. For example, if the current field is a person/group field, specify `@currentField.title` to retrieve the person's name, which is normally displayed in list views. The following are the field types that are represented as objects with a list of their properties. + +> [!NOTE] +> The `@currentField.title` returns a person's name by default. However, if the person field's Show Field has been adjusted, it may change the value of the `title` property. For example, a person field with the Show Field configured as Department will have the person's department for the `title` property. + +**People fields** + +The people field object has the following properties (with example values): + +```json +{ + "id": "122", + "title": "Kalya Tucker", + "email": "kaylat@contoso.com", + "sip": "kaylat@contoso.com", + "picture": "https://contoso.sharepoint.com/kaylat_contoso_com_MThumb.jpg?t=63576928822", + "department":"Human Resources", + "jobTitle":"HR Manager" +} +``` + +People field can have profile hover cards along with formatting: + +```json +{ + "elmType": "div", + "txtContent": "[$Editor.title]", + "defaultHoverField": "[$Editor]" +} +``` + +**Date/Time fields** + +The value of Date/Time fields can be retrieved a few different ways, depending on the date format you'd like to display. The following methods for converting date values to specific formats are supported: + +- `toLocaleString()` - Displays a date type fully expanded with date and time. +- `toLocaleDateString()` - Displays a date type with just the date. +- `toLocaleTimeString()` - Displays a date type with just the time. + +For example, the following JSON will display the current field (assuming it's a date field) as a date and time string. + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "div", + "txtContent": { + "operator": "toLocaleString()", + "operands" : ["@currentField"] + } +} +``` + +Here's the same sample from above, using the Excel-style expression syntax: + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "div", + "txtContent": "=toLocaleString(@currentField)" +} +``` + +**Location fields** + +The location field object has the following properties (with example values): + +```json +{ + "Address": { + "City": "Knoxville", + "CountryOrRegion": "United States", + "State": "TN", + "Street": "963 Worlds Fair Park Dr" + }, + "Coordinates": { + "Latitude": "35.961673736572266", + "Longitude": "-83.92420959472656" + }, + "DisplayName": "World's Fair Park", + "LocationUri": "https://www.bingapis.com/api/v6/localentities/8346bf26-6da4-104c-6ba5-2334b83f6ac8?setLang=en" +} +``` + +The following example shows how a location field might be used on a current field. + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", + "elmType": "div", + "style": { + "display": "block" + }, + "children": [ + { + "elmType": "a", + "txtContent": "@currentField.DisplayName", + "attributes": { + "href": "='https://www.bing.com/maps?cp=' + @currentField.Coordinates.Latitude + '~' + @currentField.Coordinates.Longitude + '&lvl=17&sV=2'", + "target": "_blank", + "title": "=@currentField.Coordinates.Latitude + ', ' + @currentField.Coordinates.Longitude" + }, + "style": { + "display": "block" + } + }, + { + "elmType": "div", + "txtContent": "@currentField.Address.Street" + }, + { + "elmType": "div", + "txtContent": "=@currentField.Address.City + ', ' + @currentField.Address.State" + }, + { + "elmType": "div", + "txtContent": "@currentField.Address.CountryOrRegion" + } + ] +} +``` + +**Lookup fields** + +The lookup field object has the following properties (with example values): + +```json +{ + "lookupId": "100", + "lookupValue": "North America", +} +``` + +The following example shows how a lookup field might be used on a current field. + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "a", + "txtContent": "@currentField.lookupValue", + "attributes": { + "href": { + "operator": "+", + "operands": [ + "https://contoso.sharepoint.com/teams/Discovery/Lists/Regions/DispForm.aspx?ID=", + "@currentField.lookupId" + ] + }, + "target": "_blank" + } +} +``` + +**Hyperlink fields** + +The hyperlink field object has the following property (with example value): + +```json +{ + "desc": "SharePoint Patterns and Practices", +} +``` + +To reference the URL value, use `@currentField`. + +The following example shows how a hyperlink field might be used on a current field. + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "a", + "txtContent": "@currentField.desc", + "attributes": { + "href": "@currentField", + "target": "_blank" + } +} +``` + +**Image fields** + +The image field object has the following `fileName` property: + +```json +{ + "fileName": "image.png", +} +``` +> [!NOTE] +> As of July 2024, just the `fileName` property has a value. + + +The following example shows how an image field can be used on a current field. + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "img", + "attributes": { + "src": "=getThumbnailImage(@currentField, 400, 300)", + "alt": "@currentField.fileName" + }, + "style": { + "width": "100%", + "max-width": "100%" + } +} +``` + +**Approval Status fields** + +The Approval Status field object has the following property (with example value): + +```json +{ + "displayValue": "Approved", + "numeric": 0 +} +``` + +`displayValue` is a localized string of the approval status. + +`@currentField` or `[$__ModerationStatus]` will also internally map to the following internal numeric value: + +- 0: Approved +- 1: Denied +- 2: Pending +- 3: Draft +- 4: Scheduled + +`[$_ModerationStatus]` field supports comparisons to both strings and the numeric value. The numeric comparisons work across locales and languages which will be the recommended way for this field. + +The following expressions evaluate to the output on the right, for when the status is `Pending`: + +```javascript +// reading field value +"[$_ModerationStatus]" => "Pending" + +// obtaining the internal numeric value: +"=Number([$_ModerationStatus])" => 2 +"=[$_ModerationStatus.numeric]" => 2 + +// addition results in string concatenation: +"='status:'+[$_ModerationStatus]" => 'status:Pending' + +// numeric comparisons +"=([$_ModerationStatus] == 2)" => true +"=([$_ModerationStatus] != 1)" => true + +// other comparators are rarely useful, for cases where you want might want to exclude Draft & Scheduled +"=([$_ModerationStatus] < 3)" => true + +// localized string comparison, works only with one locale (en-us here) +"=if([$_ModerationStatus]=='Pending','This Works too!', 'Nope!')" => 'This Works too!' +``` + +The following example shows how an approval status field might be used on a current field: + +```json +{ + "elmType": "div", + "txtContent": "@currentField.displayValue", + "style": { + "color": "=if(@currentField == 2, 'red', '')" + } +} +``` + +### "[$FieldName]" + +The column is formatted within the context of the entire row. You can use this context to reference the values of other fields within the same row by specifying the **internal name** of the field surrounded by square brackets and preceded by a dollar sign: `[$InternalName]`. For example, to get the value of a field with an internal name of "MarchSales", use `[$MarchSales]`. + +> [!NOTE] +> Reference to other fields will work only if they are included in the same view. + +If the value of a field is an object, the object's properties can be accessed. For example, to access the "Title" property of a person field named "SalesLead", use "[$SalesLead.title]". + +### "[!FieldName]" + +In column and view formatting, you can refer to any field's metadata by specifying the **internal name** of the field surrounded by square brackets and preceded by an exclamation mark: `[!InternalName]`. + +Currently field's display name is available in this metadata, and can be accessed using `DisplayName` property: `[!SalesLead.DisplayName]`. + +### "@currentWeb" + +This will evaluate the absolute URL for the site. This is equivalent to the `webAbsoluteUrl` value within the page context. This value is only available in SharePoint Online. + +### "@me" + +This will evaluate the email address of the currently logged-in user. + +This field can be used to display the current user's email address, but more likely it will be used within conditions. The following is an example of setting the color for a person field to red when it's equal to the currently logged-in user and blue otherwise: + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "div", + "txtContent": "@currentField.title", + "style": { + "color": { + "operator": "?", + "operands": [ + { + "operator": "==", + "operands": [ + "@me", + "@currentField.email" + ] + }, + "red", + "blue" + ] + } + } +} +``` + +Here's the same sample from above, using the Excel-style expression syntax: + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "div", + "txtContent": "@currentField.title", + "style": { + "color": "=if(@me == @currentField.email, 'red', 'blue')" + } +} +``` + +### "@now" + +This will evaluate the current date and time. + +### "@rowIndex" + +This will evaluate the rendered index of a row within a view. This value is based on render position and will remain consistent based on position even as views are sorted and filtered. Indexes start at 0. This value is only available in SharePoint Online. + +Here's an example of using the value within a view format to apply alternating styles to rows: + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json", + "additionalRowClass": "=if(@rowIndex % 2 == 0,'ms-bgColor-themeLighter ms-bgColor-themeLight--hover','')" +} +``` + +### "@window.innerHeight" + +This will be evaluated to a number equal to the height of the browser window (in pixels) when the list is rendered. + +### "@window.innerWidth" + +This will evaluate to a number equal to the width of the browser window (in pixels) when the list was rendered. + +### Thumbnails + +In a document library, there's a series of tokens that can be used to retrieve the URL to the thumbnail of a file, including: + +- `@thumbnail.small`, `@thumbnail.medium`, and `@thumbnail.large` evaluate the thumbnail URL in three predefined sizes. +- `@thumbnail.` evaluates the URL to the largest thumbnail that isn't larger than the bounding size in both width and height. For example, `@thumbnail.150` evaluates to the URL to a thumbnail not larger than 150×150 pixels. +- `@thumbnail.x` evaluates the URL to the largest thumbnail that isn't larger than the bounding width and bounding height. For example, `@thumbnail.100x200` evaluates to the URL to a thumbnail not wider than 100 pixels and not higher than 200 pixels. + +These tokens will yield no value on non-file items including folders. + +> [!NOTE] +> The aspect ratio of the thumbnail generated is the same as how the file looks, changing the bounding sizes will not affect the aspect ratio of the thumbnail. + +> [!TIP] +> Thumbnails are only available for a list of supported file formats. It means that sometimes the URL generated is not accessible due to lack of support on certain formats. However, if a valid thumbnail token is set as the _only_ `src` attribute of an `img` tag, we will take care of it and hide the image when it is not available. + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/column-formatting.schema.json", + "elmType": "img", + "attributes": { + "src": "@thumbnail.200x150", + "alt": "='Thumbnail of file ' + [$FileLeafRef]" + }, + "style": { + "width": "100%", + "max-width": "100%" + } +} +``` + +Default file hover card using FileLeafRef + +```json +{ + "elmType": "img", + "style": { + "width": "100%", + "height": "100%", + "display": "=if([$File_x0020_Type] == '', 'none', '')" + }, + "attributes": { + "src": "@thumbnail.300x300" + }, + "defaultHoverField": "[$FileLeafRef]" +} +``` + +### displayValue + +The following column types can use `displayValue` property to get the default-rendered value, based on the column setting: + +- Date/Time +- Number +- Yes/No +- Currency +- Approval Status + +```json +{ + "elmType": "div", + "txtContent": "@currentField.displayValue" +} +``` + +This also works with field name: + +```json +{ + "elmType": "div", + "txtContent": "[$FieldName.displayValue]" +} +``` + +### "@isSelected" + +This will evaluate to `true` for the selected item(s) in a view and `false` otherwise. + +### "@lcid" + +This will evaluate to the LCID of the current culture. This can be used to format the date, time, and numbers. + +### "@UIlcid" + +This will evaluate to the LCID of the current UI culture. This can be used to show localized display strings. diff --git a/docs/declarative-customization/get-started-create-site-design.md b/docs/declarative-customization/get-started-create-site-design.md index 64f5ff2c7..92b22361c 100644 --- a/docs/declarative-customization/get-started-create-site-design.md +++ b/docs/declarative-customization/get-started-create-site-design.md @@ -1,156 +1,162 @@ ---- -title: Get started creating SharePoint site designs and site scripts -description: Create site designs to provide reusable lists, themes, layouts, pages, or custom actions so that your users can quickly build new SharePoint sites with the features they need. -ms.date: 04/17/2020 -localization_priority: Priority ---- - -# Get started creating site designs and site scripts - -You can create site designs to provide reusable lists, themes, layouts, pages, or custom actions so that your users can quickly build new SharePoint sites with the features they need. - -This article describes how to build a simple site design that adds a SharePoint list for tracking customer orders. You'll use the site design to create a new SharePoint site with the custom list. You'll learn how to use SharePoint PowerShell cmdlets to create site scripts and site designs. You can also use REST APIs to perform the same actions. The corresponding REST calls are shown for reference in each step. - -## Create the site script in JSON - -A site design is a collection of actions that SharePoint runs when creating a new site. Actions describe changes to apply to the new site, such as creating a new list or applying a theme. The actions are specified in a JSON script, which is a list of all actions to apply. When a script runs, SharePoint completes each action in the order listed. - -Each action is specified by the "verb" value in the JSON script. Also, actions can have subactions that are also "verb" values. In the following JSON, the script specifies to create a new list named **Customer Tracking**, and then subactions set the description and add several fields to define the list. - -1. Download and install the [SharePoint Online Management Shell](https://www.microsoft.com/download/details.aspx?id=35588). If you already have a previous version of the shell installed, uninstall it first and then install the latest version. - -2. Follow the instructions at [Connect to SharePoint Online PowerShell](https://technet.microsoft.com/library/fp161372.aspx) to connect to your SharePoint tenant. - -3. Create - and assign the JSON that describes the new script - to a variable as shown in the following PowerShell code. You can view and reference the latest JSON schema file here: https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json - - ```powershell - $site_script = ' - { - "$schema": "schema.json", - "actions": [ - { - "verb": "createSPList", - "listName": "Customer Tracking", - "templateType": 100, - "subactions": [ - { - "verb": "setDescription", - "description": "List of Customers and Orders" - }, - { - "verb": "addSPField", - "fieldType": "Text", - "displayName": "Customer Name", - "isRequired": false, - "addToDefaultView": true - }, - { - "verb": "addSPField", - "fieldType": "Number", - "displayName": "Requisition Total", - "addToDefaultView": true, - "isRequired": true - }, - { - "verb": "addSPField", - "fieldType": "User", - "displayName": "Contact", - "addToDefaultView": true, - "isRequired": true - }, - { - "verb": "addSPField", - "fieldType": "Note", - "displayName": "Meeting Notes", - "isRequired": false - } - ] - } - ], - "bindata": { }, - "version": 1 - } - ' - ``` - -
- -The previous script creates a new SharePoint list named **Customer Tracking**. It sets the description and adds four fields to the list. Note that each of these are considered an action. Site scripts are limited to 30 cumulative actions (across one or more scripts that may be called in a site design) if applied programmatically using the Invoke-SPOSiteDesign command. If they are applied through the UX or using the Add-SPOSiteDesignTask command then the limit is 300 cumulative actions (or 100K characters). - -## Add the site script - -Each site script must be registered in SharePoint so that it is available to use. Add a new site script by using the **Add-SPOSiteScript** cmdlet. The following example shows how to add the JSON script described previously. - -```powershell -C:\> Add-SPOSiteScript - -Title "Create customer tracking list" - -Content $site_script - -Description "Creates list for tracking customer contact information" -``` - -After running the cmdlet, you get a result that lists the site script **ID** of the added script. Keep track of this ID somewhere because you will need it later when you create the site design. - -The REST API to add a new site script is **CreateSiteScript**. - -## Create the site design - -Next, you need to create the site design. The site design appears in a drop-down list when someone creates a new site from one of the templates. It can run one or more site scripts that have already been added. - -- Run the following cmdlet to add a new site design. Replace `` with the site script ID from when you added the site script. - -```powershell -C:\> Add-SPOSiteDesign - -Title "Contoso customer tracking" - -WebTemplate "64" - -SiteScripts "" - -Description "Tracks key customer data in a list" -``` - -The previous cmdlet creates a new site design named Contoso customer tracking. The `-WebTemplate` value selects which base template to associate with. The value `"64"` indicates Team site template, and the value `"68"` indicates the Communication site template. If you have disabled modern Group creation (or restricted to a subset of users) and wish to still allow your users to apply site designs to the "group-less" modern Team site template, publish your site designs using the `-WebTemplate` value `"1"`. - -The JSON response displays the **ID** of the new site design. You can use it in subsequent cmdlets to update or modify the site design. - -The REST API to add a new site design is **CreateSiteDesign**. - -## Use the new site design - -Now that you've added a site script and site design, you can use it to create new sites through the self-service site creation experience or apply the site design to an existing site using the **Invoke-SPOSiteDesign** command in PowerShell. If you are using hub sites you can even associate a site design to a hub so it gets applied to all joining sites. - -### New site creation - -1. Go to the home page of the SharePoint site that you are using for development. - -2. Choose **Create site**. - -3. Choose **Team site**. - -4. In the **Choose a design** drop-down, select your site design **customer orders**. - -5. In **Site name**, enter a name for the new site **Customer order tracking**. - -6. Choose **Next**. - -7. Choose **Finish**. - -8. A notification bar will be displayed indicating that your script is being applied. To invoke the site design information panel, click the **View progress** link. Once the script(s) have completed the notification banner message will change to **Site Design applied. Refresh this site to see the changes.**, allowing you to either invoke the panel or refresh the page. - -9. You will see the custom list on the page. - -### Apply to an existing site collection - -You can also apply a published site design to an existing site collection using the [Invoke-SPOSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-online/Invoke-SPOSiteDesign?view=sharepoint-ps) cmdlet. - -You can apply a published site design to: -1. Group-connected Team site -2. Team site not connected to a Microsoft 365 group -3. Communication site -4. Classic team site -5. Classic publishing site - -### Associate with a hub site - -You can also associate a published site design to a hub site in hub site settings so it can be applied to all joining sites. For details on how to associate the site design either through the UI or using the Set-SPOHubSite command please review the [Set up a site design for your hub site](https://docs.microsoft.com/sharepoint/set-up-site-design-hub-site) article. - -## See also - -- [SharePoint site design and site script overview](site-design-overview.md) +--- +title: Get started creating SharePoint site templates and site scripts +description: Create site templates to provide reusable lists, themes, layouts, pages, or custom actions so that your users can quickly build new SharePoint sites with the features they need. +ms.date: 09/30/2022 +ms.localizationpriority: high +--- + +# Get started creating site templates and site scripts + +You can create site templates to provide reusable lists, themes, layouts, or custom actions so that your users can quickly build new SharePoint sites with the features they need. + +This article describes how to build a simple site template that adds a SharePoint list for tracking customer orders. You'll use the site template to create a new SharePoint site with the custom list. You'll learn how to use SharePoint PowerShell cmdlets to create site scripts and site templates. You can also use REST APIs to perform the same actions. The corresponding REST calls are shown for reference in each step. + +## Create the site script in JSON + +A site script is a collection of actions that SharePoint runs when creating a new site. Actions describe changes to apply to the new site, such as creating a new list or applying a theme. The actions are specified in a JSON script, which is a list of all actions to apply. When a script runs, SharePoint completes each action in the order listed. + +Each action is specified by the "verb" value in the JSON script. Also, actions can have subactions that are also "verb" values. In the following JSON, the script specifies to create a new list named **Customer Tracking**, and then subactions set the description and add several fields to define the list. + +1. Download and install the [SharePoint Online Management Shell](https://www.microsoft.com/download/details.aspx?id=35588). If you already have a previous version of the shell installed, uninstall it first and then install the latest version. +1. Follow the instructions at [Connect to SharePoint Online PowerShell](https://technet.microsoft.com/library/fp161372.aspx) to connect to your SharePoint tenant. +1. Create - and assign the JSON that describes the new script - to a variable as shown in the following PowerShell code. You can view and reference the latest JSON schema file: [https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json](https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json) + + ```powershell + $site_script = ' + { + "$schema": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json", + "actions": [ + { + "verb": "createSPList", + "listName": "Customer Tracking", + "templateType": 100, + "subactions": [ + { + "verb": "setDescription", + "description": "List of Customers and Orders" + }, + { + "verb": "addSPField", + "fieldType": "Text", + "displayName": "Customer Name", + "isRequired": false, + "addToDefaultView": true + }, + { + "verb": "addSPField", + "fieldType": "Number", + "displayName": "Requisition Total", + "addToDefaultView": true, + "isRequired": true + }, + { + "verb": "addSPField", + "fieldType": "User", + "displayName": "Contact", + "addToDefaultView": true, + "isRequired": true + }, + { + "verb": "addSPField", + "fieldType": "Note", + "displayName": "Meeting Notes", + "isRequired": false + } + ] + } + ] + } + ' + ``` + +The previous script creates a new SharePoint list named **Customer Tracking**. It sets the description and adds four fields to the list. Note that each of these are considered an action. Site scripts are limited to 30 cumulative actions (across one or more scripts that may be called in a site template) if applied programmatically using the `Invoke-SPOSiteDesign` command. If they are applied through the UI or using the `Add-SPOSiteDesignTask` command then the limit is 300 cumulative actions (or 100K characters). + +## Add the site script + +Each site script must be registered in SharePoint so that it is available to use. Add a new site script by using the **Add-SPOSiteScript** cmdlet. The following example shows how to add the JSON script described previously. + +```powershell +C:\> Add-SPOSiteScript + -Title "Create customer tracking list" + -Content $site_script + -Description "Creates list for tracking customer contact information" +``` + +After running the cmdlet, you get a result that lists the site script **ID** of the added script. Keep track of this ID somewhere because you will need it later when you create the site template. + +The REST API to add a new site script is **CreateSiteScript**. + +## Create the site template + +Next, you need to create the site template. The site template appears in a drop-down list when someone creates a new site from one of the templates. It can run one or more site scripts that have already been added. + +- Run the following cmdlet to add a new site template. Replace `` with the site script ID from when you added the site script. + +```powershell +C:\> Add-SPOSiteDesign + -Title "Contoso customer tracking" + -WebTemplate "64" + -SiteScripts "" + -Description "Tracks key customer data in a list" +``` + +The previous cmdlet creates a new site template named Contoso customer tracking. + +| Parameter | Value | Site template type | +| :---------- | :---- | :--------------------------------------- | +| WebTemplate | 64 | Team site template | +| WebTemplate | 1 | Team site (with group creation disabled) | +| WebTemplate | 68 | Communication site template | +| WebTemplate | 69 | Channel site template | + +The JSON response displays the **ID** of the new site template. You can use it in subsequent cmdlets to update or modify the site template. + +The REST API to add a new site template is **CreateSiteDesign**. + +## Use the new site template + +Now that you've added a site script and site template, you can use it to create new sites through the self-service site creation experience or apply the site template to an existing site using the **Invoke-SPOSiteDesign** command in PowerShell. If you are using hub sites you can even associate a site template to a hub so it gets applied to all joining sites. + +### New site creation + +1. Go to the home page of the SharePoint site that you are using for development. +1. Choose **Create site**. +1. Choose the type of site you need to use. SharePoint will create a team site using the Microsoft **Team collaboration template** or a communication site using the Microsoft **Topic** template unless another custom site template is set as default. +1. Choose **Next**. +1. In **Site name**, enter a name for the new site **Customer order tracking**. +1. Choose **Finish**. +1. Next, go to **Settings** and select **Apply a site template**. +1. Select the site template you just created. +1. Once applied, your new template will display under the tab in the template viewer titled **From your organization.** +1. When the new template has been applied, you will see the custom list on the page. + +### Apply to an existing site + +You can also apply a published site template to existing sites. On the home page of the site, site owners can navigate to **Settings** and then **Apply a site template** to browse and apply templates provided by your organization and Microsoft. + +You can apply templates to existing site collections in bulk by using the [Invoke-SPOSiteDesign](/powershell/module/sharepoint-online/Invoke-SPOSiteDesign) cmdlet. + +**Published site templates can be applied to:** + +1. Group-connected team sites +1. Team sites that not connected to a Microsoft 365 group +1. Communication sites +1. Channel sites +1. Classic team sites +1. Classic publishing sites + +The REST API to apply a site template to an existing site collection is **ApplySiteDesign**. + +### Associate with a hub site + +Apply a published site template to a new or existing hub site. Then, all associated sites will inherit the hub site template and theme. Navigate to the home page of the hub and go to **Settings** and then **Apply a site template**. Learn more about how to [enable site associations for your hub site](https://support.microsoft.com/office/set-up-your-sharepoint-hub-site-e2daed64-658c-4462-aeaf-7d1a92eba098). + +You can also use the `Set-SPOHubSite` cmdlet. Review the [PowerShell cmdlets for SharePoint hub sites](../features/hub-site/hub-site-powershell.md) article. + +>[!NOTE] +> [Channel sites](/sharepoint/teams-connected-sites) are automatically blocked from joining a hub site. + +## See also + +- [SharePoint site template and site script overview](site-design-overview.md) +- [How to apply and customize SharePoint site templates](https://support.microsoft.com/office/apply-and-customize-sharepoint-site-templates-39382463-0e45-4d1b-be27-0e96aeec8398) diff --git a/docs/declarative-customization/list-form-conditional-show-hide.md b/docs/declarative-customization/list-form-conditional-show-hide.md index 09f8d4a3f..1d4afe455 100644 --- a/docs/declarative-customization/list-form-conditional-show-hide.md +++ b/docs/declarative-customization/list-form-conditional-show-hide.md @@ -1,8 +1,8 @@ --- title: Show or hide columns in a list form description: Customize which columns to show or hide using a conditional formula in the list form by constructing a simple formula that are equations performing conditional checks on values in a SharePoint list or library. -ms.date: 05/07/2021 -localization_priority: Priority +ms.date: 07/28/2025 +ms.localizationpriority: high --- # Show or hide columns in a list or library form @@ -27,7 +27,7 @@ To show or hide a column in a list or library form: 1. In the **Edit columns** pane, check (to show) or uncheck (to hide) the checkbox for the column or columns as needed. > [!NOTE] - > If you want to re-arrange the order of the columns, either drag-and-drop the column name, or first select the far right hand edge of the column name to display the options menu **(...)** and then select Move Up or Move Down as preferred. + > If you want to re-arrange the order of the columns, either drag-and-drop the column name or first select the far right-hand edge of the column name to display the options menu **(...)** and then select Move Up or Move Down as preferred. 1. When you're finished, select **Save**. @@ -38,7 +38,7 @@ You can show or hide columns in a list form based on another column's value by s To specify a conditional formula for a column, in the **Edit columns** pane: 1. Navigate to the desired column for which you want to set a conditional formula -1. Select the far right hand edge of the column name to display the options menu **(...)** +1. Select the far right-hand edge of the column name to display the options menu **(...)** 1. In the more options, select **Edit conditional formula**. 1. In the **Edit conditional formula** dialog: - To determine whether this column is shown or hidden, specify a conditional formula based on the value of another column. @@ -56,21 +56,22 @@ For example, the following formula checks if the value for the *Category* column =if([$Category] == 'Product Management', 'true', 'false') ``` -Returning _true_ results in showing the column on the form while returning _false_ hides the column. +Returning _true_ shows the column on the form while returning _false_ hides the column. -The column is represented by specifying the **internal name** of the field surrounded by square brackets and preceded by a dollar sign: `[$InternalName]`. For example, to get the value of a field with an internal name of "ProductName", use `[$ProductName]`. +The column is represented by specifying the **internal name** of the field preceded by a dollar sign and surrounded by square brackets: `[$InternalName]`. For example, to get the value of a field with an internal name of "ProductName", use `[$ProductName]`. #### Unsupported column types in conditional formulas While the formula supports many of the available column types, we do not currently support the following column types: -* Person or Group with multiple selections -* Choice with multiple selections -* Time calculations in Date and Time column -* Currency columns -* Location columns -* Calculated columns -* Managed Metadata columns +- Person or Group with multiple selections +- Choice with multiple selections +- Lookup with multiple selections +- Time calculations in **Date and Time** column +- Currency columns +- Location columns +- Calculated columns +- Managed Metadata columns #### Quick formula reference @@ -98,7 +99,7 @@ You can also do arithmetic calculations, such as adding the value of two columns ##### Date column -The following formula checks if the date column `[$StartDate]` is equal to a specific date. To do so, it uses the *Date()* function to convert a given string into a date: +The following formula checks if the date column `[$StartDate]` equals a specific date. To do so, it uses the *Date()* function to convert a given string into a date: ``` =if([$StartDate] == Date('4/6/2020'), 'true', 'false') @@ -126,17 +127,26 @@ The following formula checks if an email of person column `[$Owner]` is equal to ##### Boolean (Yes/No) column -The following formula checks if the Yes/No column `[$Promoted]` is equal to a Yes. To do so, it checks for the value _true_ which maps to _Yes_ for users. +The following formula checks if the Yes/No column `[$Promoted]` equals a Yes. To do so, it checks for the value _true_ which maps to _Yes_ for users. ``` =if([$Promoted] == true, 'true', 'false') ``` +The following are also valid: + +``` +=if([$Promoted], 'true', 'false') +``` + +``` +=[$Promoted] +``` + ##### Lookup column > [!NOTE] -> When accessing lookup columns in column or view formatting, you have access to the lookup value and lookup id as separate values. In form formatting and conditional field expressions, both values are returned as a single line of text. For instance, a lookup column referencing an item with item ID 1 (in the source list) with a value of `Toronto` will have a value of `1;#Toronto` when used in form formatting or conditional field expressions. - +> When accessing lookup columns in a column or view formatting, you can access the lookup value and lookup id as separate values. In form formatting and conditional field expressions, both values are returned as a single line of text. For instance, a lookup column referencing an item with item ID 1 (in the source list) with a value of `Toronto` will have a value of `1;#Toronto` when used in form formatting or conditional field expressions. The following formula checks if the lookup column `[$City]` has a value equal to *Toronto*. To do so, it splits the lookup value result by the separator and checks against the value. diff --git a/docs/declarative-customization/list-form-configuration.md b/docs/declarative-customization/list-form-configuration.md index 9238a0176..ab641654f 100644 --- a/docs/declarative-customization/list-form-configuration.md +++ b/docs/declarative-customization/list-form-configuration.md @@ -1,15 +1,15 @@ --- title: Configure the list form description: Configure list form with a custom header, footer and body with one or more sections. -ms.date: 04/23/2021 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # Configure the list form -You can configure the list form in a list or library with a custom header, footer and the form body with one or more sections with fields in each of those sections. The form configuration does not change the data in the list item or file; it only changes how the form is displayed to users who browse the list or library. Anyone who can create and manage views in a list can use form configuration to configure the form with header, footer and body with sections. +You can configure the list form in a list or library with a custom header, footer and the form body with one or more sections with fields in each of those sections. The form configuration does not change the data in the list item or file; it only changes how the form is displayed to users who browse the list or library. Anyone who can create and manage views in a list can use form configuration to configure the form with header, footer, and body with sections. -To configure a form, you will use JSON formatters that you are already familiar with when formatting a [column](column-formatting.md) or a [view](view-formatting.md) in a list or library. Form configuration allows for certain predefined elements and attributes to build the custom header, footer and body with one or more sections. +To configure a form, you will use JSON formatters that you are already familiar with when formatting a [column](column-formatting.md) or a [view](view-formatting.md) in a list or library. Form configuration allows for certain predefined elements and attributes to build the custom header, footer, and body with one or more sections. ## Get started @@ -18,23 +18,24 @@ To configure the form in a list or library: 1. Go to the list or library for which you want to configure the form. 1. If you are in a list: - - Open an item to view the item details in the display form. + - Open an item to view the item details in the display form. 1. If you are in a document library: - - Select a file. - - Select ... - - Select More - - Select Properties + - Select a file. + - Select ... + - Select More + - Select Properties 1. At the top of the form, expand **Edit Form** icon and then select **Configure layout** ![Configure list form](images/list-form-configuration-menu.png) 1. In the **Format** pane, you can choose to apply formatting to the following form sections: - - Header - - Body - - Footer + + - Header + - Body + - Footer ## Configure custom header @@ -50,66 +51,67 @@ To configure the form in a list or library: ```JSON { - "elmType": "div", - "attributes": { - "class": "ms-borderColor-neutralTertiary" - }, - "style": { - "width": "99%", - "border-top-width": "0px", - "border-bottom-width": "1px", - "border-left-width": "0px", - "border-right-width": "0px", - "border-style": "solid", - "margin-bottom": "16px" - }, - "children": [ + "elmType": "div", + "attributes": { + "class": "ms-borderColor-neutralTertiary" + }, + "style": { + "width": "99%", + "border-top-width": "0px", + "border-bottom-width": "1px", + "border-left-width": "0px", + "border-right-width": "0px", + "border-style": "solid", + "margin-bottom": "16px" + }, + "children": [ + { + "elmType": "div", + "style": { + "display": "flex", + "box-sizing": "border-box", + "align-items": "center" + }, + "children": [ { - "elmType": "div", - "style": { - "display": "flex", - "box-sizing": "border-box", - "align-items": "center" - }, - "children": [ - { - "elmType": "div", - "attributes": { - "iconName": "Group", - "class": "ms-fontSize-42 ms-fontWeight-regular ms-fontColor-themePrimary", - "title": "Details" - }, - "style": { - "flex": "none", - "padding": "0px", - "padding-left": "0px", - "height": "36px" - } - } - ] - }, + "elmType": "div", + "attributes": { + "iconName": "Group", + "class": "ms-fontSize-42 ms-fontWeight-regular ms-fontColor-themePrimary", + "title": "Details" + }, + "style": { + "flex": "none", + "padding": "0px", + "padding-left": "0px", + "height": "36px" + } + } + ] + }, + { + "elmType": "div", + "attributes": { + "class": "ms-fontColor-neutralSecondary ms-fontWeight-bold ms-fontSize-24" + }, + "style": { + "box-sizing": "border-box", + "width": "100%", + "text-align": "left", + "padding": "21px 12px", + "overflow": "hidden" + }, + "children": [ { - "elmType": "div", - "attributes": { - "class": "ms-fontColor-neutralSecondary ms-fontWeight-bold ms-fontSize-24" - }, - "style": { - "box-sizing": "border-box", - "width": "100%", - "text-align": "left", - "padding": "21px 12px", - "overflow": "hidden" - }, - "children": [ - { - "elmType": "div", - "txtContent": "='Contact details for ' + [$Title]" - } - ] + "elmType": "div", + "txtContent": "='Contact details for ' + [$Title]" } - ] + ] + } + ] } ``` + 1. To preview your changes, click the **Preview** button. 1. To save your changes, click the **Save** button. 1. Close and open the form again to view the custom header. @@ -172,7 +174,7 @@ To configure the form in a list or library: - One or more sections can be defined for a body. - Each section can reference one or more columns in the list or library. - A column can be referenced only in one section. - - If a column is referenced in multiple sections, the first section where the column is referenced will take the precedence. + - If a column is referenced in multiple sections, the first section where the column is referenced will take precedence. - A column not referenced in any of the sections will be automatically referenced in the last section. - New columns added will be automatically referenced in the last section. @@ -180,23 +182,23 @@ To configure the form in a list or library: ```JSON { - "sections": [ - { - //give a display name for the section - "displayname": "", - "fields": [ - //reference your fields here using their display name - "Title" - ] - }, - { - //give a display name for the section - "displayname": "", - "fields": [ - //reference your fields here using their display name - ] - } - ] + "sections": [ + { + //give a display name for the section + "displayname": "", + "fields": [ + //reference your fields here using their display name + "Title" + ] + }, + { + //give a display name for the section + "displayname": "", + "fields": [ + //reference your fields here using their display name + ] + } + ] } ``` @@ -204,30 +206,30 @@ To configure the form in a list or library: ```JSON { - "sections": [ - { - "displayname": "", - "fields": [ - "Title" - ] - }, - { - "displayname": "Details", - "fields": [ - "Department", - "Email", - "Country" - ] - }, - { - "displayname": "Application", - "fields": [ - "Application Id", - "Approver", - "Reviewer" - ] - } - ] + "sections": [ + { + "displayname": "", + "fields": [ + "Title" + ] + }, + { + "displayname": "Details", + "fields": [ + "Department", + "Email", + "Country" + ] + }, + { + "displayname": "Application", + "fields": [ + "Application Id", + "Approver", + "Reviewer" + ] + } + ] } ``` @@ -241,3 +243,60 @@ To configure the form in a list or library: 1. To preview your changes, click the **Preview** button. 1. To save your changes, click the **Save** button. 1. Close and open the form again to view the custom body. + + +## Custom Formatter for Read-Only Fields + +### Introduction + +Microsoft Lists offers a powerful way to organize information and collaborate with your team. With the rise of AI-based list item creation, users often need to view but not edit certain fields — like system-generated data or bot-added details. To meet this need, a new custom formatter feature is proposed to allow fields to appear as read-only in list forms. + +### Why Read-Only Fields Matter + +Currently, read-only fields are hidden from New Item and Edit forms. This creates challenges when AI bots or automated processes create items containing critical data that users need to see but not modify. For example: + +- A bot creates a customer service ticket with Issue details Issue Title, Issue Description. +- Users should see this information to take actions (e.g., send an email), but not be able to change it. + +The new custom formatter solves this by allowing these fields to display as read-only. + +### How the Custom Formatter Works + +The custom formatter introduces a new JSON configuration to mark fields as read-only in the form views. + +### JSON Structure + +```json +{ + "sections": [{}], + "fieldsettings": [ + { + "name": "fieldName", + "readonly": true + } + ] +} +``` + +- name: The internal name of the field. +- readonly: When set to true, the field is displayed as read-only. + +### Behavior in Different Form Views + +The custom formatter ensures a consistent user experience: + +- New Item form: The read-only field will not be shown. +- Edit form: The field is displayed without an editable textbox, similar to a Calculated Column. +- Edit all mode: The field remains visible and uneditable. + +The Save button works as expected — no accidental modifications to the read-only fields. + +### Example Use Case + +Imagine a CRM bot creating tickets with pre-filled Issue details. Using this formatted: + +- Issue Title (read-only): Users can see and copy the Issue Title but can't modify it. +- Issue Description (read-only): Users can see and copy the Issue Description but can't modify it. +- Issue Source (read-only): Users can click on the Issue source link but can't modify it. + +![image](https://github.com/user-attachments/assets/74c21844-a966-4930-93bb-cce10d69fa0e) diff --git a/docs/declarative-customization/site-design-json-schema.md b/docs/declarative-customization/site-design-json-schema.md index f9636ff8c..2ed0397a6 100644 --- a/docs/declarative-customization/site-design-json-schema.md +++ b/docs/declarative-customization/site-design-json-schema.md @@ -1,13 +1,13 @@ --- -title: Site design JSON schema -description: JSON schema reference for building site designs for SharePoint. -ms.date: 10/09/2020 -localization_priority: Priority +title: Site template JSON schema +description: JSON schema reference for building site templates for SharePoint. +ms.date: 11/18/2024 +ms.localizationpriority: high --- -# Site design JSON schema +# Site template JSON schema -The site design is a list of **actions**. For more complex actions, such as creating a list, there are also **subactions**. Each action is specified by a "verb" value. Verb actions are run in the order they appear in the JSON script. Only the verb actions listed here can be used; otherwise, an "unable to handle action" error will be thrown when trying to upload a site script. More actions will be added over time. +The site template is a list of **actions**. For more complex actions, such as creating a list, there are also **subactions**. Each action is specified by a "verb" value. Verb actions are run in the order they appear in the JSON script. Only the verb actions listed here can be used; otherwise, an "unable to handle action" error will be thrown when trying to upload a site script. More actions will be added over time. The overall JSON structure is specified as follows: @@ -18,44 +18,65 @@ The overall JSON structure is specified as follows: ... ... - ], - "bindata": { }, - "version": 1 + ] } ``` -You can view - and reference - the latest schema here: https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json +> [!TIP] +> You can view - and reference - the latest schema here: https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json + +> [!NOTE] +> **Actions** can be run more than once on a site. Rerunning **actions** on the same site with the same parameters will result in an update to the existing schema and not duplication of schema. + + + +## addContentTypesFromHub + +Use the **addContentTypesFromHub** verb to sync content types from a content type hub to the site. -#### Applying site designs multiple times +> [!NOTE] +> Once **addContentTypesFromHub** is applied on a site, the **addContentType** subaction on a list will be able to add it to the list by name. + +### JSON value + +- `ids`: An array of the content type IDs that need to be synced. + +#### Example + +```json +{ + "verb": "addContentTypesFromHub", + "ids": ["0x01007CE30DD1206047728BAFD1C39A850120"] +} +``` -**Actions** can be run more than once on a site. Rerunning **actions** on the same site with the same parameters will result in an update to the existing schema and not duplication of schema. ## Create a new SharePoint list Use the **createSPList** verb to create a new SharePoint list. > [!NOTE] -> Once **createSPList** is applied on a site, runnning the **createSPList** with the same list name will act as an update to the existing list. +> Once **createSPList** is applied on a site, running the **createSPList** with the same list name will act as an update to the existing list. -#### JSON values +### JSON values - `listName`: The name of the list. -- `templateType`: Which template to apply to the list. Typically you would use value 100. The full list of template type values is documented in [SPListTemplateType enumeration](/previous-versions/office/sharepoint-server/ms413878(v=office.15)) - but the ones we currently support include: +- `templateType`: Which template to apply to the list. Typically, you would use value 100. The full list of template type values is documented in [SPListTemplateType enumeration](/previous-versions/office/sharepoint-server/ms413878(v=office.15)) - but the ones we currently support include: | List Template Name | Enum | - |--------------|---------| - Generic List | 100 - Document Library | 101 - Survey | 102 - Links | 103 - Announcements | 104 - Contacts | 105 - Events | 106 - Tasks | 107 - Discussion Board | 108 - PictureLibrary | 109 - Site Pages | 119 - Issue Tracking | 1100 + | ------------------ | ---- | + | Generic List | 100 | + | Document Library | 101 | + | Survey | 102 | + | Links | 103 | + | Announcements | 104 | + | Contacts | 105 | + | Events | 106 | + | Tasks | 107 | + | Discussion Board | 108 | + | PictureLibrary | 109 | + | Site Pages | 119 | + | Issue Tracking | 1100 | If you use 101 or 119 and reference the default names ("Documents" or "Site Pages"), you can modify the library created with the template. See example below. - `subactions`: An array of actions that run in the order listed to create your list. @@ -152,7 +173,7 @@ Deletes a default field that was provided by the selected template type. ### addSPFieldXml -Enables defining fields and their elements using Collaborative Application Markup Language (CAML). For reference, see [Field element (Field)](https://docs.microsoft.com/sharepoint/dev/schema/field-element-field). Providing the ID attribute in the field schemaXml is important in order to prevent the field from being created multiple times if the script is run more than once. +Enables defining fields and their elements using Collaborative Application Markup Language (CAML). For reference, see [Field element (Field)](/sharepoint/dev/schema/field-element-field). Providing the ID attribute in the field schemaXml is important in order to prevent the field from being created multiple times if the script is run more than once. Currently these field constructs can't be designated as site columns nor added to content types. To create site columns with Field XML, use the **createSiteColumnXml** action. @@ -172,7 +193,7 @@ Currently these field constructs can't be designated as site columns nor added t ### addSPLookupFieldXml -Enables defining lookup fields and their dependent lists element using Collaborative Application Markup Language (CAML). For reference, see [Field element (Field)](https://docs.microsoft.com/sharepoint/dev/schema/field-element-field). Providing the ID attribute in the field schemaXml is important in order to prevent the field from being created multiple times if the script is run more than once. +Enables defining lookup fields and their dependent lists element using Collaborative Application Markup Language (CAML). For reference, see [Field element (Field)](/sharepoint/dev/schema/field-element-field). Providing the ID attribute in the field schemaXml is important in order to prevent the field from being created multiple times if the script is run more than once. #### JSON value @@ -198,7 +219,7 @@ Subaction to add a previously defined site column directly to a list (existing o #### JSON value - `internalName`: The internal name of the site column to add. -- `addToDefaultView`: Optional attribute that defaults to false. If true, the newly added field will also be added to the default view. +- `addToDefaultView`: Optional attribute that defaults to **False**. If **True**, the newly added field will also be added to the default view. #### Example @@ -218,12 +239,12 @@ Defines and adds a view to the list. Use this action to specify the desired colu - `name`: The name of the view. - `viewFields`: An array of the internal names of the fields in your view. -- `query`: A CAML query string that contains the `where` clause for the view's query. See [CAML schemas] (https://docs.microsoft.com/sharepoint/dev/schema/collaborative-application-markup-language-caml-schemas). +- `query`: A CAML query string that contains the `where` clause for the view's query. See [CAML schemas](/sharepoint/dev/schema/collaborative-application-markup-language-caml-schemas). - `rowLimit`: The row limit of the view. - `isPaged`: Specifies whether the view is paged. - `makeDefault`: If **True**, the view will be made the default for the list; otherwise, **False**. - `scope`: An optional setting to specify the scope of the view. For more information, see [SPViewScope enumeration](/previous-versions/office/sharepoint-server/ms458474(v=office.15)). -- `formatterJSON`: An optional setting to specify the JSON formatting for the view +- `formatterJSON`: An optional setting to specify the JSON formatting for the view. #### Example @@ -357,7 +378,7 @@ In this example, we are formatting a number column as a data bar. ### associateFieldCustomizer -Registers field extension for a list field. For more information on these client-side extensions, see [Build field customizer](https://docs.microsoft.com/sharepoint/dev/spfx/extensions/get-started/building-simple-field-customizer) tutorial. +Registers field extension for a list field. For more information on these client-side extensions, see [Build field customizer](/sharepoint/dev/spfx/extensions/get-started/building-simple-field-customizer) tutorial. #### JSON values @@ -396,7 +417,7 @@ Registers field extension for a list field. For more information on these client "verb": "associateFieldCustomizer", "internalName": "ElectricSlide", "clientSideComponentId": "35944670-3111-4482-b152-9e9d1sean9f7", - "clientSideComponentProperties": "{\"sampleText\":\"Yes - added by a site design, what?\"}" + "clientSideComponentProperties": "{\"sampleText\":\"Yes - added by a site template, what?\"}" } ] } @@ -409,7 +430,7 @@ Associates a ListViewCommandSet to the list #### JSON values - `title`: The title of the extension. -- `location`: A required parameter to specify where the command is displayed. Options are: ContextMenu or CommandBar. +- `location`: A required parameter to specify where the command is displayed. Options are: ClientSideExtension.ListViewCommandSet.ContextMenu or ClientSideExtension.ListViewCommandSet.CommandBar. - `clientSideComponentId`: The identifier (GUID) of the extension in the App Catalog. This property value can be found in the manifest.json file or in the elements.xml file. - `clientSideComponentProperties`: An optional parameter, which can be used to provide properties for the extension instance. @@ -443,9 +464,9 @@ Associates a ListViewCommandSet to the list { "verb": "associateListViewCommandSet", "title": "HelloWorld", - "location": "CommandBar", + "location": "ClientSideExtension.ListViewCommandSet.CommandBar", "clientSideComponentId": "13234283-d6c2-408f-a9ef-31a920c8ae78", - "clientSideComponentProperties": "{\"sampleText\":\"added by a site design\"}" + "clientSideComponentProperties": "{\"sampleText\":\"added by a site template\"}" } ] } @@ -456,7 +477,7 @@ Associates a ListViewCommandSet to the list Renames the list. To create a new list with a specific name, instead of using setTitle use the `listName` parameter in the `CreateSPList` action. > [!NOTE] -> Using `setTitle` will rename the list, preventing the list from updating if the site design is reapplied. +> Using `setTitle` will rename the list, preventing the list from updating if the site template is reapplied. #### JSON value @@ -600,13 +621,13 @@ Use the `addNavLink` verb to add a new navigation link to the site QuickLaunch o #### JSON values -- `url`: The url of the link to add. +- `url`: The URL of the link to add. - `displayName`: The display name of the link. - `navComponent`: The component where to add the link, QuickLaunch, Hub, or Footer. The default is **QuickLaunch**. - `isWebRelative`: **True** if the link is web relative; otherwise, **False**. The default is **False**. - `parentDisplayName`: An optional parameter. If provided, it makes this navigation link a child (sub link) of the navigation link with this displayName. If both this and parentUrl are provided, it searches for a link that matches both to be the parent. -- `parentUrl`: An optional parameter. If provided, it makes this navigation link a child (sub link) of the navigation link with this url. If both this and parentDisplayName are provided, it searches for a link that matches both to be the parent. -- `isParentUrlWebRelative`: An optional parameter. **True** if the link is web relative; otherwise, **False**. The default is **False**. +- `parentUrl`: An optional parameter. If provided, it makes this navigation link a child (sub link) of the navigation link with this URL. If both this and parentDisplayName are provided, it searches for a link that matches both to be the parent. +- `isParentUrlWebRelative`: An optional parameter. **True** if the link is web relative; otherwise, **False**. The default value is **False**. #### Example @@ -629,13 +650,13 @@ Use the `addNavLink` verb to add a new navigation link to the site QuickLaunch o }, { "verb": "addNavLink", - "url": "https://docs.microsoft.com/sharepoint/dev/declarative-customization/site-design-overview", + "url": "https://learn.microsoft.com/sharepoint/dev/declarative-customization/site-design-overview", "displayName": "SharePoint Site Design Overview", "parentDisplayName": "Documents" }, { "verb": "addNavLink", - "url": "https://docs.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema#add-a-navigation-link", + "url": "https://learn.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema#add-a-navigation-link", "displayName": "About Site Footer", "navComponent":"Footer" }, @@ -653,7 +674,7 @@ Use the `removeNavLink` verb to remove a navigation link from the site. #### JSON values -- `url`: The url of the link to remove. +- `url`: The URL of the link to remove. - `displayName`: The display name of the link. - `navComponent`: The component where to remove the link from, QuickLaunch, Hub, or Footer. The default is **QuickLaunch**. - `isWebRelative`: **True** if the link is web relative; otherwise, **False**. @@ -661,7 +682,7 @@ Use the `removeNavLink` verb to remove a navigation link from the site. #### Example > [!NOTE] -> This action can be used to remove site links added by the collaboration and communication site templates (for example, "home", "documents", "pages", "conversations", etc.). +> This action can be used to remove site links added by the collaboration and communication site templates (for example, "home", "documents", "pages", and "conversations"). ```json { @@ -699,6 +720,9 @@ Get-Content '\site-script.json' -Raw -Encoding U Use the `applyTheme` verb to add a custom theme to the site. For more information about how to construct and upload these themes, see [SharePoint site theming](site-theming/sharepoint-site-theming-overview.md). This site action only works for applying custom themes; to apply one of our in-product SharePoint themes, create a copy as a custom one and reference that one. +> [!NOTE] +> This action is automatically blocked for [channel sites](/sharepoint/teams-connected-sites). + #### JSON value - `themeName`: The name of the theme to apply. @@ -756,6 +780,7 @@ Use the `setSiteBranding` verb to specify the navigation layout, the header layo > [!NOTE] > Setting the navigation layout only works on the communication site template and for the hub navigation. +> This action is automatically blocked for [channel sites](/sharepoint/teams-connected-sites). #### JSON value @@ -785,7 +810,7 @@ Use the `setSiteLogo` verb to specify a logo for your site. #### JSON value -- `url`: The url of the logo image to use. +- `url`: The URL of the logo image to use. #### Example @@ -798,6 +823,9 @@ Use the `setSiteLogo` verb to specify a logo for your site. ## Join a hub site +> [!NOTE] +> This action is automatically blocked for [channel sites](/sharepoint/teams-connected-sites). + Use the `joinHubSite` verb to join the site to a designated hub site. #### JSON value @@ -807,7 +835,8 @@ Use the `joinHubSite` verb to join the site to a designated hub site. #### Example -[!NOTE] To get the hubSiteId, sign in to a site by using the Connect-PnPOnline cmdlet, and then run: +> [!NOTE] +> To get the `hubSiteId`, sign in to a site by using the **Connect-PnPOnline** cmdlet, and then run: ```PowerShell $hubSiteName = "My Hub Site" @@ -849,10 +878,10 @@ Use the `associateExtension` action to register a deployed SharePoint Framework #### JSON values - `title`: The title of the extension in the App Catalog. -- `location`: Used to specify the extension type. If its used to create commands, then where the command would be displayed; otherwise this should be set to ClientSideExtension.ApplicationCustomizer. +- `location`: Used to specify the extension type. If it's used to create commands, then where the command would be displayed; otherwise this should be set to ClientSideExtension.ApplicationCustomizer. - `clientSideComponentId`: The identifier (GUID) of the extension in the App Catalog. This property value can be found in the manifest.json file or in the elements.xml file. - `clientSideComponentProperties`: An optional parameter, which can be used to provide properties for the extension instance. -- `registrationId`: An optional parameter, which indicates the type of the list the extension is associated to (if its a list extension). +- `registrationId`: An optional parameter, which indicates the type of the list the extension is associated to (if it's a list extension). - `registrationType`: An optional parameter, which should be specified if the extension is associated with a list. - `scope`: Indicates whether the extension is associated with a `Web` or a `Site`. @@ -895,6 +924,9 @@ To enable the web scoped feature that allows for Events Lists to be created (fea Use the `triggerFlow` verb to kick off a custom flow. +> [!TIP] +> The article [Calling Power Automate from a site script](/sharepoint/dev/declarative-customization/site-design-trigger-flow-tutorial) provides an end-to-end example. + #### JSON values - `url`: A trigger URL of the flow. @@ -917,6 +949,9 @@ Use the `triggerFlow` verb to kick off a custom flow. ## Configure regional settings +> [!NOTE] +> This action is automatically blocked for [channel sites](/sharepoint/teams-connected-sites). + Use the `setRegionalSettings` action to configure the regional settings of the site (*/_layouts/15/regionalsetng.aspx*). #### JSON values @@ -940,6 +975,9 @@ Use the `setRegionalSettings` action to configure the regional settings of the s ## Add users (principals) to SharePoint Groups +> [!NOTE] +> This action is automatically blocked for [channel sites](/sharepoint/teams-connected-sites). + Use the `addPrincipalToSPGroup` action to manage addition of users and groups to select default SharePoint groups. For more information, see [Understanding SharePoint Groups](https://support.office.com/article/Understanding-SharePoint-groups-94D9B261-161E-4ACE-829E-ECA1C8CD2EB8). This action can be used for licensed users, security groups, and Microsoft 365 groups. #### JSON values @@ -977,6 +1015,9 @@ Use the `addPrincipalToSPGroup` action to manage addition of users and groups to ## Manage guest access +> [!NOTE] +> This action is automatically blocked for [channel sites](/sharepoint/teams-connected-sites). + Use the `setSiteExternalSharingCapability` action to manage guest access. For more information, see [Manage external sharing for your SharePoint Online environment](https://support.office.com/article/Manage-external-sharing-for-your-SharePoint-Online-environment-C8A462EB-0723-4B0B-8D0A-70FEAFE4BE85). @@ -996,4 +1037,4 @@ Use the `setSiteExternalSharingCapability` action to manage guest access. For mo ## See also -- [SharePoint site design and site script overview](site-design-overview.md) +- [SharePoint site template and site script overview](site-design-overview.md) diff --git a/docs/declarative-customization/site-design-o365cli.md b/docs/declarative-customization/site-design-o365cli.md index 879770cbe..6282f7491 100644 --- a/docs/declarative-customization/site-design-o365cli.md +++ b/docs/declarative-customization/site-design-o365cli.md @@ -1,8 +1,8 @@ --- title: SharePoint site design - CLI for Microsoft 365 commands description: Use the CLI for Microsoft 365 to create, retrieve, and remove site designs and site scripts. -ms.date: 09/02/2020 -localization_priority: Priority +ms.date: 06/27/2024 +ms.localizationpriority: high --- # SharePoint site design: CLI for Microsoft 365 commands @@ -16,10 +16,8 @@ Use the CLI for Microsoft 365 to create, retrieve, update, and remove site desig To run the CLI for Microsoft 365 commands, you'll need to do the following: 1. Download and install [NodeJS LTS version](https://nodejs.org/en/) - -2. Follow the instructions at [Installing the CLI](https://pnp.github.io/cli-microsoft365/user-guide/installing-cli/) to install the CLI for Microsoft 365 on your machine - -3. Follow the instructions at [Logging in to Office 365](https://pnp.github.io/cli-microsoft365/user-guide/connecting-office-365/) to connect to your SharePoint tenant. +1. Follow the instructions at [Installing the CLI](https://pnp.github.io/cli-microsoft365/user-guide/installing-cli/) to install the CLI for Microsoft 365 on your machine +1. Follow the instructions at [Logging in to Office 365](https://pnp.github.io/cli-microsoft365/user-guide/connecting-microsoft-365) to connect to your SharePoint tenant. To verify your setup and connection, try using the [sitedesign list](https://pnp.github.io/cli-microsoft365/cmd/spo/sitedesign/sitedesign-list) command to read the current list of site designs. If the cmdlet runs and returns with no errors, you're ready to proceed. diff --git a/docs/declarative-customization/site-design-overview.md b/docs/declarative-customization/site-design-overview.md index a453e0fac..701efedc2 100644 --- a/docs/declarative-customization/site-design-overview.md +++ b/docs/declarative-customization/site-design-overview.md @@ -1,307 +1,222 @@ ---- -title: SharePoint site design and site script overview -description: Use SharePoint site scripts and site designs to provide custom configurations to apply when new sites are created. -ms.date: 04/15/2021 -localization_priority: Priority ---- - -# SharePoint site design and site script overview - -> [!NOTE] -> - Site designs and site scripts are currently only supported by SharePoint Online. -> - In previous versions of SharePoint, site templates were called site designs but will be referred to as site templates moving forward. -> - SharePoint has a new site template experience that will be available to all SharePoint user with permissions to create SharePoint sites. [Learn more about the new site template experience](https://support.microsoft.com/office/apply-and-customize-sharepoint-site-templates-39382463-0e45-4d1b-be27-0e96aeec8398?ui=en-US&rs=en-US&ad=US). -> - As of today, the site template experience cannot be disabled. -> - Site template version history is not currently available for the new site template experience but will be included in future iterations. - -Use site templates and site scripts to automate provisioning new or existing modern SharePoint sites that use your own custom configurations. - -When people in your organization create new SharePoint sites, you often need to ensure some level of consistency. For example, you may need proper branding and theming applied to each new site. You may also have detailed site provisioning scripts, such as using the PnP provisioning engine, that need to be applied each time a new site is created. - -This article describes how you can use site templates and site scripts to provide custom configurations to apply when new sites are created. - -## How site templates work - -Site templates can be used each time a new site is created to apply a consistent set of actions. They can also be applied to existing modern sites (group-connected Team and Communication sites). Most actions typically affect the site itself, such as setting the theme or creating lists. But a site template can also include other actions, such as recording the new site URL to a log, or sending a tweet. - -You create site templates and register them in SharePoint to one of the modern template sites: the Team site or the Communication site. You can see how this works in the following steps. - -1. Go to the SharePoint start page on your developer tenant. - -2. Choose **Create site**. - - You'll see the two modern template sites: **Team site** and **Communication site**. - -3. Choose **Communication site**. - -The Communication site has a **Choose a design** box, which comes with the following site templates: - -- Topic -- Showcase -- Blank - -These are the default site templates. For each site template, there is a title, description, and image. - -![Default site design title, description, and image on Communication site template](images/site-designs-listed-on-communication-site-template.png) - -Had you chosen the Team site template, it contains only one default site template named **Team site**. - -For more information about how you can change the default site templates, see [Customize a default site design](customize-default-site-design.md). - -When a site template is selected, SharePoint creates the new site, and runs site scripts for the site design. The site scripts detail the work such as creating new lists or applying a theme. These script actions are run in the background. A notification bar will be displayed, which the site creator can click to view the status of the actions being applied. - -![Notification bar showing application of script actions in progress](images/site-design-notification-bar-in-progress-state.png) - -When the scripts are complete the notification bar message will change - allowing the site creator to either refresh the page to see the results of the applied scripts or to view the site script details. - -![Notification bar showing application of script actions is complete](images/site-design-notification-bar-completed-state.png) - -The site template information panel can be invoked by a site owner at any time to see what site templates have been applied to the site (and their script details) as well as to apply new or updated site templates. - -When the actions in the scripts are completed, SharePoint displays detailed results of those actions in a progress pane. - -![Site Design Information Panel](images/site-design-information-panel-applied-site-designs.png) - -> [!NOTE] -> Site templates can now be applied to previously created modern site collections. For more information, see the [REST API](site-design-rest-api.md) and [PowerShell](site-design-powershell.md) articles. - -## Anatomy of a site script - -Site scripts are JSON files that specify an ordered list of actions to run when creating the new site. The actions are run in the order listed. - -The following example is a script that has two top-level actions. First, it applies a theme that was previously created named **Contoso Explorers**. It then creates a **Customer Tracking** list. - -```json -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json", - "actions": [ - { - "verb": "applyTheme", - "themeName": "Contoso Explorers" - }, - { - "verb": "createSPList", - "listName": "Customer Tracking", - "templateType": 100, - "subactions": [ - { - "verb": "setDescription", - "description": "List of Customers and Orders" - }, - { - "verb": "addSPField", - "fieldType": "Text", - "displayName": "Customer Name", - "isRequired": false, - "addToDefaultView": true - }, - { - "verb": "addSPField", - "fieldType": "Number", - "displayName": "Requisition Total", - "addToDefaultView": true, - "isRequired": true - }, - { - "verb": "addSPField", - "fieldType": "User", - "displayName": "Contact", - "addToDefaultView": true, - "isRequired": true - }, - { - "verb": "addSPField", - "fieldType": "Note", - "displayName": "Meeting Notes", - "isRequired": false - } - ] - } - ], - "version": 1 -} -``` - -
- -Each action in a site script is specified by a **verb** value in the JSON. In the previous script, the first action is specified by the **applyTheme** verb. Next, the **createSPList** verb creates the list. Notice that the **createSPList** verb contains its own set of verbs that run additional actions on only the list. - -Available actions include: - -- Creating a new list or library (or modifying the default one created with the site) -- Creating site columns, content types, and configuring other list settings -- Set site branding properties like navigation layout, header layout and header background -- Applying a theme -- Setting a site logo -- Adding links to quick launch or hub navigation -- Triggering a Power Automate flow -- Installing a deployed solution from the app catalog -- Setting regional settings for the site -- Adding principals (users and groups) to SharePoint roles -- Setting external sharing capability for the site - -For a complete list of available actions and their parameters, see the [JSON schema](https://docs.microsoft.com/sharepoint/dev/declarative-customization/site-design-json-schema). - -> [!NOTE] -> For libraries and lists, use the PowerShell command [Get-SPOSiteScriptFromList](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteScriptFromList) to create the site script syntax from an existing SharePoint list. - -Site scripts can be run again on the same site after provisioning. Site scripts are non-destructive, so when they run again, they ensure that the site matches the configuration in the script. - -For example, if the site already has a list with the same name that the site script is creating, the site script will only add missing fields to the existing list. - -We'd previously capped the limit of site script actions to 30. This remains the limit for scripts applied synchronously using the [Invoke-SPOSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-online/Invoke-SPOSiteDesign) command, but based on customer feedback and support for additional actions we have bumped this limit to 300 actions (or 100,000 characters) when the scripts are applied asynchronously (either through the UI or using the [Add-SPOSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-online/Add-SPOSiteDesignTask) command). - -There is also a limit of 100 site scripts and 100 site templates per tenant. - -## Using PowerShell or REST to work with site templates and site scripts - -You can create site templates and site scripts by using PowerShell or the REST API. The following example creates a site script and a site template that uses the site script. - - - -```powershell -C:\> Get-Content 'c:\scripts\site-script.json' ` - -Raw | ` - Add-SPOSiteScript ` - -Title "Contoso theme and list" - -Id : 2756067f-d818-4933-a514-2a2b2c50fb06 -Title : Contoso theme and list -Description : -Content : -Version : 0 - -C:\> Add-SPOSiteDesign ` - -Title "Contoso customer tracking" ` - -WebTemplate "64" ` - -SiteScripts "2756067f-d818-4933-a514-2a2b2c50fb06" ` - -Description "Creates customer list and applies standard theme" -``` - - - -
- -In the previous example, the **Add-SPOSiteScript** cmdlet or **CreateSiteScript** REST API returns a site script id. This is used for the **SiteScripts** parameter in the subsequent call to the **Add-SPOSiteDesign** cmdlet or **CreateSiteDesign** REST API. - -The **WebTemplate** parameter set to the value 64 indicates registering this site design with the Team site template. If you have disabled modern Group creation, then publish your site designs using WebTemplate 1 so that they display for the "Group-less" Team site template. The value 68 would indicate registering with the Communication site template. The **Title** and **Description** parameters are displayed when a user views site designs as they create a new Team site. - -> [!NOTE] -> A site template can run multiple scripts. The script IDs are passed in an array, and they run in the order listed. - -For step-by-step information about creating a site template, see [Get started creating site designs](get-started-create-site-design.md). - -## PnP provisioning and customization using Power Automate - -One action provided by site scripts is the ability to trigger a Power Automate flow. This allows you to specify any custom action that you need beyond the actions provided natively in site scripts. - -If you use the PnP provisioning engine to automate site creation, you can use a Power Automate flow to integrate with site templates. You can maintain all your existing provisioning scripts as well as create new custom provisioning scripts by using this technique. - -
- -![Process of triggering a Microsoft Flow](images/process-for-triggering-a-custom-flow.png) - -The process works as follows: - -1. The script instantiates your Power Automate flow using a URL with additional details. - -2. The flow sends a message to an Azure storage queue that you have configured. - -3. The message triggers a call to an Azure function that you have configured. - -4. The Azure function runs your custom script, such as the PnP provisioning engine, to apply your custom configurations. - -For a step-by-step tutorial about how to configure your own Power Automate flow with PnP provisioning, see [Build a complete site design using the PnP provisioning engine](site-design-pnp-provisioning.md). - -## Scoping - -You can configure site templates to only appear for specific groups or people in your organization. This is useful to ensure that people only see the site templates intended for them. For example, you might want the accounting department to only see site templates specifically for them. And the accounting site templates may not make sense to show to anyone else. - -By default, a site template can be viewed by everyone when it is created. Scopes are applied by using the **Grant-SPOSiteDesignRights** cmdlet or the **GrantSiteDesignRights** REST API. You can specify the scope by user or a mail-enabled security group. - -The following example shows how to add Nestor (a user at the fictional Contoso site) view rights on a site template. - -```powershell -Grant-SPOSiteDesignRights ` - -Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 ` - -Principals "nestorw@contoso.onmicrosoft.com" ` - -Rights View -``` - - - -For more information about working with scopes, see [Scoping access to site designs](site-design-scoping.md). - -## See also - -- [Get started creating site template](get-started-create-site-design.md) -- [Apply a scope to your site design](site-design-scoping.md) -- [Site design JSON schema](site-design-json-schema.md) -- [PowerShell cmdlets for SharePoint site designs and site scripts](site-design-powershell.md) -- [Site design and site script REST API](site-design-rest-api.md) -- [Site design examples](https://github.com/SharePoint/sp-dev-site-scripts) +--- +title: SharePoint site template and site script overview +description: Use SharePoint site scripts and site templates to provide custom configurations to apply when new sites are created. +ms.date: 01/22/2025 +ms.localizationpriority: high +--- + +# SharePoint site template and site script overview + +> [!NOTE] +> - Site templates and site scripts are currently only supported by SharePoint Online. +> - In previous versions of SharePoint, site templates were called site designs but will be referred to as site templates moving forward. +> - SharePoint has a new site template experience that will be available to all SharePoint users with permission to create SharePoint sites. [Learn more about the new site template experience](https://support.microsoft.com/office/apply-and-customize-sharepoint-site-templates-39382463-0e45-4d1b-be27-0e96aeec8398?ui=en-US&rs=en-US&ad=US). +> - As of today, the site template experience cannot be disabled. +> - Site templates created by your organization and set as the default template will automatically apply when new sites are created but can be updated by the site owner by selecting **Settings** and then **Apply a site template.** +> - Site template version history is not currently available for the new site template experience but will be included in future iterations. + +Use site templates and site scripts to automate the provisioning of new or existing modern SharePoint sites that use your own custom configurations. + +When people in your organization create new SharePoint sites, you often need to ensure some level of consistency. For example, you may need proper branding and theming applied to each new site. You may also have detailed site provisioning scripts, such as using the PnP provisioning engine, that need to be applied each time a new site is created. + +This article describes how you can use site templates and site scripts to provide custom configurations to apply when new sites are created. + +## How site templates work + +Site templates can be used each time a new site is created to apply a consistent set of actions. They can also be applied to existing modern sites (group-connected Team and Communication sites). Most actions typically affect the site itself, such as setting the theme or creating lists. But a site template can also include other actions, such as recording the new site URL to a log or sending a tweet. + +> [!NOTE] +> - Site templates created using custom site scripts will display in the **From your organization** tab in the site template gallery. +> - Custom site templates made by your organization will be displayed in the site template gallery based on the type of site chosen by the user - either a communication site or a team site. Therefore, it is likely users will not see all site templates from your organization in the site template gallery. Soon, users will have the ability to browse all site templates provided by your organization regardless of which type of site was chosen. + +You create site templates and register them in SharePoint to one of the modern template sites: the Team site or the Communication site. You can see how this works in the following steps. + +1. Go to the SharePoint start page on your developer tenant. +1. Choose **Create site**. + + You'll see the two modern template sites: **Team site** and **Communication site**. + +1. Choose the type of site needed. + + - SharePoint will automatically create a communication site using the **Standard communication** site template. + - Had you chosen the default Team site, SharePoint will create a new site using the **Standard team** template. + + For more information about how you can change the default site templates, see [Customize a default site template](customize-default-site-design.md). + +1. Navigate to the **Settings** icon, and select **Apply site template** to review Microsoft-provided site templates based on the type of site you chose in step three. + +When a site template is selected, SharePoint creates the new site and runs site scripts for the site template. The site scripts provide the details for the template such as creating new lists or applying a theme. These script actions are run in the background. When the scripts are complete the page will refresh to display the site script details. + +> [!NOTE] +> Site templates can now be applied to previously created modern site collections. For more information, see the [REST API](site-design-rest-api.md) and [PowerShell](site-design-powershell.md) articles. + +## Anatomy of a site script + +Site scripts are JSON files that specify an ordered list of actions to run when creating the new site. The actions are run in the order listed. + +The following example is a script that has two top-level actions. First, it applies a theme that was previously created named **Contoso Explorers**. It then creates a **Customer Tracking** list. + +```json +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json", + "actions": [ + { + "verb": "applyTheme", + "themeName": "Contoso Explorers" + }, + { + "verb": "createSPList", + "listName": "Customer Tracking", + "templateType": 100, + "subactions": [ + { + "verb": "setDescription", + "description": "List of Customers and Orders" + }, + { + "verb": "addSPField", + "fieldType": "Text", + "displayName": "Customer Name", + "isRequired": false, + "addToDefaultView": true + }, + { + "verb": "addSPField", + "fieldType": "Number", + "displayName": "Requisition Total", + "addToDefaultView": true, + "isRequired": true + }, + { + "verb": "addSPField", + "fieldType": "User", + "displayName": "Contact", + "addToDefaultView": true, + "isRequired": true + }, + { + "verb": "addSPField", + "fieldType": "Note", + "displayName": "Meeting Notes", + "isRequired": false + } + ] + } + ] +} +``` + +Each action in a site script is specified by a **verb** value in the JSON. In the previous script, the first action is specified by the **applyTheme** verb. Next, the **createSPList** verb creates the list. Notice that the **createSPList** verb contains its own set of verbs that run additional actions on only the list. + +**Available actions include:** + +- Creating a new list or library (or modifying the default one created with the site) +- Creating site columns, content types, and configuring other list settings +- Set site branding properties like navigation layout, header layout, and header background +- Applying a theme** +- Setting a site logo +- Adding links to quick launch or hub navigation** +- Triggering a Power Automate flow +- Installing a deployed solution from the app catalog +- Setting regional settings for the site** +- Adding principals (users and groups) to SharePoint roles** +- Setting external sharing capability for the site** + +For a complete list of available actions and their parameters, see the [JSON schema](site-design-json-schema.md). + +> [!NOTE] +> +> - Actions marked with ** are automatically blocked for [channel sites](/sharepoint/teams-connected-sites). +> - For libraries and lists, use the PowerShell command [Get-SPOSiteScriptFromList](/powershell/module/sharepoint-online/Get-SPOSiteScriptFromList) to create the site script syntax from an existing SharePoint list. + +Site scripts can be run again on the same site after provisioning. They are non-destructive, so when they are run again, they ensure that the site matches the configuration in the script. + +For example, if the site already has a list with the same name that the site script is creating, the site script will only add missing fields to the existing list. + +We'd previously capped the limit of site script actions to 30. This remains the limit for scripts applied synchronously using the [Invoke-SPOSiteDesign](/powershell/module/sharepoint-online/Invoke-SPOSiteDesign) command, but based on customer feedback and support for additional actions we have bumped this limit to 300 actions (or 100,000 characters) when the scripts are applied asynchronously (either through the UI or using the [Add-SPOSiteDesignTask](/powershell/module/sharepoint-online/Add-SPOSiteDesignTask) command). + +There is also a limit of 100 site scripts and 100 site templates per tenant. + +## Using PowerShell or REST to work with site templates and site scripts + +You can create site templates and scripts using PowerShell or the REST API. The following example creates a site script and a site template that uses the script. + + + +```powershell +C:\> Get-Content 'c:\scripts\site-script.json' ` + -Raw | ` + Add-SPOSiteScript ` + -Title "Contoso theme and list" + +Id : 2756067f-d818-4933-a514-2a2b2c50fb06 +Title : Contoso theme and list +Description : +Content : +Version : 0 + +C:\> Add-SPOSiteDesign ` + -Title "Contoso customer tracking" ` + -WebTemplate "64" ` + -SiteScripts "2756067f-d818-4933-a514-2a2b2c50fb06" ` + -Description "Creates customer list and applies standard theme" +``` + +In the previous example, the **Add-SPOSiteScript** cmdlet or **CreateSiteScript** REST API returns a site script ID. This is used for the **SiteScripts** parameter in the subsequent call to the **Add-SPOSiteDesign** cmdlet or **CreateSiteDesign** REST API. + +| Parameter | Value | Site template type | +| :------------------- | :------------------- |:----------------| +| WebTemplate | 64 | Team site template | +| WebTemplate | 1 | Team site (with group creation disabled) | +| WebTemplate | 68 | Communication site template | +| WebTemplate | 69 | Channel site template | + +For step-by-step information about creating a site template, see [Get started creating site templates.](get-started-create-site-design.md) + +> [!NOTE] +> +> - A site template can run multiple scripts. The script IDs are passed in an array, and they run in the order listed. +> - The former term for site templates may still appear in certain cmdlet and script labels as "site design." + +## PnP provisioning and customization using Power Automate + +One action provided by site scripts is the ability to trigger a Power Automate flow. This allows you to specify any custom action that you need beyond the actions provided natively in site scripts. + +If you use the PnP provisioning engine to automate site creation, you can use a Power Automate flow to integrate with site templates. You can maintain all your existing provisioning scripts as well as create new custom provisioning scripts by using this technique. + +![Process of triggering a Microsoft Flow](images/process-for-triggering-a-custom-flow.png) + +The process works as follows: + +1. The script instantiates your Power Automate flow using a URL with additional details. +1. The flow sends a message to an Azure storage queue that you have configured. +1. The message triggers a call to an Azure function that you have configured. +1. The Azure function runs your custom script, such as the PnP provisioning engine, to apply your custom configurations. + +For a step-by-step tutorial about how to configure your own Power Automate flow with PnP provisioning, see [Build a complete site template using the PnP provisioning engine](site-design-pnp-provisioning.md). + +## Scoping + +You can configure site templates to only appear for specific groups or people in your organization. This is useful to ensure that people only see the site templates intended for them. For example, you might want the accounting department to only see site templates specifically for them. And the accounting site templates may not make sense to show to anyone else. + +By default, a site template can be viewed by everyone when it is created. Scopes are applied by using the **Grant-SPOSiteDesignRights** cmdlet or the **GrantSiteDesignRights** REST API. You can specify the scope by user or a mail-enabled security group. + +The following example shows how to add Nestor (a user at the fictional Contoso site) view rights on a site template. + +```powershell +Grant-SPOSiteDesignRights ` + -Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 ` + -Principals "nestorw@onmicrosoft.com" ` + -Rights View +``` + +For more information about working with scopes, see [Scoping access to site templates](site-design-scoping.md). + +## See also + +- [Get started creating site template](get-started-create-site-design.md) +- [Apply a scope to your site template](site-design-scoping.md) +- [Site template JSON schema](site-design-json-schema.md) +- [PowerShell cmdlets for SharePoint site templates and site scripts](site-design-powershell.md) +- [Site template and site script REST API](site-design-rest-api.md) +- [Site template examples](https://github.com/SharePoint/sp-dev-site-scripts) diff --git a/docs/declarative-customization/site-design-pnp-provisioning.md b/docs/declarative-customization/site-design-pnp-provisioning.md index 7bcdc34f4..74a7db6ef 100644 --- a/docs/declarative-customization/site-design-pnp-provisioning.md +++ b/docs/declarative-customization/site-design-pnp-provisioning.md @@ -1,8 +1,8 @@ --- title: Calling the PnP provisioning engine from a site script description: Build a complete SharePoint site design using the PnP provisioning engine -ms.date: 03/23/2021 -localization_priority: Priority +ms.date: 08/31/2023 +ms.localizationpriority: high --- # Calling the PnP provisioning engine from a site script @@ -10,7 +10,7 @@ localization_priority: Priority > [!NOTE] > This article uses the newest version of PnP PowerShell that is released in January 2021. As Azure Functions run PowerShell Core, you'll have to use this version of PnP PowerShell in your Azure Function. For more information about this version of PnP PowerShell see https://pnp.github.io/powershell. -Site designs offer a great way to standardize the look and feel of your site collections. However, you can't do some things with site designs, like add a footer to every page. You can use the PnP provisioning engine to create a template that you can use to provision an Application Customizer to a site. This Application Customizer can then update your page design, for example to register a footer on every page. +Site designs offer a great way to standardize the look and feel of your site collections. However, you can't do some things with site designs, like add a footer to every page. You can use the PnP provisioning engine to create a template that you can use to provision an Application Customizer to a site. This Application Customizer can then update your page design, for example, to register a footer on every page. This article describes how to create a site design that applies a PnP provisioning template to a site. The template will add an Application Customizer to render a footer. @@ -31,7 +31,7 @@ You'll use these components to trigger the PnP provisioning code after you creat ## Set up app-only access to your tenant -We are going to use authentication with a clientid and a certificate in this tutorial. +We are going to use authentication with a client id and a certificate in this tutorial. 1. Create a new self-signed certificate with PnP PowerShell on your computer: @@ -64,11 +64,14 @@ To set up the Azure Queue storage: ## Create the flow +> [!NOTE] +> The **Request** trigger used below is now **Premium** and will therefore require additional licensing. + To put a message in the queue, you need to create a flow. 1. Go to the [Power Automate](https://flow.microsoft.com) site, sign in, and choose **Create from Blank** at the top of the page. 1. Choose **Search hundreds of connectors and triggers** to select your trigger. -1. Search for **Request**, and select **Request - When a HTTP Request is received**. +1. Search for **Request**, and select **Request - When an HTTP Request is received [Premium]**. 1. Enter the following JSON as your request body: ```json @@ -176,7 +179,7 @@ Copy the following provisioning template XML to a new file and save the file as } ``` - Save the file. Notice, that if you do no intent to use the Azure PowerShell Cmdlets you can remove that entry from this file. The requirements.psd1 file makes sure that specific PowerShell modules will be available to all functions. At the first execution of the Azure Function these modules will be downloaded and made available. You can also use wildcard references for the version. See for more information about this file here: https://docs.microsoft.com/azure/azure-functions/functions-reference-powershell?tabs=portal#dependency-management + Save the file. Notice, that if you do no intent to use the Azure PowerShell Cmdlets you can remove that entry from this file. The requirements.psd1 file makes sure that specific PowerShell modules will be available to all functions. At the first execution of the Azure Function these modules will be downloaded and made available. You can also use wildcard references for the version. [See for more information about this file](/azure/azure-functions/functions-reference-powershell?tabs=portal#dependency-management). 1. Create a new Azure Function **Functions** > **Add**: @@ -216,7 +219,7 @@ Copy the following provisioning template XML to a new file and save the file as ``` Replace **[insertyourAppIdHere]** with the value that the `Register-PnPAzureApp` cmdlet returned for AzureAppId. - + Replace **'contoso.onmicrosoft.com'** with your tenant details. ## Create the site design diff --git a/docs/declarative-customization/site-design-pnppowershell.md b/docs/declarative-customization/site-design-pnppowershell.md index 60ff140aa..8faccf981 100644 --- a/docs/declarative-customization/site-design-pnppowershell.md +++ b/docs/declarative-customization/site-design-pnppowershell.md @@ -1,8 +1,8 @@ --- title: SharePoint site design - PnP PowerShell cmdlets description: Use PnP PowerShell cmdlets to create, retrieve, and remove site designs and site scripts. -ms.date: 03/09/2021 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # SharePoint site design: PnP PowerShell cmdlets @@ -17,15 +17,15 @@ To run the PnP PowerShell cmdlets, you'll need to do the following: 1. Download and install the PnP PowerShell Module by running: -```PowerShell -Install-Module PnP.PowerShell -``` + ```PowerShell + Install-Module PnP.PowerShell + ``` -2. Connect to the SharePoint Online Admin Center of your tenant: +1. Connect to the SharePoint Online Admin Center of your tenant: -```PowerShell -Connect-PnPOnline -Url https://tenant-admin.sharepoint.com -Interactive -``` + ```PowerShell + Connect-PnPOnline -Url https://tenant-admin.sharepoint.com -Interactive + ``` To verify your setup and connection, try using the `Get-PnPSiteScript` cmdlet to read the current list of site scripts. If the cmdlet runs and returns with no errors, you're ready to proceed. @@ -33,27 +33,27 @@ To verify your setup and connection, try using the `Get-PnPSiteScript` cmdlet to The following cmdlets are available for managing site designs and site scripts from PnP PowerShell: -- [Add-PnPSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Add-PnPSiteDesign) -- [Add-PnPSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Add-PnPSiteDesignTask) -- [Add-PnPSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Add-PnPSiteScript) -- [Add-PnPSiteScriptPackage](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Add-PnPSiteScriptPackage) -- [Get-PnPSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteDesign) -- [Get-PnPSiteDesignRights](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteDesignRights) -- [Get-PnPSiteDesignRun](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteDesignRun) -- [Get-PnPSiteDesignRunStatus](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteDesignRunStatus) -- [Get-PnPSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteDesignTask) -- [Get-PnPSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteScript) -- [Get-PnPSiteScriptFromList](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteScriptFromList) -- [Get-PnPSiteScriptFromWeb](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Get-PnPSiteScriptFromWeb) -- [Grant-PnPSiteDesignRights](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Grant-PnPSiteDesignRights) -- [Invoke-PnPSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Invoke-PnPSiteDesign) -- [Remove-PnPSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Remove-PnPSiteDesign) -- [Remove-PnPSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Remove-PnPSiteDesignTask) -- [Remove-PnPSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Remove-PnPSiteScript) -- [Revoke-PnPSiteDesignRights](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Revoke-PnPSiteDesignRights) -- [Set-PnPSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Set-PnPSiteDesign) -- [Set-PnPSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Set-PnPSiteScript) -- [Set-PnPSiteScriptPackage](https://docs.microsoft.com/powershell/module/sharepoint-pnp/Set-PnPSiteScriptPackage) +- [Add-PnPSiteDesign](https://pnp.github.io/powershell/cmdlets/Add-PnPSiteDesign.html) +- [Add-PnPSiteDesignTask](https://pnp.github.io/powershell/cmdlets/Add-PnPSiteDesignTask.html) +- [Add-PnPSiteScript](https://pnp.github.io/powershell/cmdlets/Add-PnPSiteScript.html) +- [Add-PnPSiteScriptPackage](https://pnp.github.io/powershell/cmdlets/Add-PnPSiteScriptPackage.html) +- [Get-PnPSiteDesign](https://pnp.github.io/powershell/cmdlets/Get-PnPSiteDesign.html) +- [Get-PnPSiteDesignRights](https://pnp.github.io/powershell/cmdlets/Get-PnPSiteDesignRights.html) +- [Get-PnPSiteDesignRun](https://pnp.github.io/powershell/cmdlets/Get-PnPSiteDesignRun.html) +- [Get-PnPSiteDesignRunStatus](https://pnp.github.io/powershell/cmdlets/Get-PnPSiteDesignRunStatus.html) +- [Get-PnPSiteDesignTask](https://pnp.github.io/powershell/cmdlets/Get-PnPSiteDesignTask.html) +- [Get-PnPSiteScript](https://pnp.github.io/powershell/cmdlets/Get-PnPSiteScript.html) +- [Get-PnPSiteScriptFromList](https://pnp.github.io/powershell/cmdlets/Get-PnPSiteScriptFromList.html) +- [Get-PnPSiteScriptFromWeb](https://pnp.github.io/powershell/cmdlets/Get-PnPSiteScriptFromWeb.html) +- [Grant-PnPSiteDesignRights](https://pnp.github.io/powershell/cmdlets/Grant-PnPSiteDesignRights.html) +- [Invoke-PnPSiteDesign](https://pnp.github.io/powershell/cmdlets/Invoke-PnPSiteDesign.html) +- [Remove-PnPSiteDesign](https://pnp.github.io/powershell/cmdlets/Remove-PnPSiteDesign.html) +- [Remove-PnPSiteDesignTask](https://pnp.github.io/powershell/cmdlets/Remove-PnPSiteDesignTask.html) +- [Remove-PnPSiteScript](https://pnp.github.io/powershell/cmdlets/Remove-PnPSiteScript.html) +- [Revoke-PnPSiteDesignRights](https://pnp.github.io/powershell/cmdlets/Revoke-PnPSiteDesignRights.html) +- [Set-PnPSiteDesign](https://pnp.github.io/powershell/cmdlets/Set-PnPSiteDesign.html) +- [Set-PnPSiteScript](https://pnp.github.io/powershell/cmdlets/Set-PnPSiteScript.html) +- [Set-PnPSiteScriptPackage](https://pnp.github.io/powershell/cmdlets/Set-PnPSiteScriptPackage.html) ## See also diff --git a/docs/declarative-customization/site-design-powershell.md b/docs/declarative-customization/site-design-powershell.md index 6e50ffbbb..085f6ac92 100644 --- a/docs/declarative-customization/site-design-powershell.md +++ b/docs/declarative-customization/site-design-powershell.md @@ -1,8 +1,8 @@ --- title: SharePoint site design - PowerShell cmdlets description: Use PowerShell cmdlets to create, retrieve, and remove site designs and site scripts. -ms.date: 09/28/2020 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # SharePoint site design: PowerShell cmdlets @@ -14,34 +14,33 @@ Use PowerShell cmdlets to create, retrieve, update, and remove site designs and To run the PowerShell cmdlets, you'll need to do the following: 1. Download and install the [SharePoint Online Management Shell](https://www.microsoft.com/download/details.aspx?id=35588). If you already have a previous version of the shell installed, uninstall it first and then install the latest version. +1. Follow the instructions at [Connect to SharePoint Online PowerShell](https://technet.microsoft.com/library/fp161372.aspx) to connect to your SharePoint tenant. -2. Follow the instructions at [Connect to SharePoint Online PowerShell](https://technet.microsoft.com/library/fp161372.aspx) to connect to your SharePoint tenant. - -To verify your setup, try using the [Get-SPOSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteScript?view=sharepoint-ps) cmdlet to read the current list of site scripts. If the cmdlet runs and returns with no errors, you're ready to proceed. +To verify your setup, try using the [Get-SPOSiteScript](/powershell/module/sharepoint-online/Get-SPOSiteScript) cmdlet to read the current list of site scripts. If the cmdlet runs and returns with no errors, you're ready to proceed. ## Site design cmdlets The following cmdlets are available for managing site designs and site scripts from PowerShell: -- [Add-SPOSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-online/Add-SPOSiteDesign?view=sharepoint-ps) -- [Add-SPOSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-online/Add-SPOSiteDesignTask?view=sharepoint-ps) -- [Add-SPOSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-online/Add-SPOSiteScript?view=sharepoint-ps) -- [Get-SPOSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteDesign?view=sharepoint-ps) -- [Get-SPOSiteDesignRights](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteDesignRights?view=sharepoint-ps) -- [Get-SPOSiteDesignRun](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteDesignRun?view=sharepoint-ps) -- [Get-SPOSiteDesignRunStatus](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteDesignRunStatus?view=sharepoint-ps) -- [Get-SPOSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteDesignTask?view=sharepoint-ps) -- [Get-SPOSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteScript?view=sharepoint-ps) -- [Get-SPOSiteScriptFromWeb](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteScriptFromWeb?view=sharepoint-ps) -- [Get-SPOSiteScriptFromList](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOSiteScriptFromList?view=sharepoint-ps) -- [Grant-SPOSiteDesignRights](https://docs.microsoft.com/powershell/module/sharepoint-online/Grant-SPOSiteDesignRights?view=sharepoint-ps) -- [Invoke-SPOSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-online/Invoke-SPOSiteDesign?view=sharepoint-ps) -- [Remove-SPOSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-online/Remove-SPOSiteDesign?view=sharepoint-ps) -- [Remove-SPOSiteDesignTask](https://docs.microsoft.com/powershell/module/sharepoint-online/Remove-SPOSiteDesignTask?view=sharepoint-ps) -- [Remove-SPOSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-online/Remove-SPOSiteScript?view=sharepoint-ps) -- [Revoke-SPOSiteDesignRights](https://docs.microsoft.com/powershell/module/sharepoint-online/Revoke-SPOSiteDesignRights?view=sharepoint-ps) -- [Set-SPOSiteDesign](https://docs.microsoft.com/powershell/module/sharepoint-online/Set-SPOSiteDesign?view=sharepoint-ps) -- [Set-SPOSiteScript](https://docs.microsoft.com/powershell/module/sharepoint-online/Set-SPOSiteScript?view=sharepoint-ps) +- [Add-SPOSiteDesign](/powershell/module/sharepoint-online/Add-SPOSiteDesign) +- [Add-SPOSiteDesignTask](/powershell/module/sharepoint-online/Add-SPOSiteDesignTask) +- [Add-SPOSiteScript](/powershell/module/sharepoint-online/Add-SPOSiteScript) +- [Get-SPOSiteDesign](/powershell/module/sharepoint-online/Get-SPOSiteDesign) +- [Get-SPOSiteDesignRights](/powershell/module/sharepoint-online/Get-SPOSiteDesignRights) +- [Get-SPOSiteDesignRun](/powershell/module/sharepoint-online/Get-SPOSiteDesignRun) +- [Get-SPOSiteDesignRunStatus](/powershell/module/sharepoint-online/Get-SPOSiteDesignRunStatus) +- [Get-SPOSiteDesignTask](/powershell/module/sharepoint-online/Get-SPOSiteDesignTask) +- [Get-SPOSiteScript](/powershell/module/sharepoint-online/Get-SPOSiteScript) +- [Get-SPOSiteScriptFromWeb](/powershell/module/sharepoint-online/Get-SPOSiteScriptFromWeb) +- [Get-SPOSiteScriptFromList](/powershell/module/sharepoint-online/Get-SPOSiteScriptFromList) +- [Grant-SPOSiteDesignRights](/powershell/module/sharepoint-online/Grant-SPOSiteDesignRights) +- [Invoke-SPOSiteDesign](/powershell/module/sharepoint-online/Invoke-SPOSiteDesign) +- [Remove-SPOSiteDesign](/powershell/module/sharepoint-online/Remove-SPOSiteDesign) +- [Remove-SPOSiteDesignTask](/powershell/module/sharepoint-online/Remove-SPOSiteDesignTask) +- [Remove-SPOSiteScript](/powershell/module/sharepoint-online/Remove-SPOSiteScript) +- [Revoke-SPOSiteDesignRights](/powershell/module/sharepoint-online/Revoke-SPOSiteDesignRights) +- [Set-SPOSiteDesign](/powershell/module/sharepoint-online/Set-SPOSiteDesign) +- [Set-SPOSiteScript](/powershell/module/sharepoint-online/Set-SPOSiteScript) ## See also diff --git a/docs/declarative-customization/site-design-rest-api.md b/docs/declarative-customization/site-design-rest-api.md index 9aee0368d..e017ef341 100644 --- a/docs/declarative-customization/site-design-rest-api.md +++ b/docs/declarative-customization/site-design-rest-api.md @@ -1,8 +1,8 @@ --- title: SharePoint site design REST API description: Work with SharePoint site designs through the SharePoint REST interface to perform basic create, read, update, and delete (CRUD) operations. -ms.date: 04/07/2021 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # Site design and site script REST API @@ -15,7 +15,7 @@ The SharePoint Online (and SharePoint 2016 and later on-premises) REST service s Before you get started, make sure that you're familiar with the following: -- [Get to know the SharePoint REST service](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md) +- [Get to know the SharePoint REST service](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md) - [Complete basic operations using SharePoint REST endpoints](../sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints.md) ## REST commands @@ -81,7 +81,7 @@ Creates a new site script. The following example creates a new site script that applies a custom theme. ```javascript -var site_script = +var site_script = { "$schema": "schema.json", "actions": [ @@ -178,11 +178,11 @@ Gets the site script syntax for a specific SharePoint site. Here is an example of retrieving a site script JSON object from the Contoso site collection. ```javascript -RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteScriptFromWeb", { +RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteScriptFromWeb", { "webUrl":"https://contoso.sharepoint.com/", - "info":{ + "info":{ "IncludeBranding":true, - "IncludedLists":[ + "IncludedLists":[ "Lists/Contoso customer list" ], "IncludeRegionalSettings":true, @@ -367,7 +367,7 @@ Updates a site script with new values. In the REST call, all parameters are opti Here's an example of updating an existing site script with a new JSON script and values. ```javascript -var updated_site_script = +var updated_site_script = { "$schema": "schema.json", "actions": [ @@ -380,12 +380,12 @@ var updated_site_script = "version": 2 }; -RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.UpdateSiteScript", +RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.UpdateSiteScript", {updateInfo:{ Id:"07702c07-0485-426f-b710-4704241caad9", - Title:"New Contoso theme", - Description:"Updated Contoso site script", - Version: 2, + Title:"New Contoso theme", + Description:"Updated Contoso site script", + Version: 2, Content: JSON.stringify(updated_site_script)}}); ``` @@ -419,7 +419,7 @@ Deletes a site script. Here's an example of deleting a site script. ```javascript -RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.DeleteSiteScript", +RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.DeleteSiteScript", {id:"07702c07-0485-426f-b710-4704241caad9"}); ``` @@ -491,7 +491,7 @@ Applies a site design to an existing site collection. Here's an example of applying a site design to the ProjectGo site collection. ```javascript -RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.ApplySiteDesign", {siteDesignId: "614f9b28-3e85-4ec9-a961-5971ea086cca", "webUrl":"https://contoso.sharepoint.com/sites/projectgo"}); +RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.ApplySiteDesign", {"siteDesignId": "614f9b28-3e85-4ec9-a961-5971ea086cca", "webUrl":"https://contoso.sharepoint.com/sites/projectgo"}); ``` ## AddSiteDesignTaskToCurrentWeb @@ -579,7 +579,7 @@ Gets information about a specific site design. Here's an example of getting information about a specific site design by ID. ```javascript -RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteDesignMetadata", +RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteDesignMetadata", {id:"614f9b28-3e85-4ec9-a961-5971ea086cca"}); ``` @@ -605,10 +605,10 @@ Here is an example of the JSON returned after calling **GetSiteDesignMetadata**. ## UpdateSiteDesign -Updates a site design with new values. In the REST call, all parameters are optional except the site script Id. +Updates a site design with new values. In the REST call, all parameters are optional except the site script Id. -> [!NOTE] -> If you had previously set the IsDefault parameter to **TRUE** and wish it to remain true, you must pass in this parameter again (otherwise it will be reset to **FALSE**). +> [!NOTE] +> If you had previously set the IsDefault parameter to **TRUE** and wish it to remain true, you must pass in this parameter again (otherwise it will be reset to **FALSE**). ### Parameters @@ -630,14 +630,14 @@ Here's an example that updates every value on an existing site design. ```javascript RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.UpdateSiteDesign", {updateInfo:{ - Id:"614f9b28-3e85-4ec9-a961-5971ea086cca", - Title:"Contoso customer site", - Description:"Creates site with customer theme and list", - SiteScriptIds:["6b2b79e4-5da3-4352-8565-42a896fabd57","2b997981-258b-4e1e-81ff-f6fbf7235a1f"], + Id:"614f9b28-3e85-4ec9-a961-5971ea086cca", + Title:"Contoso customer site", + Description:"Creates site with customer theme and list", + SiteScriptIds:["6b2b79e4-5da3-4352-8565-42a896fabd57","2b997981-258b-4e1e-81ff-f6fbf7235a1f"], PreviewImageUrl:"https://contoso.sharepoint.com/SiteAssets/customer_site.png", - PreviewImageAltText:"Customer site with list and theme", - WebTemplate:"68", - Version: 7, + PreviewImageAltText:"Customer site with list and theme", + WebTemplate:"68", + Version: 7, IsDefault: false}}); ``` @@ -675,7 +675,7 @@ Deletes a site design. Here's an example of deleting a site design. ```javascript -RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.DeleteSiteDesign", +RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.DeleteSiteDesign", {id:"f9e76746-5076-4bd2-bad3-e611c488fa85"}); ``` @@ -695,7 +695,7 @@ Gets a list of principals that have access to a site design. Here's an example of getting view rights for a specific site design. ```javascript -RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteDesignRights", +RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GetSiteDesignRights", {id:"dc076f7b-6c15-4d76-8f85-948a17f5dd18"}); ``` @@ -767,7 +767,7 @@ Revokes access from a site design for one or more principals. Here's an example of revoking view rights from a site design for Patti (fictional user at Contoso). ```javascript -RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.RevokeSiteDesignRights", +RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScriptUtility.RevokeSiteDesignRights", {id:"5d4756e9-e1f5-42f7-afa7-5fa5aac170aa", principalNames:["PattiF@contoso.onmicrosoft.com"] }); ``` diff --git a/docs/declarative-customization/site-design-scoping.md b/docs/declarative-customization/site-design-scoping.md index 54ae7de9d..3d697e7d1 100644 --- a/docs/declarative-customization/site-design-scoping.md +++ b/docs/declarative-customization/site-design-scoping.md @@ -1,26 +1,29 @@ --- -title: Scoping access to SharePoint site designs -description: Set scope on SharePoint site designs to control who can view and access them. -ms.date: 04/20/2018 -localization_priority: Priority +title: Select audiences for SharePoint site templates +description: Determine which audiences can access certain site templates. +ms.date: 06/28/2022 +ms.localizationpriority: high --- -# Scoping access to site designs +# Scoping access to site templates -Site designs are available to everyone by default. You can also scope site designs so that they are only available to specific users or groups. For example, the accounting department may have specific site designs they use, but it may not make sense to share those site designs with everyone. +Site templates are available to everyone by default. You can also scope site templates so that they are only available to specific users or groups. For example, the accounting department may have specific site designs they use, but it may not make sense to share those site templates with everyone. -This article explains how you can control which users and groups can see specific site designs. +This article explains how you can control which users and groups can see specific site templates. -## Grant rights to a site design +> [!NOTE] +> Users with the SharePoint Admin role assigned will see all site templates, regardless of scoping. + +## Grant rights to a site template -When a site design is first created, it is available to everyone. You can grant **View** rights to the site design. After rights are granted, only the users or groups (principals) specified have access. You can continue granting rights to more principals with subsequent API calls. +When a site template is first created, it is available to everyone. You can grant **View** rights to the site template. After rights are granted, only the users or groups (principals) specified have access. You can continue granting rights to more principals with subsequent API calls. > [!NOTE] > Scoping is currently only available for mail-enabled security groups and users. We are planning to provide support for Microsoft 365 groups in the future. ## Grant rights to security groups -The following example shows how to scope an existing site design so that only the mail-enabled security group **accounting** can view and use the site design. +The following example shows how to scope an existing site template so that only the mail-enabled security group **accounting** can view and use the site template. ```powershell Grant-SPOSiteDesignRights ` @@ -31,7 +34,7 @@ Grant-SPOSiteDesignRights `
-You might want to create a new site design and grant rights at the same time, as shown in the next example. +You might want to create a new site template and grant rights at the same time, as shown in the next example. ```powershell Add-SPOSiteDesign ` @@ -47,7 +50,7 @@ Add-SPOSiteDesign ` ## Grant rights to users -The following example shows how to grant view rights on a site design to Nestor (a user at the fictional Contoso site). +The following example shows how to grant view rights on a site template to Nestor (a user at the fictional Contoso site). ```powershell PS C:\> Grant-SPOSiteDesignRights ` @@ -56,7 +59,7 @@ PS C:\> Grant-SPOSiteDesignRights ` -Rights View ``` -## View rights assigned to a site design +## View rights assigned to a site template To view rights, use the **Get-SPOSiteDesignRights** cmdlet. The following example shows how to use this cmdlet and a response in the case where only Nestor has view rights. @@ -70,16 +73,16 @@ DisplayName PrincipalName Rights Nestor Wilke i:0#.f|membership|nestorw@contoso.onmicrosoft.com View ``` -## Revoke rights from a site design +## Revoke rights from a site template -You can revoke rights for any principal. If you revoke view rights for all principles, the site design will again be available to everyone. +You can revoke rights for any principal. If you revoke view rights for all principles, the site template will again be available to everyone. The following example revokes access for the accounting mail-enabled security group and Nestor. ```powershell Revoke-SPOSiteDesignRights ` -Identity db752673-18fd-44db-865a-aa3e0b28698e ` - -Principals ("accounting@contoso.sharepoint.com","nestorw@spdfcontosodemo2.onmicrosoft.com") ` + -Principals ("accounting@contoso.sharepoint.com","nestorw@contoso.onmicrosoft.com") ` ``` ## See also diff --git a/docs/declarative-customization/site-design-trigger-flow-tutorial.md b/docs/declarative-customization/site-design-trigger-flow-tutorial.md index a46038a61..285da5ad0 100644 --- a/docs/declarative-customization/site-design-trigger-flow-tutorial.md +++ b/docs/declarative-customization/site-design-trigger-flow-tutorial.md @@ -1,133 +1,119 @@ --- title: Using site designs and Power Automate to track site creation requests description: Invoke a Power Automate flow using the site script triggerFlow action to capture the site creation event and build a site directory. This tutorial is intended to illustrate a simple example of using site designs and Power Automate. -ms.date: 06/05/2020 -localization_priority: Priority +ms.date: 06/05/2024 +ms.localizationpriority: high --- # Calling Power Automate from a site script Site designs are a powerful extensibility mechanism for customizing - and standardizing - the look and feel of your site collections. One of the script actions - **triggerFlow** - can be used to call custom solutions to apply configurations we don't support natively. Power Automate flows can also be used for business automation - in this case, used with site designs to track the creation of sites! -This article describes how to build a simple site directory using a site design and Power Automate. Whenever a site is created using this site design, details of the site are captured and written to a SharePoint list. +This article describes how to build a simple site directory using a site design and Power Automate. Whenever a site is created using this site design, details of the site are captured and written to a SharePoint list. The steps in this article illustrate the following components: -- A SharePoint list +- A SharePoint list - A site design and a site script - Power Automate -You'll first create the SharePoint list and then it will be referenced in your Power Automate flow - which will be triggered by the site design applied after the site is created. +You'll first create the SharePoint list and then it will be referenced in your Power Automate flow - which will be triggered by the site design applied after the site is created. ## Create your site directory list -You need to first set up the list that will be used to record all the sites created using this site design. +You need to first set up the list that will be used to record all the sites created using this site design. -1. Select a site collection to host your list. +1. Select a site collection to host your list. +1. Create a new list named "Site Directory" +1. Configure the following fields: -2. Create a new list named "Site Directory" - -3. Configure the following fields: - webUrl (Hyperlink or Picture) - webDescription (Single line of text) - creatorName (Single line of text) - creatorEmail (Single line of text) - createdTimeUTC (Single line of text) - ## Create the flow -In order to capture the site creation event and create the corresponding list item, you need to create a flow - which can then be referenced in your site design's site script: +In order to capture the site creation event and create the corresponding list item, you need to create a flow - which can then be referenced in your site design's site script: 1. Go to the [Power Automate](https://flow.microsoft.com) site, sign in, and choose **+ Automated—from blank* at the top of the page. +1. Click **Skip** on the next screen +1. Choose **Search connectors and triggers** to select your trigger +1. Search for **Request**, and then choose **Request - When a HTTP Request is received [PREMIUM]**. **NOTE**: The **Request** trigger is now **PREMIUM** and will therefore require additional licensing. +1. Enter the following JSON as your request body: -2. Click **Skip** on the next screen - -2. Choose **Search connectors and triggers** to select your trigger - -3. Search for **Request**, and then choose **Request - When a HTTP Request is received [PREMIUM]**. **NOTE**: The **Request** trigger is now **PREMIUM** and will therefore require additional licensing. - -4. Enter the following JSON as your request body: - - ```json - { - "type": "object", - "properties": { - "webUrl": { - "type": "string" - }, - "parameters": { - "type": "object", - "properties": { - "event": { - "type": "string" - }, - "product": { - "type": "string" + ```json + { + "type": "object", + "properties": { + "webUrl": { + "type": "string" + }, + "parameters": { + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "product": { + "type": "string" + } } + }, + "webDescription": { + "type": "string" + }, + "creatorName": { + "type": "string" + }, + "creatorEmail": { + "type": ["string", "null"] + }, + "createdTimeUTC": { + "type": "string" } - }, - "webDescription": { - "type": "string" - }, - "creatorName": { - "type": "string" - }, - "creatorEmail": { - "type": "string" - }, - "createdTimeUTC": { - "type": "string" } } - } - ``` - -5. Select **+ New Step**. - -6. Search for **Create item**, and select **SharePoint - Create item**. - -7. Enter the site address where the list above was created. - -8. Select the "Site Directory" list you created in the previous step. - -9. Enter a value for the **Title** field - this will be the same value for each list item. For example: "Contoso Travel: New Project Site Created". - -10. For each field in your list form, add the corresponding element from the Dynamic Content picker. When you are done your action should look something like this: + ``` -![Screenshot of a flow named 'When an HTTP request is received', showing the URL, Request body, Queue name, and Message fields](images/site-directory-flow-configuration.png) +1. Select **+ New Step**. +1. Search for **Create item**, and select **SharePoint - Create item**. +1. Enter the site address where the list above was created. +1. Select the "Site Directory" list you created in the previous step. +1. Enter a value for the **Title** field - this will be the same value for each list item. For example: "Contoso Travel: New Project Site Created". +1. For each field in your list form, add the corresponding element from the Dynamic Content picker. When you are done your action should look something like this: -11. Choose **Save**. This generates the HTTP Post URL that you will need to copy for your site script `triggerFlow` action. + ![Screenshot of a flow named 'When an HTTP request is received', showing the URL, Request body, Queue name, and Message fields](images/site-directory-flow-configuration.png) -14. Choose the first step in your flow ('When an HTTP request is received') and copy the URL. - -15. Save your flow. +1. Choose **Save**. This generates the HTTP Post URL that you will need to copy for your site script `triggerFlow` action. +1. Choose the first step in your flow ('When an HTTP request is received') and copy the URL. +1. Save your flow. ## Create the site design 1. Open PowerShell and make sure that you have the latest [SharePoint Online Management Shell](https://www.microsoft.com/download/details.aspx?id=35588) installed. +1. Connect to your tenant using **Connect-SPOService**. -2. Connect to your tenant using **Connect-SPOService**. - - ```powershell + ```powershell Connect-SPOService -Url https://[yourtenant]-admin.sharepoint.com - ``` + ``` -3. Now you can get the existing site designs. +1. Now you can get the existing site designs. - ```powershell + ```powershell Get-SPOSiteDesign - ``` + ``` -
+ To create a site design, you first need to create a site script. A site design is a container that refers to one or more site scripts. -To create a site design, you first need to create a site script. A site design is a container that refers to one or more site scripts. +1. Copy the following JSON code to your clipboard and modify it. Set the **url** property to the value that you copied when you created the flow. The URL looks similar to the following: -1. Copy the following JSON code to your clipboard and modify it. Set the `url` property to the value that you copied when you created the flow. The URL looks similar to the following: + ```http + https://prod-27.westus.logic.azure.com:443/workflows/ef7434cf0d704dd48ef5fb6...oke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun + ``` - `https://prod-27.westus.logic.azure.com:443/workflows/ef7434cf0d704dd48ef5fb6...oke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun` - - ```json + ```json { "$schema": "schema.json", "actions": [ @@ -142,25 +128,24 @@ To create a site design, you first need to create a site script. A site design i } ] } - ``` - -2. Select the JSON again and copy it again to your clipboard. + ``` -3. Open PowerShell and enter the following to copy the script into a variable and create the site script: +1. Select the JSON again and copy it again to your clipboard. +1. Open PowerShell and enter the following to copy the script into a variable and create the site script: - ```powershell + ```powershell $script = Get-Clipboard -Raw Add-SPOSiteScript -Title "Site Script to record site creation event" -Content $script Get-SPOSiteScript - ``` + ``` -4. You will see a list of one or more site scripts, including the site script you just created. Select the ID of the site script that you created, and copy it to the clipboard. +1. You will see a list of one or more site scripts, including the site script you just created. Select the ID of the site script that you created, and copy it to the clipboard. +1. Use the following command to create the site design: -5. Use the following command to create the site design: - - ```powershell + ```powershell Add-SPOSiteDesign -Title "Record site creation" -Description "The creation of this site will be recorded in the site directory list" -SiteScripts [Paste the ID of the Site Script here] -WebTemplate "64" - ``` + ``` + > [!NOTE] > The **Add-SPOSiteDesign** cmdlet associates the site design with the Team site. If you want to associate the design with a Communication site, use `-WebTemplate "68"`. @@ -170,9 +155,7 @@ To test the results, create a new site. In your SharePoint tenant, select **Shar Your new site design should show up as a design option. Notice that the site design is applied after the site is created. If you configured it correctly, your flow will be triggered. You can check the run history of the flow to verify that it ran correctly. - ## See also - [SharePoint site design and site script overview](site-design-overview.md) - [Calling the PnP provisioning engine from a site script](site-design-pnp-provisioning.md) - diff --git a/docs/declarative-customization/site-theming/sharepoint-site-theming-csom.md b/docs/declarative-customization/site-theming/sharepoint-site-theming-csom.md index 6daee60ec..a15b25f9c 100644 --- a/docs/declarative-customization/site-theming/sharepoint-site-theming-csom.md +++ b/docs/declarative-customization/site-theming/sharepoint-site-theming-csom.md @@ -1,13 +1,13 @@ --- title: SharePoint site theming - CSOM development -description: The SharePoint client-side object model (CSOM) provides access to the SharePoint object model from code that is running locally or on a different server than SharePoint. -ms.date: 04/19/2018 -localization_priority: Priority +description: The SharePoint client-side object model (CSOM) provides access to the SharePoint object model from code that is running locally or on a different server than SharePoint. +ms.date: 06/28/2022 +ms.localizationpriority: high --- # SharePoint site theming: CSOM development -The SharePoint client-side object model (CSOM) provides access to the SharePoint object model from code that is running locally or on a different server than SharePoint. +The SharePoint client-side object model (CSOM) provides access to the SharePoint object model from code that is running locally or on a different server than SharePoint. ## Prerequisites @@ -20,7 +20,7 @@ You also need to reference the [Microsoft.SharePointOnline.CSOM](https://www.nug ## CSOM code example -The following example shows how to create a __Microsoft.Online.SharePoint.TenantAdministration.Tenant__ object and call the __GetAllTenantThemes__ method to return a list of themes. +The following example shows how to create a __Microsoft.Online.SharePoint.TenantAdministration.Tenant__ object and call the __GetAllTenantThemes__ method to return a list of themes. > [!NOTE] > * The URL used to create the context object includes the _-admin_ suffix because **TenantAdministration** methods work with the admin site. @@ -80,7 +80,7 @@ public class SPOTheme  ## Applying a theme -There's currently no supported CSOM API to programmatically apply a theme to a specific site. For information on applying custom themes to individual site collections see [SharePoint site design and site script overview](https://docs.microsoft.com/sharepoint/dev/declarative-customization/site-design-overview) +There's currently no supported CSOM API to programmatically apply a theme to a specific site. For information on applying custom themes to individual site collections see [SharePoint site design and site script overview](/sharepoint/dev/declarative-customization/site-design-overview) ## Methods/properties of the Microsoft.Online.SharePoint.TenantAdministration.Tenant class @@ -92,7 +92,7 @@ Add a theme to the tenant. __Namespace:__ Microsoft.Online.SharePoint.TenantAdministration.Tenant
__Parameters:__ string name, string themeJson
-__Return type:__ ClientResult +__Return type:__ ClientResult\ ### DeleteTenantTheme public method @@ -108,7 +108,7 @@ Retrieve all the themes that are currently available in the tenant, including an __Namespace:__ Microsoft.Online.SharePoint.TenantAdministration.Tenant
__Parameters:__ none
-__Return type:__ ClientObjectList +__Return type:__ ClientObjectList\ ### GetTenantTheme public method @@ -131,7 +131,7 @@ Update the settings for an existing theme. __Namespace:__ Microsoft.Online.SharePoint.TenantAdministration.Tenant
__Parameters:__ string name, string themeJson
-__Return type:__ ClientResult +__Return type:__ ClientResult\ ## Methods of the Microsoft.Online.SharePoint.TenantManagement.Tenant class @@ -143,7 +143,7 @@ Add a theme to the tenant. __Namespace:__ Microsoft.Online.SharePoint.TenantManagement.Tenant
__Parameters:__ string name, string themeJson
-__Return type:__ ClientResult +__Return type:__ ClientResult\ ### GetAllTenantThemes public method @@ -151,7 +151,7 @@ Retrieve all the themes that are currently available in the tenant, including an __Namespace:__ Microsoft.Online.SharePoint.TenantManagement.Tenant
__Parameters:__ none
-__Return type:__ ClientObjectList +__Return type:__ ClientObjectList\ ### GetHideDefaultThemes public method @@ -159,7 +159,7 @@ Read the current setting for whether to hide default themes in the theme picker __Namespace:__ Microsoft.Online.SharePoint.TenantManagement.Tenant
__Parameters:__ none
-__Return type:__ ClientResult +__Return type:__ ClientResult\ ### GetTenantTheme public method @@ -183,7 +183,7 @@ Update the settings for an existing theme. __Namespace:__ Microsoft.Online.SharePoint.TenantManagement.Tenant
__Parameters:__ string name, string themeJson
-__Return type:__ ClientResult +__Return type:__ ClientResult\ ## See also @@ -191,4 +191,3 @@ __Return type:__ ClientResult * [SharePoint site theming: JSON schema](sharepoint-site-theming-json-schema.md) * [SharePoint site theming: PowerShell cmdlets](sharepoint-site-theming-powershell.md) * [SharePoint site theming: REST API](sharepoint-site-theming-rest-api.md) - diff --git a/docs/declarative-customization/site-theming/sharepoint-site-theming-json-schema.md b/docs/declarative-customization/site-theming/sharepoint-site-theming-json-schema.md index f282c180f..db182d93b 100644 --- a/docs/declarative-customization/site-theming/sharepoint-site-theming-json-schema.md +++ b/docs/declarative-customization/site-theming/sharepoint-site-theming-json-schema.md @@ -1,8 +1,8 @@ --- title: SharePoint site theming - JSON schema description: The new SharePoint site theming features use a JSON schema to store color settings and other information about each theme. -ms.date: 05/09/2020 -localization_priority: Priority +ms.date: 08/08/2024 +ms.localizationpriority: high --- # SharePoint site theming: JSON schema @@ -95,7 +95,18 @@ The SharePoint Framework includes eight built-in themes: six on light background Another option is to use the [Theme Generator tool](https://aka.ms/themedesigner) to build a custom theme. It provides an interactive UI for selecting theme colors, and automatically generates the JSON, SASS, and PowerShell definitions for your custom theme. > [!NOTE] -> The theme generator definitions do not currently include the "error" or "accent" color slots. These can be manually added to your generated definition before uploading to the tenant. +> The theme generator definitions do not currently include the following color slots and key/value pairs: +> +> - "primaryBackground" +> - "primaryText" +> - "bodyBackground" +> - "bodyText" +> - "disabledBackground" +> - "disabledText" +> - "error" +> - "accent" +> +> These can be manually added to your generated definition before uploading to the tenant. ![Theme Generator tool](../../images/theme-generator-tool.png) @@ -105,80 +116,50 @@ The following is a summary of the built-in themes, including JSON definitions fo The following table shows the color palette used by the Teal theme. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
themeDarker: #014446black: #000000
themeDark: #025c5fneutralDark: #212121
themeDarkAlt: #026d70neutralPrimary: #333
themePrimary: #03787cneutralPrimaryAlt: #3c3c3c
neutralSecondary: #666666
neutralTertiary: #a6a6a6
themeSecondary: #13898dneutralTertiaryAlt: #c8c8c8
themeTertiary: #49aeb1neutralLight: #eaeaea
themeLight: #98d6d8neutralLighter: #f4f4f4
themeLighter: #c5e9eaneutralLighterAlt: #f8f8f8
themeLighterAlt: #f0f9fawhite: #fff
- -The following code shows how to define a dictionary in PowerShell for the Red theme's color palette. +| Theme colors | Neutral colors | +| ------------------------ | --------------------------- | +| themeDarker: #014446 | black: #000000 | +| themeDark: #025c5f | neutralDark: #212121 | +| themeDarkAlt: #026d70 | neutralPrimary: #333 | +| themePrimary: #03787c | neutralPrimaryAlt: #3c3c3c | +| | neutralSecondary: #666666 | +| | neutralTertiary: #a6a6a6 | +| themeSecondary: #13898d | neutralTertiaryAlt: #c8c8c8 | +| themeTertiary: #49aeb1 | neutralLight: #eaeaea | +| themeLight: #98d6d8 | neutralLighter: #f4f4f4 | +| themeLighter: #c5e9ea | neutralLighterAlt: #f8f8f8 | +| themeLighterAlt: #f0f9fa | white: #fff | + +The following code shows how to define a dictionary in PowerShell for the Teal theme's color palette. ```powershell {  -    themeDarker: '#014446',  -    themeDark: '#025c5f',  -    themeDarkAlt: '#026d70',  -    themePrimary: '#03787c',  -    themeSecondary: '#13898d',  -    themeTertiary: '#49aeb1',  -    themeLight: '#98d6d8',  -    themeLighter: '#c5e9ea',  -    themeLighterAlt: '#f0f9fa',  -    black: '#000000',  -    neutralDark: '#212121',  -    neutralPrimary: '#333',  -    neutralPrimaryAlt: '#3c3c3c',  -    neutralSecondary: '#666666',  -    neutralTertiary: '#a6a6a6',  -    neutralTertiaryAlt: '#c8c8c8',  -    neutralLight: '#eaeaea',  -    neutralLighter: '#f4f4f4',  -    neutralLighterAlt: '#f8f8f8',  -    white: '#fff',  -    neutralQuaternaryAlt: '#dadada',  -    neutralQuaternary: '#d0d0d0',  -    neutralSecondaryAlt: '#767676',  -    primaryBackground: '#fff',  -    primaryText: '#333', - accent: '#4f6bed' + themeDarker: '#014446',  + themeDark: '#025c5f',  + themeDarkAlt: '#026d70',  + themePrimary: '#03787c',  + themeSecondary: '#13898d',  + themeTertiary: '#49aeb1',  + themeLight: '#98d6d8',  + themeLighter: '#c5e9ea',  + themeLighterAlt: '#f0f9fa',  + black: '#000000',  + neutralDark: '#212121',  + neutralPrimary: '#333',  + neutralPrimaryAlt: '#3c3c3c',  + neutralSecondary: '#666666',  + neutralTertiary: '#a6a6a6',  + neutralTertiaryAlt: '#c8c8c8',  + neutralLight: '#eaeaea',  + neutralLighter: '#f4f4f4',  + neutralLighterAlt: '#f8f8f8',  + white: '#fff',  + neutralQuaternaryAlt: '#dadada',  + neutralQuaternary: '#d0d0d0',  + neutralSecondaryAlt: '#767676',  + primaryBackground: '#fff',  + primaryText: '#333', + accent: '#4f6bed' } ``` @@ -186,80 +167,50 @@ The following code shows how to define a dictionary in PowerShell for the Red th The following table shows the color palette used by the Red theme. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
themeDarker: #751b1eblack: #000000
themeDark: #952226neutralDark: #212121
themeDarkAlt: #c02b30neutralPrimary: #333
themePrimary: #d13438neutralPrimaryAlt: #3c3c3c
neutralSecondary: #666666
neutralTertiary: #a6a6a6
themeSecondary: #d6494dneutralTertiaryAlt: #c8c8c8
themeTertiary: #ecaaacneutralLight: #eaeaea
themeLight: #f6d6d8neutralLighter: #f4f4f4
themeLighter: #faebebneutralLighterAlt: #f8f8f8
themeLighterAlt: #fdf5f5white: #fff
+| Theme colors | Neutral colors | +| ------------------------ | --------------------------- | +| themeDarker: #751b1e | black: #000000 | +| themeDark: #952226 | neutralDark: #212121 | +| themeDarkAlt: #c02b30 | neutralPrimary: #333 | +| themePrimary: #d13438 | neutralPrimaryAlt: #3c3c3c | +| | neutralSecondary: #666666 | +| | neutralTertiary: #a6a6a6 | +| themeSecondary: #d6494d | neutralTertiaryAlt: #c8c8c8 | +| themeTertiary: #ecaaac | neutralLight: #eaeaea | +| themeLight: #f6d6d8 | neutralLighter:#f4f4f4 | +| themeLighter: #faebeb | neutralLighterAlt: #f8f8f8 | +| themeLighterAlt: #fdf5f5 | white: #fff | The following code shows how to define a dictionary in PowerShell for the Red theme's color palette. ```powershell {  -    themeDarker: '#751b1e',  -    themeDark: '#952226',  -    themeDarkAlt: '#c02b30',  -    themePrimary: '#d13438',  -    themeSecondary: '#d6494d',  -    themeTertiary: '#ecaaac',  -    themeLight: '#f6d6d8',  -    themeLighter: '#faebeb',  -    themeLighterAlt: '#fdf5f5',  -    black: '#000000',  -    neutralDark: '#212121',  -    neutralPrimary: '#333',  -    neutralPrimaryAlt: '#3c3c3c',  -    neutralSecondary: '#666666',  -    neutralTertiary: '#a6a6a6',  -    neutralTertiaryAlt: '#c8c8c8',  -    neutralLight: '#eaeaea',  -    neutralLighter: '#f4f4f4',  -    neutralLighterAlt: '#f8f8f8',  -    white: '#fff',  -    neutralQuaternaryAlt: '#dadada',  -    neutralQuaternary: '#d0d0d0',  -    neutralSecondaryAlt: '#767676',  -    primaryBackground: '#fff',  -    primaryText: '#333', - accent: '#ca5010' + themeDarker: '#751b1e',  + themeDark: '#952226',  + themeDarkAlt: '#c02b30',  + themePrimary: '#d13438',  + themeSecondary: '#d6494d',  + themeTertiary: '#ecaaac',  + themeLight: '#f6d6d8',  + themeLighter: '#faebeb',  + themeLighterAlt: '#fdf5f5',  + black: '#000000',  + neutralDark: '#212121',  + neutralPrimary: '#333',  + neutralPrimaryAlt: '#3c3c3c',  +  neutralSecondary: '#666666',  + neutralTertiary: '#a6a6a6',  + neutralTertiaryAlt: '#c8c8c8',  + neutralLight: '#eaeaea',  + neutralLighter: '#f4f4f4',  + neutralLighterAlt: '#f8f8f8',  + white: '#fff',  + neutralQuaternaryAlt: '#dadada',  + neutralQuaternary: '#d0d0d0',  + neutralSecondaryAlt: '#767676',  + primaryBackground: '#fff',  + primaryText: '#333', + accent: '#ca5010' } ``` @@ -267,81 +218,50 @@ The following code shows how to define a dictionary in PowerShell for the Red th The following table shows the color palette used by the Orange theme. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
themeDarker: #6f2d09black: #000000
themeDark: #8d390bneutralDark: #212121
themeDarkAlt: #b5490fneutralPrimary: #333
themePrimary: #ca5010neutralPrimaryAlt: #3c3c3c
neutralSecondary: #666666
neutralTertiary: #a6a6a6
themeSecondary: #e55c12neutralTertiaryAlt: #c8c8c8
themeTertiary: #f6b28dneutralLight: #eaeaea
themeLight: #fbdac9neutralLighter: #f4f4f4
themeLighter: #fdede4neutralLighterAlt: #f8f8f8
themeLighterAlt: #fef6f1white: #fff
+| Theme colors | Neutral colors | +| ------------------------ | --------------------------- | +| themeDarker: #6f2d09 | black: #000000 | +| themeDark: #8d390b | neutralDark: #212121 | +| themeDarkAlt: #b5490f | neutralPrimary: #333 | +| themePrimary: #ca5010 | neutralPrimaryAlt: #3c3c3c | +| | neutralSecondary: #666666 | +| | neutralTertiary: #a6a6a6 | +| themeSecondary: #e55c12 | neutralTertiaryAlt: #c8c8c8 | +| themeTertiary: #f6b28d | neutralLight: #eaeaea | +| themeLight: #fbdac9 | neutralLighter: #f4f4f4 | +| themeLighter: #fdede4 | neutralLighterAlt: #f8f8f8 | +| themeLighterAlt: #fef6f1 | white: #fff | The following code shows how to define a dictionary in PowerShell for the Orange theme's color palette. ```powershell {  -    themeDarker: '#6f2d09',  -    themeDark: '#8d390b',  -    themeDarkAlt: '#b5490f',  -    themePrimary: '#ca5010',  -    themeSecondary: '#e55c12',  -    themeTertiary: '#f6b28d',  -    themeLight: '#fbdac9',  -    themeLighter: '#fdede4',  -    themeLighterAlt: '#fef6f1',  -    black: '#000000',  -    neutralDark: '#212121',  -    neutralPrimary: '#333',  -    neutralPrimaryAlt: '#3c3c3c',  -    neutralSecondary: '#666666',  -    neutralTertiary: '#a6a6a6',  -    neutralTertiaryAlt: '#c8c8c8',  -    neutralLight: '#eaeaea',  -    neutralLighter: '#f4f4f4',  -    neutralLighterAlt: '#f8f8f8',  -    white: '#fff',  -    neutralQuaternaryAlt: '#dadada',  -    neutralQuaternary: '#d0d0d0',  -    neutralSecondaryAlt: '#767676',  -    primaryBackground: '#fff',  -    primaryText: '#333', - accent: '#986f0b' + themeDarker: '#6f2d09',  + themeDark: '#8d390b',  + themeDarkAlt: '#b5490f',  + themePrimary: '#ca5010',  + themeSecondary: '#e55c12',  + themeTertiary: '#f6b28d',  + themeLight: '#fbdac9',  + themeLighter: '#fdede4',  + themeLighterAlt: '#fef6f1',  + black: '#000000',  + neutralDark: '#212121',  + neutralPrimary: '#333',  + neutralPrimaryAlt: '#3c3c3c',  + neutralSecondary: '#666666',  + neutralTertiary: '#a6a6a6',  + neutralTertiaryAlt: '#c8c8c8',  + neutralLight: '#eaeaea',  + neutralLighter: '#f4f4f4',  + neutralLighterAlt: '#f8f8f8',  + white: '#fff',  + neutralQuaternaryAlt: '#dadada',  + neutralQuaternary: '#d0d0d0',  + neutralSecondaryAlt: '#767676',  + primaryBackground: '#fff',  + primaryText: '#333', + accent: '#986f0b' } ``` @@ -349,81 +269,50 @@ The following code shows how to define a dictionary in PowerShell for the Orange The following table shows the color palette used by the Green theme. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
themeDarker: #094c23black: #000000
themeDark: #0c602cneutralDark: #212121
themeDarkAlt: #0f7c39neutralPrimary: #333
themePrimary: #10893eneutralPrimaryAlt: #3c3c3c
neutralSecondary: #666666
neutralTertiary: #a6a6a6
themeSecondary: #14a94eneutralTertiaryAlt: #c8c8c8
themeTertiary: #7aefa7neutralLight: #eaeaea
themeLight: #bff7d5neutralLighter: #f4f4f4
themeLighter: #dffbeaneutralLighterAlt: #f8f8f8
themeLighterAlt: #effdf4white: #fff
+| Theme colors | Neutral colors | +| ------------------------ | --------------------------- | +| themeDarker: #294903 | black: #000000 | +| themeDark: #386304 | neutralDark: #201f1e | +| themeDarkAlt: #427505 | neutralPrimary: #323130 | +| themePrimary: #498205 | neutralPrimaryAlt: #3b3a39 | +| | neutralSecondary: #605e5c | +| | neutralTertiary: #a19f9d | +| themeSecondary: #5a9117 | neutralTertiaryAlt: #c8c6c4 | +| themeTertiary: #85b44c | neutralLight: #edebe9 | +| themeLight: #bdda9b | neutralLighter: #f3f2f1 | +| themeLighter: #dbebc7 | neutralLighterAlt: #faf9f8 | +| themeLighterAlt: #f6faf0 | white: #fff | The following code shows how to define a dictionary in PowerShell for the Green theme's color palette. ```powershell {  -    themePrimary: '#10893e',  -    themeLighterAlt: '#effdf4',  -    themeLighter: '#dffbea',  -    themeLight: '#bff7d5',  -    themeTertiary: '#7aefa7',  -    themeSecondary: '#14a94e',  -    themeDarkAlt: '#0f7c39',  -    themeDark: '#0c602c',  -    themeDarker: '#094c23',  -    neutralLighterAlt: '#f8f8f8',  -    neutralLighter: '#f4f4f4',  -    neutralLight: '#eaeaea',  -    neutralQuaternaryAlt: '#dadada',  -    neutralQuaternary: '#d0d0d0',  -    neutralTertiaryAlt: '#c8c8c8',  -    neutralTertiary: '#a6a6a6',  -    neutralSecondaryAlt: '#767676',  -    neutralSecondary: '#666666',  -    neutralPrimary: '#333',  -    neutralPrimaryAlt: '#3c3c3c',  -    neutralDark: '#212121',  -    black: '#000000',  -    white: '#fff',  -    primaryBackground: '#fff',  -    primaryText: '#333', - accent: '#038387' + themePrimary: '#498205',  + themeLighterAlt: '#f6faf0',  + themeLighter: '#dbebc7',  + themeLight: '#bdda9b',  + themeTertiary: '#85b44c',  + themeSecondary: '#5a9117',  + themeDarkAlt: '#427505',  + themeDark: '#386304',  + themeDarker: '#294903',  + neutralLighterAlt: '#faf9f8',  + neutralLighter: '#f3f2f1',  + neutralLight: '#edebe9',  + neutralQuaternaryAlt: '#e1dfdd',  + neutralQuaternary: '#d2d0ce',  + neutralTertiaryAlt: '#c8c6c4',  + neutralTertiary: '#a19f9d',  + neutralSecondaryAlt: '#8a8886',  + neutralSecondary: '#605e5c',  + neutralPrimary: '#323130',  + neutralPrimaryAlt: '#3b3a39',  + neutralDark: '#201f1e',  + black: '#000000',  + white: '#fff',  + primaryBackground: '#fff',  + primaryText: '#333', + accent: '#03787c' } ``` @@ -431,81 +320,50 @@ The following code shows how to define a dictionary in PowerShell for the Green The following table shows the color palette used by the Blue theme. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
themeDarker: #004578black: #000000
themeDark: #005a9eneutralDark: #212121
themeDarkAlt: #106ebeneutralPrimary: #333
themePrimary: #0078d7neutralPrimaryAlt: #3c3c3c
neutralSecondary: #666666
neutralTertiary: #a6a6a6
themeSecondary: #2b88d8neutralTertiaryAlt: #c8c8c8
themeTertiary: #71afe5neutralLight: #eaeaea
themeLight: #c7e0f4neutralLighter: #f4f4f4
themeLighter: #deecf9neutralLighterAlt: #f8f8f8
themeLighterAlt: #eff6fcwhite: #fff
+| Theme colors | Neutral colors | +| ------------------------ | --------------------------- | +| themeDarker: #004578 | black: #000000 | +| themeDark: #005a9e | neutralDark: #212121 | +| themeDarkAlt: #106ebe | neutralPrimary: #333 | +| themePrimary: #0078d7 | neutralPrimaryAlt: #3c3c3c | +| | neutralSecondary: #666666 | +| | neutralTertiary: #a6a6a6 | +| themeSecondary: #2b88d8 | neutralTertiaryAlt: #c8c8c8 | +| themeTertiary: #71afe5 | neutralLight: #eaeaea | +| themeLight: #c7e0f4 | neutralLighter: #f4f4f4 | +| themeLighter: #deecf9 | neutralLighterAlt: #f8f8f8 | +| themeLighterAlt: #eff6fc | white: #fff | The following code shows how to define a dictionary in PowerShell for the Blue theme's color palette. ```powershell {  -    themePrimary: '#0078d7',  -    themeLighterAlt: '#eff6fc',  -    themeLighter: '#deecf9',  -    themeLight: '#c7e0f4',  -    themeTertiary: '#71afe5',  -    themeSecondary: '#2b88d8',  -    themeDarkAlt: '#106ebe',  -    themeDark: '#005a9e',  -    themeDarker: '#004578',  -    neutralLighterAlt: '#f8f8f8',  -    neutralLighter: '#f4f4f4',  -    neutralLight: '#eaeaea',  -    neutralQuaternaryAlt: '#dadada',  -    neutralQuaternary: '#d0d0d0',  -    neutralTertiaryAlt: '#c8c8c8',  -    neutralTertiary: '#a6a6a6',  -    neutralSecondaryAlt: '#767676',  -    neutralSecondary: '#666666',  -    neutralPrimary: '#333',  -    neutralPrimaryAlt: '#3c3c3c',  -    neutralDark: '#212121',  -    black: '#000000',  -    white: '#fff',  -    primaryBackground: '#fff',  -    primaryText: '#333', - accent: '#8764b8' + themePrimary: '#0078d7',  + themeLighterAlt: '#eff6fc',  + themeLighter: '#deecf9',  + themeLight: '#c7e0f4',  + themeTertiary: '#71afe5',  + themeSecondary: '#2b88d8',  + themeDarkAlt: '#106ebe',  + themeDark: '#005a9e',  + themeDarker: '#004578',  + neutralLighterAlt: '#f8f8f8',  + neutralLighter: '#f4f4f4',  + neutralLight: '#eaeaea',  + neutralQuaternaryAlt: '#dadada',  + neutralQuaternary: '#d0d0d0',  + neutralTertiaryAlt: '#c8c8c8',  + neutralTertiary: '#a6a6a6',  + neutralSecondaryAlt: '#767676',  + neutralSecondary: '#666666',  + neutralPrimary: '#333',  + neutralPrimaryAlt: '#3c3c3c',  + neutralDark: '#212121',  + black: '#000000',  + white: '#fff',  + primaryBackground: '#fff',  + primaryText: '#333', + accent: '#8764b8' } ``` @@ -513,81 +371,50 @@ The following code shows how to define a dictionary in PowerShell for the Blue t The following table shows the color palette used by the Purple theme. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
themeDarker: #27268ablack: #000000
themeDark: #3230b0neutralDark: #212121
themeDarkAlt: #5250cfneutralPrimary: #333
themePrimary: #6b69d6neutralPrimaryAlt: #3c3c3c
neutralSecondary: #666666
neutralTertiary: #a6a6a6
themeSecondary: #7a78daneutralTertiaryAlt: #c8c8c8
themeTertiary: #c1c0eeneutralLight: #eaeaea
themeLight: #e1e1f7neutralLighter: #f4f4f4
themeLighter: #f0f0fbneutralLighterAlt: #f8f8f8
themeLighterAlt: #f8f7fdwhite: #fff
+| Theme colors | Neutral colors | +| ------------------------ | --------------------------- | +| themeDarker: #27268a | black: #000000 | +| themeDark: #3230b0 | neutralDark: #212121 | +| themeDarkAlt: #5250cf | neutralPrimary: #333 | +| themePrimary: #6b69d6 | neutralPrimaryAlt: #3c3c3c | +| | neutralSecondary: #666666 | +| | neutralTertiary: #a6a6a6 | +| themeSecondary: #7a78da | neutralTertiaryAlt: #c8c8c8 | +| themeTertiary: #c1c0ee | neutralLight: #eaeaea | +| themeLight: #e1e1f7 | neutralLighter: #f4f4f4 | +| themeLighter: #f0f0fb | neutralLighterAlt: #f8f8f8 | +| themeLighterAlt: #f8f7fd | white: #fff | The following code shows how to define a dictionary in PowerShell for the Purple theme's color palette. ```powershell {  -    themePrimary: '#6b69d6',  -    themeLighterAlt: '#f8f7fd',  -    themeLighter: '#f0f0fb',  -    themeLight: '#e1e1f7',  -    themeTertiary: '#c1c0ee',  -    themeSecondary: '#7a78da',  -    themeDarkAlt: '#5250cf',  -    themeDark: '#3230b0',  -    themeDarker: '#27268a',  -    neutralLighterAlt: '#f8f8f8',  -    neutralLighter: '#f4f4f4',  -    neutralLight: '#eaeaea',  -    neutralQuaternaryAlt: '#dadada',  -    neutralQuaternary: '#d0d0d0',  -    neutralTertiaryAlt: '#c8c8c8',  -    neutralTertiary: '#a6a6a6',  -    neutralSecondaryAlt: '#767676',  -    neutralSecondary: '#666666',  -    neutralPrimary: '#333',  -    neutralPrimaryAlt: '#3c3c3c',  -    neutralDark: '#212121',  -    black: '#000000',  -    white: '#fff',  -    primaryBackground: '#fff',  -    primaryText: '#333', - accent: '#038387' + themePrimary: '#6b69d6',  + themeLighterAlt: '#f8f7fd',  + themeLighter: '#f0f0fb',  + themeLight: '#e1e1f7',  + themeTertiary: '#c1c0ee',  + themeSecondary: '#7a78da',  + themeDarkAlt: '#5250cf',  + themeDark: '#3230b0',  + themeDarker: '#27268a',  + neutralLighterAlt: '#f8f8f8',  + neutralLighter: '#f4f4f4',  + neutralLight: '#eaeaea',  + neutralQuaternaryAlt: '#dadada',  + neutralQuaternary: '#d0d0d0',  + neutralTertiaryAlt: '#c8c8c8',  + neutralTertiary: '#a6a6a6',  + neutralSecondaryAlt: '#767676',  + neutralSecondary: '#666666',  + neutralPrimary: '#333',  + neutralPrimaryAlt: '#3c3c3c',  + neutralDark: '#212121',  + black: '#000000',  + white: '#fff',  + primaryBackground: '#fff',  + primaryText: '#333', + accent: '#038387' } ``` @@ -595,164 +422,154 @@ The following code shows how to define a dictionary in PowerShell for the Purple The following table shows the color palette used by the Gray theme. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
themeDarker: #323130black: #000000
themeDark: #403e3dneutralDark: #212121
themeDarkAlt: #53504eneutralPrimary: #333
themePrimary: #5d5a58neutralPrimaryAlt: #3c3c3c
neutralSecondary: #666666
neutralTertiary: #a6a6a6
themeSecondary: #6d6a67neutralTertiaryAlt: #c8c8c8
themeTertiary: #bbb9b8neutralLight: #eaeaea
themeLight: #dfdeddneutralLighter: #f4f4f4
themeLighter: #efeeeeneutralLighterAlt: #f8f8f8
themeLighterAlt: #f7f7f7white: #fff
+| Theme colors | Neutral colors | +| ------------------------ | --------------------------- | +| themeDarker: #323130 | black: #000000 | +| themeDark: #403e3d | neutralDark: #212121 | +| themeDarkAlt: #53504e | neutralPrimary: #333 | +| themePrimary: #5d5a58 | neutralPrimaryAlt: #3c3c3c | +| | neutralSecondary: #666666 | +| | neutralTertiary: #a6a6a6 | +| themeSecondary: #6d6a67 | neutralTertiaryAlt: #c8c8c8 | +| themeTertiary: #bbb9b8 | neutralLight: #eaeaea | +| themeLight: #dfdedd | neutralLighter: #f4f4f4 | +| themeLighter: #efeeee | neutralLighterAlt: #f8f8f8 | +| themeLighterAlt: #f7f7f7 | white: #fff | The following code shows how to define a dictionary in PowerShell for the Gray theme's color palette. ```powershell {  -    themePrimary: '#5d5a58',  -    themeLighterAlt: '#f7f7f7',  -    themeLighter: '#efeeee',  -    themeLight: '#dfdedd',  -    themeTertiary: '#bbb9b8',  -    themeSecondary: '#6d6a67',  -    themeDarkAlt: '#53504e',  -    themeDark: '#403e3d',  -    themeDarker: '#323130',  -    neutralLighterAlt: '#f8f8f8',  -    neutralLighter: '#f4f4f4',  -    neutralLight: '#eaeaea',  -    neutralQuaternaryAlt: '#dadada',  -    neutralQuaternary: '#d0d0d0',  -    neutralTertiaryAlt: '#c8c8c8',  -    neutralTertiary: '#a6a6a6',  -    neutralSecondaryAlt: '#767676',  -    neutralSecondary: '#666666',  -    neutralPrimary: '#333',  -    neutralPrimaryAlt: '#3c3c3c',  -    neutralDark: '#212121',  -    black: '#000000',  -    white: '#fff',  -    primaryBackground: '#fff',  -    primaryText: '#333', - accent: '#0078d4' + themePrimary: '#5d5a58',  + themeLighterAlt: '#f7f7f7',  + themeLighter: '#efeeee',  + themeLight: '#dfdedd',  + themeTertiary: '#bbb9b8',  + themeSecondary: '#6d6a67',  + themeDarkAlt: '#53504e',  + themeDark: '#403e3d',  + themeDarker: '#323130',  + neutralLighterAlt: '#f8f8f8',  + neutralLighter: '#f4f4f4',  + neutralLight: '#eaeaea',  + neutralQuaternaryAlt: '#dadada',  + neutralQuaternary: '#d0d0d0',  + neutralTertiaryAlt: '#c8c8c8',  + neutralTertiary: '#a6a6a6',  + neutralSecondaryAlt: '#767676',  + neutralSecondary: '#666666',  + neutralPrimary: '#333',  + neutralPrimaryAlt: '#3c3c3c',  + neutralDark: '#212121',  + black: '#000000',  + white: '#fff',  + primaryBackground: '#fff',  + primaryText: '#333', + accent: '#0078d4' +} +``` + +## Periwinkle theme + +The following table shows the color palette used by the Periwinkle theme. + +| Theme colors | Neutral colors | +| ------------------------ | --------------------------- | +| themeDarker: #383966 | black: #000000 | +| themeDark: #3D3E78 | neutralDark: #201f1e | +| themeDarkAlt: #444791 | neutralPrimary: #323130 | +| themePrimary: #5B5FC7 | neutralPrimaryAlt: #3b3a39 | +| | neutralSecondary: #605e5c | +| | neutralTertiary: #a19f9d | +| themeSecondary: #7579EB | neutralTertiaryAlt: #c8c6c4 | +| themeTertiary: #7F85F5 | neutralLight: #edebe9 | +| themeLight: #AAB1FA | neutralLighter: #f3f2f1 | +| themeLighter: #B6BCFA | neutralLighterAlt: #faf9f8 | +| themeLighterAlt: #C5CBFA | white: #fff | + +The following code shows how to define a dictionary in PowerShell for the Periwinkle theme's color palette. + +```powershell +{  + themeDarker: '#383966',  + themeDark: '#3D3E78',  + themeDarkAlt: '#444791',  + themePrimary: '#5B5FC7',  + themeSecondary: '#7579EB',  + themeTertiary: '#7F85F5',  + themeLight: '#AAB1FA',  + themeLighter: '#B6BCFA',  + themeLighterAlt: '#C5CBFA',  + black: '#000000',  + neutralDark: '#201f1e',  + neutralPrimary: '#323130',  + neutralPrimaryAlt: '#3b3a39',  + neutralSecondary: '#605e5c',  + neutralTertiary: '#a19f9d',  + neutralTertiaryAlt: '#c8c6c4',  + neutralLight: '#edebe9',  + neutralLighter: '#f3f2f1',  + neutralLighterAlt: '#faf9f8',  + white: '#fff',  + neutralQuaternaryAlt: '#dadada',  + neutralQuaternary: '#d0d0d0',  + neutralSecondaryAlt: '#767676',  + primaryBackground: '#fff',  + primaryText: '#333', + accent: '#5B5FC7' } ``` + ## Dark Yellow theme The following table shows the color palette used by the Dark Yellow theme. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
themeDarker: #fff171black: #f8f8f8
themeDark: #ffed4bneutralDark: #f4f4f4
themeDarkAlt: #ffe817neutralPrimary: #ffffff
themePrimary: #fce100neutralPrimaryAlt: #eaeaea
neutralSecondary: #dadada
neutralTertiary: #c8c8c8
themeSecondary: #e3cc00neutralTertiaryAlt: #6d6d6d
themeTertiary: #6a5f00neutralLight: #3f3f3f
themeLight: #322d00neutralLighter: #313131
themeLighter: #191700neutralLighterAlt: #282828
themeLighterAlt: #0d0b00white: #1f1f1f
+| Theme colors | Neutral colors | +| ------------------------ | --------------------------- | +| themeDarker: #fff171 | black: #f8f8f8 | +| themeDark: #ffed4b | neutralDark: #f4f4f4 | +| themeDarkAlt: #ffe817 | neutralPrimary: #ffffff | +| themePrimary: #fce100 | neutralPrimaryAlt: #eaeaea | +| | neutralSecondary: #dadada | +| | neutralTertiary: #c8c8c8 | +| themeSecondary: #e3cc00 | neutralTertiaryAlt: #6d6d6d | +| themeTertiary: #6a5f00 | neutralLight: #3f3f3f | +| themeLight: #322d00 | neutralLighter: #313131 | +| themeLighter: #191700 | neutralLighterAlt: #282828 | +| themeLighterAlt: #0d0b00 | white: #1f1f1f | The following code shows how to define a dictionary in PowerShell for the Dark Yellow theme's color palette. ```powershell {  -    themePrimary: '#fce100',  -    themeLighterAlt: '#0d0b00',  -    themeLighter: '#191700',  -    themeLight: '#322d00',  -    themeTertiary: '#6a5f00',  -    themeSecondary: '#e3cc00',  -    themeDarkAlt: '#ffe817',  -    themeDark: '#ffed4b',  -    themeDarker: '#fff171',  -    neutralLighterAlt: '#282828',  -    neutralLighter: '#313131',  -    neutralLight: '#3f3f3f',  -    neutralQuaternaryAlt: '#484848',  -    neutralQuaternary: '#4f4f4f',  -    neutralTertiaryAlt: '#6d6d6d',  -    neutralTertiary: '#c8c8c8',  -    neutralSecondaryAlt: '#d0d0d0',  -    neutralSecondary: '#dadada',  -    neutralPrimaryAlt: '#eaeaea',  -    neutralPrimary: '#ffffff',  -    neutralDark: '#f4f4f4',  -    black: '#f8f8f8',  -    white: '#1f1f1f',  -    primaryBackground: '#1f1f1f',  -    primaryText: '#ffffff',  -    error: '#ff5f5f', - accent: '#ffc83d' + themePrimary: '#fce100',  + themeLighterAlt: '#0d0b00',  + themeLighter: '#191700',  + themeLight: '#322d00',  + themeTertiary: '#6a5f00',  + themeSecondary: '#e3cc00',  + themeDarkAlt: '#ffe817',  + themeDark: '#ffed4b',  + themeDarker: '#fff171',  + neutralLighterAlt: '#282828',  + neutralLighter: '#313131',  + neutralLight: '#3f3f3f',  + neutralQuaternaryAlt: '#484848',  + neutralQuaternary: '#4f4f4f',  + neutralTertiaryAlt: '#6d6d6d',  + neutralTertiary: '#c8c8c8',  + neutralSecondaryAlt: '#d0d0d0',  + neutralSecondary: '#dadada',  + neutralPrimaryAlt: '#eaeaea',  + neutralPrimary: '#ffffff',  + neutralDark: '#f4f4f4',  + black: '#f8f8f8',  + white: '#1f1f1f',  + primaryBackground: '#1f1f1f',  + primaryText: '#ffffff',  + error: '#ff5f5f', + accent: '#ffc83d' } ``` @@ -760,82 +577,51 @@ The following code shows how to define a dictionary in PowerShell for the Dark Y The following table shows the color palette used by the Dark Blue theme. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
themeDarker: #6cdfffblack: #f8f8f8
themeDark: #44d6ffneutralDark: #f4f4f4
themeDarkAlt: #0ecbffneutralPrimary: #ffffff
themePrimary: #00bcf2neutralPrimaryAlt: #eaeaea
neutralSecondary: #dadada
neutralTertiary: #c8c8c8
themeSecondary: #00abdaneutralTertiaryAlt: #646e8a
themeTertiary: #005066neutralLight: #404759
themeLight: #002630neutralLighter: #353a49
themeLighter: #001318neutralLighterAlt: #2e3340
themeLighterAlt: #00090cwhite: #262a35
+| Theme colors | Neutral colors | +| ------------------------ | --------------------------- | +| themeDarker: #6cdfff | black: #f8f8f8 | +| themeDark: #44d6ff | neutralDark: #f4f4f4 | +| themeDarkAlt: #0ecbff | neutralPrimary: #ffffff | +| themePrimary: #00bcf2 | neutralPrimaryAlt: #eaeaea | +| | neutralSecondary: #dadada | +| | neutralTertiary: #c8c8c8 | +| themeSecondary: #00abda | neutralTertiaryAlt: #646e8a | +| themeTertiary: #005066 | neutralLight: #404759 | +| themeLight: #002630 | neutralLighter: #353a49 | +| themeLighter: #001318 | neutralLighterAlt: #2e3340 | +| themeLighterAlt: #00090c | white: #262a35 | The following code shows how to define a dictionary in PowerShell for the Dark Blue theme's color palette. ```powershell {  -    themePrimary: '#00bcf2',  -    themeLighterAlt: '#00090c',  -    themeLighter: '#001318',  -    themeLight: '#002630',  -    themeTertiary: '#005066',  -    themeSecondary: '#00abda',  -    themeDarkAlt: '#0ecbff',  -    themeDark: '#44d6ff',  -    themeDarker: '#6cdfff',  -    neutralLighterAlt: '#2e3340',  -    neutralLighter: '#353a49',  -    neutralLight: '#404759',  -    neutralQuaternaryAlt: '#474e62',  -    neutralQuaternary: '#4c546a',  -    neutralTertiaryAlt: '#646e8a',  -    neutralTertiary: '#c8c8c8',  -    neutralSecondaryAlt: '#d0d0d0',  -    neutralSecondary: '#dadada',  -    neutralPrimaryAlt: '#eaeaea',  -    neutralPrimary: '#ffffff',  -    neutralDark: '#f4f4f4',  -    black: '#f8f8f8',  -    white: '#262a35',  -    primaryBackground: '#262a35',  -    primaryText: '#ffffff', -    error: '#ff5f5f', - accent: '#3a96dd' + themePrimary: '#00bcf2',  + themeLighterAlt: '#00090c',  + themeLighter: '#001318',  + themeLight: '#002630',  + themeTertiary: '#005066',  + themeSecondary: '#00abda',  + themeDarkAlt: '#0ecbff',  + themeDark: '#44d6ff',  + themeDarker: '#6cdfff',  + neutralLighterAlt: '#2e3340',  + neutralLighter: '#353a49',  + neutralLight: '#404759',  + neutralQuaternaryAlt: '#474e62',  + neutralQuaternary: '#4c546a',  + neutralTertiaryAlt: '#646e8a',  + neutralTertiary: '#c8c8c8',  + neutralSecondaryAlt: '#d0d0d0',  + neutralSecondary: '#dadada',  + neutralPrimaryAlt: '#eaeaea',  + neutralPrimary: '#ffffff',  + neutralDark: '#f4f4f4',  + black: '#f8f8f8',  + white: '#262a35',  + primaryBackground: '#262a35',  + primaryText: '#ffffff', + error: '#ff5f5f', + accent: '#3a96dd' } ``` diff --git a/docs/declarative-customization/site-theming/sharepoint-site-theming-overview.md b/docs/declarative-customization/site-theming/sharepoint-site-theming-overview.md index 3157d2c7c..5762ad676 100644 --- a/docs/declarative-customization/site-theming/sharepoint-site-theming-overview.md +++ b/docs/declarative-customization/site-theming/sharepoint-site-theming-overview.md @@ -1,13 +1,13 @@ --- title: SharePoint site theming description: New options for applying custom styles and colors to sites that make it easier to define and manage themes across site collections. -ms.date: 06/05/2020 -localization_priority: Priority +ms.date: 04/23/2025 +ms.localizationpriority: high --- # SharePoint site theming -SharePoint site owners have new options for applying custom styles and colors to sites that make it easier to define and manage themes across site collections. +SharePoint site owners have new options for applying custom styles and colors to sites that make it easier to define and manage themes across site collections. These new features include: @@ -17,7 +17,7 @@ These new features include: * An updated color palette, with 12 light colors and 6 dark colors, as well as 16 supplementary themes. * Control over which themes are available for use on pages within your sites. For example, you can define custom themes based on your organization's branding or identity, and make those the only available themes within your sites. -These capabilities are available to administrators via [PowerShell cmdlets](sharepoint-site-theming-powershell.md), and to developers via the [SharePoint client-side object model (CSOM)](sharepoint-site-theming-csom.md) or the [SharePoint REST API](sharepoint-site-theming-rest-api.md). For information on applying custom themes to individual site collections see [SharePoint site design and site script overview](https://docs.microsoft.com/sharepoint/dev/declarative-customization/site-design-overview) +These capabilities are available to administrators via [PowerShell cmdlets](sharepoint-site-theming-powershell.md), and to developers via the [SharePoint client-side object model (CSOM)](sharepoint-site-theming-csom.md) or the [SharePoint REST API](sharepoint-site-theming-rest-api.md). For information on applying custom themes to individual site collections see [SharePoint site design and site script overview](../site-design-overview.md). For general information about working with themes to customize the look of your sites, see [Change the look of your SharePoint site](https://support.office.com/article/Change-the-look-of-your-SharePoint-site-06bbadc3-6b04-4a60-9d14-894f6a170818). @@ -32,6 +32,7 @@ The following predefined themes are available by default: * __Purple__ * __Green__ * __Gray__ +* __Periwinkle__ * __Dark Yellow__ (inverted theme) * __Dark Blue__ (inverted theme) @@ -46,7 +47,7 @@ In addition to the default themes, you can select from supplementary themes. The -To select from the available themes for a SharePoint site, choose the __gear icon (⚙️)__ in the top right corner of the screen, and then select __Change the look__. You'll be presented with a list of themes to choose from, which might include default themes and/or custom themes depending on how your site has been configured. +To select from the available themes for a SharePoint site, choose the __gear icon (⚙️)__ in the top right corner of the screen, select __Change the look__, then select __theme__. You'll be presented with a list of themes to choose from, which might include default themes and/or custom themes depending on how your site has been configured. The following image shows how the default themes are presented in the theme picker dialog box. @@ -54,46 +55,47 @@ The following image shows how the default themes are presented in the theme pick When you choose a theme in the list, those color settings are instantly applied to the page so that you can see what the selected theme will look like. -After you've found a theme that you want to use, choose **Apply** to save your selection, or choose **Cancel** to revert to your current theme. +After you've found a theme that you want to use, choose **Save** to save your selection, or choose **Cancel** to revert to your current theme. ## Work with classic themes -You can still use the classic themes by choosing the link to **Classic change the look options** under the modern themes listed under **Change the look**. Because the modern SharePoint UI differs from the classic UI, however, some limitations apply when you use classic themes with modern pages. +You can still use the classic themes by choosing the link to **Classic change the look options** at the bottom of the **Change the look** panel. Because the modern SharePoint UI differs from the classic UI, however, some limitations apply when you use classic themes with modern pages. When you select a classic theme, a modern theme is generated from the settings in the classic theme, including the **isInverted** flag, the background image, and the color settings for **ContentAccent1**, **PageBackground**, and **BackgroundOverlay**. If **isInverted** is set to **True**, neutral colors such as **NeutralDark** and **NeutralLight** will be reversed. For the simplest experience, we recommend that you use modern themes with modern pages. If you need to use classic themes with modern pages, test your site carefully to verify that your content is readable and accessible. -## Troubleshoot custom theme issues +## Troubleshoot custom theme issues The modern site theming experience has been rolled out to classic site templates, too. While the new client-side theming architecture is more performant, if you have customizations on classic sites that aren’t rendering properly after you change the site’s theme, you can opt the site out of the new theming experience by disabling the feature. Please note, this opt-out only applies to classic sites where you have custom theme references that aren't rendering properly. By enabling this site-level opt-out you will disable the modern theming - and also lose the fast theming benefits it provides. To do this, you must use a Windows PowerShell script with a CSOM (client-side object model) wrapper. We recommend using the PnP PowerShell enable feature command: -1. Verify that you meet the following minimum requirements: - * You are at least a site collection owner on the site where you want to disable modern site themes +1. Verify that you meet the following minimum requirements: + + * You are at least a site collection owner on the site where you want to disable modern site themes * You have read about [Execution Policies](https://technet.microsoft.com/library/dd347641.aspx) -2. Download the latest PnP PowerShell from https://github.com/SharePoint/PnP-PowerShell/releases. +1. Download the latest [PnP PowerShell](https://github.com/pnp/powershell). [!INCLUDE [pnp-powershell](../../../includes/snippets/open-source/pnp-powershell.md)] -3. Enter `Connect-PnPOnline -Url -UseWebLogin` (replacing `` with the url of the site you wish to opt out of). - -4. Enter your credentials when prompted. - -5. To opt out of the site, you need to enable a feature: +1. Enter `Connect-PnPOnline -Url -Interactive -ClientId ` (replacing `` with the URL of the site you wish to connect to, and `` with the Client ID of your [registered Entra ID (Azure AD)](https://pnp.github.io/powershell/articles/registerapplication.html) application). +1. Enter your credentials when prompted. +1. To opt out of the site, you need to enable a feature: * Enter `Get-PnPFeature -Scope Site -Identity 5138468E-3D76-4F72-9DE4-E029F1245A7B` - * Verify that nothing is returned from the previous command (this confirms the feature isn’t enabled yet) + * Verify that nothing is returned from the previous command (this confirms the feature isn’t enabled yet) * Enter `Enable-PnPFeature -Scope Site -Identity 5138468E-3D76-4F72-9DE4-E029F1245A7B` * Enter `Get-PnPFeature -Scope Site -Identity 5138468E-3D76-4F72-9DE4-E029F1245A7B` -6. Verify that the following is returned: +1. Verify that the following is returned: - `ClientSideThemingOptOut - 5138468e-3d76-4f72-9de4-e029f1245a7b` + ```powershell + ClientSideThemingOptOut - 5138468e-3d76-4f72-9de4-e029f1245a7b + ``` -For more information about Windows PowerShell, see [PowerShell](https://docs.microsoft.com/powershell/scripting/powershell-scripting?view=powershell-6). +For more information about Windows PowerShell, see [PowerShell](/powershell/scripting/overview). ## See also diff --git a/docs/declarative-customization/site-theming/sharepoint-site-theming-powershell.md b/docs/declarative-customization/site-theming/sharepoint-site-theming-powershell.md index 49f3329aa..37dc811ec 100644 --- a/docs/declarative-customization/site-theming/sharepoint-site-theming-powershell.md +++ b/docs/declarative-customization/site-theming/sharepoint-site-theming-powershell.md @@ -1,13 +1,13 @@ --- title: SharePoint site theming - PowerShell cmdlets description: SharePoint tenant administrators can use PowerShell cmdlets to create, retrieve, and remove site themes. Developers can use the SharePoint REST API to handle theme management tasks. -ms.date: 03/22/2018 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # SharePoint site theming: PowerShell cmdlets -SharePoint tenant administrators can use PowerShell cmdlets to create, retrieve, and remove site themes. +SharePoint tenant administrators can use PowerShell cmdlets to create, retrieve, and remove site themes. Developers can use the SharePoint [REST API](sharepoint-site-theming-rest-api.md) to handle theme management tasks. @@ -18,26 +18,21 @@ For information about how themes are defined and stored, see [JSON schema refere To run the PowerShell cmdlets for theme management, you must do the following: 1. Download and install the [SharePoint Online Management Shell](https://www.microsoft.com/download/details.aspx?id=35588). If you already have a previous version of the shell installed, uninstall it first and then install the latest version. +1. Follow the instructions at [Connect to SharePoint Online PowerShell](https://technet.microsoft.com/library/fp161372.aspx) to connect to your SharePoint tenant. -2. Follow the instructions at [Connect to SharePoint Online PowerShell](https://technet.microsoft.com/library/fp161372.aspx) to connect to your SharePoint tenant. - -To verify your setup, try using the [Get-SPOHideDefaultThemes](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOHideDefaultThemes?view=sharepoint-ps) cmdlet to read the SPOHideDefaultThemes setting. If the cmdlet runs and returns False with no errors, as shown in the following example, you're ready to proceed. +To verify your setup, try using the [Get-SPOHideDefaultThemes](/powershell/module/sharepoint-online/Get-SPOHideDefaultThemes) cmdlet to read the SPOHideDefaultThemes setting. If the cmdlet runs and returns False with no errors, as shown in the following example, you're ready to proceed. ## Site theme cmdlets The following cmdlets are available for managing site themes from PowerShell: -* [Add-SPOTheme](https://docs.microsoft.com/powershell/module/sharepoint-online/Add-SPOTheme?view=sharepoint-ps) – Creates a new custom theme, or overwrites an existing theme to modify its settings. -* [Get-SPOTheme](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOTheme?view=sharepoint-ps) – Retrieves settings for an existing theme. -* [Remove-SPOTheme](https://docs.microsoft.com/powershell/module/sharepoint-online/Remove-SPOTheme?view=sharepoint-ps) – Removes a theme from the theme gallery. -* [Set-SPOHideDefaultThemes](https://docs.microsoft.com/powershell/module/sharepoint-online/Set-SPOHideDefaultThemes?view=sharepoint-ps) – Specifies whether the default themes should be available. -* [Get-SPOHideDefaultThemes](https://docs.microsoft.com/powershell/module/sharepoint-online/Get-SPOHideDefaultThemes?view=sharepoint-ps) – Queries the current SPOHideDefaultThemes setting. - +* [Add-SPOTheme](/powershell/module/sharepoint-online/Add-SPOTheme) – Creates a new custom theme, or overwrites an existing theme to modify its settings. +* [Get-SPOTheme](/powershell/module/sharepoint-online/Get-SPOTheme) – Retrieves settings for an existing theme. +* [Remove-SPOTheme](/powershell/module/sharepoint-online/Remove-SPOTheme) – Removes a theme from the theme gallery. +* [Set-SPOHideDefaultThemes](/powershell/module/sharepoint-online/Set-SPOHideDefaultThemes) – Specifies whether the default themes should be available. +* [Get-SPOHideDefaultThemes](/powershell/module/sharepoint-online/Get-SPOHideDefaultThemes) – Queries the current SPOHideDefaultThemes setting. ## See also * [SharePoint site theming overview](sharepoint-site-theming-overview.md) * [SharePoint site theming: CSOM](sharepoint-site-theming-csom.md) - - - diff --git a/docs/declarative-customization/site-theming/sharepoint-site-theming-rest-api.md b/docs/declarative-customization/site-theming/sharepoint-site-theming-rest-api.md index 45260171c..de3d44434 100644 --- a/docs/declarative-customization/site-theming/sharepoint-site-theming-rest-api.md +++ b/docs/declarative-customization/site-theming/sharepoint-site-theming-rest-api.md @@ -1,8 +1,8 @@ --- title: SharePoint site theming - REST API description: Use the the SharePoint REST interface to perform basic create, read, update, and delete (CRUD) operations on site themes. -ms.date: 10/29/2019 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # SharePoint site theming: REST API @@ -15,7 +15,7 @@ The SharePoint Online (and SharePoint 2016 and later on-premises) REST service s Before you get started, make sure that you're familiar with the following: -- [Get to know the SharePoint REST service](../../sp-add-ins/get-to-know-the-sharepoint-rest-service.md) +- [Get to know the SharePoint REST service](../../sp-add-ins/get-to-know-the-sharepoint-rest-service.md) - [Complete basic operations using SharePoint REST endpoints](../../sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints.md) ## REST commands for site themes @@ -119,7 +119,7 @@ function RestRequest(url,params) { req.send(params ? JSON.stringify(params) : void 0); } - + RestRequest("/_api/thememanager/DeleteTenantTheme", { name:"Sounders Rave Green" }); ``` @@ -147,7 +147,7 @@ function RestRequest(url,params) { req.setRequestHeader("ODATA-VERSION","4.0"); req.send(params ? JSON.stringify(params) : void 0); } - + RestRequest("/_api/thememanager/GetTenantThemingOptions"); ``` diff --git a/docs/declarative-customization/view-board-formatting.md b/docs/declarative-customization/view-board-formatting.md new file mode 100644 index 000000000..16c6f2643 --- /dev/null +++ b/docs/declarative-customization/view-board-formatting.md @@ -0,0 +1,31 @@ +--- +title: Format board view to customize SharePoint +description: Customize how board views in SharePoint lists and libraries are displayed by constructing a JSON object that describes the elements and the styles to be applied to those elements. +ms.date: 06/28/2022 +ms.localizationpriority: high +--- + +# Board view customizations + +## Build custom cards + +You can use Board **`formatter`** to define a totally custom layout of field values inside a card using the same syntax used in [Column Formatting](column-formatting.md). + +## Detailed syntax reference + +### hideSelection + +Optional element. Specifies whether the ability to select cards in the view is disabled or not. `false` is the default behavior inside a board view (meaning selection is visible and enabled). `true` means that users will not be able to select list items. + +### formatter + +JSON object that defines the layout of cards. The schema of this JSON object is identical to the schema of a column format (and that of rowFormatter). For details on this schema and its capabilities, see the [Formatting syntax reference](./formatting-syntax-reference.md). + +### commandBarProps + +Groups the command bar customization options. For details on `commandBarProps`, see [Command bar customization syntax reference](./view-commandbar-formatting.md) + +## See also +- [Command bar customization syntax reference](./view-commandbar-formatting.md) +- [Advanced formatting concepts](./formatting-advanced.md) +- [Formatting syntax reference](./formatting-syntax-reference.md) diff --git a/docs/declarative-customization/view-calendar-formatting.md b/docs/declarative-customization/view-calendar-formatting.md new file mode 100644 index 000000000..a09948812 --- /dev/null +++ b/docs/declarative-customization/view-calendar-formatting.md @@ -0,0 +1,54 @@ +--- +title: Format calendar view to customize SharePoint +description: Customize calendar views in SharePoint lists and libraries +ms.date: 02/09/2023 +ms.localizationpriority: high +--- + +# Calendar view customizations + +## Detailed syntax reference + +### commandBarProps + +Groups the command bar customization options. For details on `commandBarProps`, see [Command bar customization syntax reference](./view-commandbar-formatting.md) + +## See also +- [Command bar customization syntax reference](./view-commandbar-formatting.md) + +> ![IMPORTANT] +> **Pre-requisite : List setup before creating a calendar view and applying a JSON formatting** +> +> - Before creating a new calendar view, a list should include all the required columns to be used in any JSON formatting. +> - After creating a calendar view, if more columns are required, go to the [List Settings page](https://support.microsoft.com/office/edit-list-settings-4d35793b-246e-42a3-990c-563a83795b7f) to create and add them to a calendar view. + +### Conditional view formatting based on a specific column + +The following image shows an example of conditional formatting applied to a calendar view, based on a single choice column named **PROJECT**: + +![SharePoint list calendar formatting](../images/calendar-view-formatting.png) + +> ![NOTE] +> Before creating a new calendar view, make sure the PROJECT column is already existing to apply the JSON code illustrated below. Alternatively, go the [List Settings page](https://support.microsoft.com/office/edit-list-settings-4d35793b-246e-42a3-990c-563a83795b7f) to create and add the single choice PROJECT column to a calendar view. + +In this example, **PROJECT** column has the following options: + +- Project A +- Project B +- Project C +- Project D +- Project E + +The JSON code below makes use of SharePoint Online Modern UI classes to apply colors, borders and a hover effect through the [Excel-style expression syntax](./formatting-syntax-reference.md#excel-style-expressions): + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/calendar-formatting.schema.json", + "additionalEventClass": "=if([$PROJECT] =='Project A' && @isSelected == false, 'sp-css-backgroundColor-successBackground50 sp-css-color-BlackText sp-css-borderColor-GreenText ms-bgColor-sharedGreenCyan10--hover ms-fontColor-white--hover', if([$PROJECT] =='Project A' && @isSelected == true, 'ms-bgColor-green sp-css-color-WhiteText', if([$PROJECT] =='Project B' && @isSelected == false, 'sp-css-backgroundColor-BgPeach sp-css-color-BlackText sp-css-borderColor-RedText ms-bgColor-sharedRed10--hover ms-fontColor-white--hover', if([$PROJECT] =='Project B' && @isSelected == true, 'sp-css-backgroundColor-redDark sp-css-color-WhiteText', if([$PROJECT] =='Project C' && @isSelected == false, 'sp-css-backgroundColor-BgGold sp-css-color-BlackText sp-css-borderColor-BrownText ms-bgColor-yellow--hover ms-fontColor-white--hover', if([$PROJECT] =='Project C' && @isSelected == true, 'ms-bgColor-sharedOrange10 sp-css-color-BlackText', if([$PROJECT] =='Project D' && @isSelected == false, 'ms-bgColor-communicationTint20 sp-css-color-BlackText sp-css-borderColor-BlueText ms-bgColor-sharedCyanBlue10--hover ms-fontColor-white--hover', if([$PROJECT] =='Project D' && @isSelected == true, 'sp-css-backgroundColor-BlueText sp-css-color-WhiteText', if([$PROJECT] =='Project E' && @isSelected == false, 'sp-css-backgroundColor-BgLilac sp-css-color-BlackText sp-css-borderColor-DarkPurpleText ms-bgColor-sharedBlueMagenta20--hover ms-fontColor-white--hover', if([$PROJECT] =='Project E' && @isSelected == true, 'sp-css-backgroundColor-BgPurple sp-css-color-WhiteText', if(@isSelected == false, 'sp-css-backgroundColor-neutralBackground20 sp-css-color-BlackText ms-bgColor-neutralTertiaryAlt--hover ms-fontColor-black--hover', 'sp-css-backgroundColor-neutralTertiary sp-css-color-WhiteText')))))))))))" +} +``` + +The gif image below shows the final result: + +![SharePoint list calendar formatting result](../images/calendar-view-formatting-result.gif) + diff --git a/docs/declarative-customization/view-commandbar-formatting.md b/docs/declarative-customization/view-commandbar-formatting.md new file mode 100644 index 000000000..f7f56e8e3 --- /dev/null +++ b/docs/declarative-customization/view-commandbar-formatting.md @@ -0,0 +1,248 @@ +--- +title: Command bar customization syntax reference +description: Command bar customization syntax reference +ms.date: 05/21/2025 +ms.localizationpriority: high +--- + +# Command bar customization syntax reference + +Command bar customization helps personalize a list to suit specific requirements. The JSON-based feature allows basic changes to the command bar, including modification of icon and/or text, hiding existing options, or repositioning commands. + +## commandBarProps + +Properties for Command bar customization. Valid in all types of layouts. + +## commands + +An array of JSON objects is used to specify the commands for customization. + +## key + +Mandatory property to uniquely identify a command in the Command bar. Valid keys include: + +```javascript +'new' +'newFolder' +'newWordDocument' +'newExcelWorkbook' +'newPowerPointPresentation' +'newOneNoteNotebook' +'newFormsForExcel' +'newVisioDrawing' +'upload' +'uploadFile' +'uploadFolder' +'open' +'share' +'copyLink' +'download' +'rename' +'copyTo' +'moveTo' +'delete' +'edit' +'comment' +'editNewMenu' +'powerBI' +'powerBIVisualizeList' +'automate' +'automateCreateRule' +'automateManageRules' +'powerAutomate' +'powerAutomateCreateFlow' +'powerAutomateSeeFlows' +'powerAutomateConfigureFlows' +'aiBuilderCreate' +'aiBuilderGoto' +'aiBuilder' +'alertMe' +'newLink' +'integrate' +'manageAlert' +'powerApps' +'powerAppsCreateApp' +'powerAppsSeeAllApps' +'powerAppsCustomizeForms' +'viewDocumentUnderstandingModels' +'versionHistory' +'openInImmersiveReader' +'classifyAndExtract' +'checkOut' +'checkIn' +'undoCheckOut' +'properties' +'pinItem' +'exportExcel' +'exportCSV' +'export' +'editInGridView' +'exitGridView' +'sync' +'uploadTemplate' +'addTemplate' +'openInOfficeOnline' +'openInOfficeClient' +'addShortcut' +'pinToQuickAccess' +'unpinFromQuickAccess' +'manageForms' +'favoriteCommand' +'createCopilot' +``` + +## ⚠️ Recent updates to `commandBarCustomization` Keys + +> Some keys in the commandBarCustomization schema have been updated. To ensure your custom formatter functions correctly, please update your existing JSON to reflect these new keys. +> +> | Original Key | New Key | +> |--------------|-------------| +> | `new` | `newComposite` (Document Library)| +> | `upload` | `UploadCommand` | +> | `sync` | `syncCommand` | +> | `addShortcut`| `addShortcutToOneDriveCommand` | +> | `pinToQuickAccess` | `PinToQuickAccessCommand` | +> | `pinItem` | `pinItemCommand` | +> | `properties` | `propertiesCommand` | +> | `versionHistory` | `versionHistoryCommand` (currently not working) | +> +> Additionally, the following new command keys are now available: +> > +> - `stasherContextMenuCommand` (Add shortcut) +> - `stasherCommand.myFiles` (Add shortcut --> my Files) +> - `stasherCommand.otherLocations` (Add shortcut --> Other locations) +> - `PublishCommand` +> - `complianceDetails` (right click context menu --> More --> Compliance details) +> - `more` (right click context menu --> More) +> - `previewFileCommand` (right click context menu --> Preview) +> +> Please note that the JSON schema at https://developer.microsoft.com/json-schemas/sp/v2/command-bar-formatting.schema.json has not yet been updated to reflect these new command keys. + +> [!IMPORTANT] +> Command bar customizations also affect the item context menu (right-click menu). If a command is hidden in the command bar, it will also be hidden in the context menu. + +## hide + +An optional property that specifies the condition to hide a particular command. The value of this property can either be a boolean, string or an Expression object. `false` is the default behavior (meaning the command is visible). `true` means that the command will be hidden. + +## text + +An optional property that specifies the text to be displayed as the name of the command. The value of this property can either be a string or an Expression object. If the value is not provided, then the default name of the command will be shown. + +## title + +An optional property that specifies the tooltip text to be displayed in the command. The value of this property can either be a string or an Expression object. If the value is not provided, then the default tooltip of the command will be shown. + +## iconName + +An optional property that specifies the [Fluent UI](https://developer.microsoft.com/fluentui#/) icon to be displayed in the command. The value of this property can either be a string or an Expression object. If the value is not provided, then the default icon of the command will be shown. + +## primary + +An optional property that specifies the condition to apply primary button styling to a command. The value of this property can either be a boolean, string or an Expression object. `false` is the default behavior (meaning the default style will be applied). `true` means the primary button styling will be applied to the command only if the command is placed at the 0th position in the command bar. + +The following example shows a sample Command bar formatting JSON to do the following: + +- Hide the 'New' command. +- Update the text and icon of 'Edit in grid view' command and add primary button styling to it. +- Remove the icon from 'Share' command and update the tooltip text of it. + +```JSON +{ + "commandBarProps" : { + "commands": [ + { + "key": "new", + "hide": true + }, + { + "key": "editInGridView", + "text": "Quick edit", + "iconName": "EditTable", + "primary": true + }, + { + "key": "share", + "iconName": "", + "title": "Share this List" + } + ] + } +} +``` + +## position + +An optional property that specifies the position where the command will be placed in the command bar. The value of this property can either be a number, a string, or an Expression object. If the value is not provided then the command will be placed in it's default position. This property follows zero-based indexing. + +## sectionType + +An optional property that specifies the section where the customized command will be placed in the command bar. The following strings are valid values for this property: + +- Primary +- Overflow + +The following example shows a sample Command bar formatting JSON to do the following: + +- Puts the 'New' command at the third position in the primary section of the Command bar. +- Puts the 'Share' command in the second position in the overflow menu of the Command bar. +- Puts the 'Alert me' command at the fourth position in the primary section of the Command bar. + +```JSON +{ + "commandBarProps" : { + "commands": [ + { + "key": "new", + "position": 2 + }, + { + "key": "share", + "position": 1, + "sectionType": "Overflow" + }, + { + "key": "alertMe", + "position": 3, + "sectionType": "Primary" + } + ] + } +} +``` + +## selectionModes + +An optional property that specifies the selection modes in which the command customization will be applied. If the value is not provided, then the customization will be applied in all the selection modes in which the command is available. The value of this property can be an array of strings where the following strings are allowed: + +- NoSelection +- SingleSelection +- MultiSelection + +The following example shows a sample Command bar formatting JSON to do the following: + +- Update the text of 'Share' command if the selected item has 'NumberField' column value 3 +- Update the text of 'Delete' command only if multiple items are selected. + +```JSON +{ + "commandBarProps": { + "commands": [ + { + "key": "share", + "selectionModes": [ + "SingleSelection" + ], + "text": "=if([$NumberField] == 3, 'Share item 3', 'Share')" + }, + { + "key": "delete", + "selectionModes": [ + "MultiSelection" + ], + "text": "Delete multiple items" + } + ] + } +} +``` diff --git a/docs/declarative-customization/view-formatting.md b/docs/declarative-customization/view-formatting.md index 5432bae90..24b6ff6fe 100644 --- a/docs/declarative-customization/view-formatting.md +++ b/docs/declarative-customization/view-formatting.md @@ -1,8 +1,8 @@ --- title: Use view formatting to customize SharePoint description: Customize how views in SharePoint lists and libraries are displayed by constructing a JSON object that describes the elements that are displayed in a list view, and the styles to be applied to those elements. -ms.date: 05/07/2021 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # Use view formatting to customize SharePoint @@ -17,766 +17,21 @@ You can use view formatting to customize how items in SharePoint lists and libra ## Get started with view formatting -To open the view formatting pane, open the view dropdown and choose **Format current view**. View dropdown menu +To open the view formatting pane, open the view dropdown and choose **Format current view**. + +![View dropdown menu](../images/view-dropdown-menu.png) The pane will look like the following depending on the current layout: -List layout formatting pane Gallery layout formatting pane +![List layout formatting pane](../images/sp-viewformatting-panel-listlayout.png) ![Gallery layout formatting pane](../images/sp-viewformatting-panel-tileslayout.png) > [!NOTE] -> We have simplified the View formatting pane experience to separate out the List and Gallery layout formatting JSON. With this change, you do not need to add `tileProps` prop anymore. +> We have simplified the View formatting pane experience to separate out layout specific formatting JSON. With this change, you do not need to add layout specific props like `tileProps` anymore. -To format rows in 'List' or 'Compact List' layout, select 'List' in 'Choose layout' dropdown in the formatting pane and use the `rowFormatter` or `additionalRowClass` properties. To format cards in 'Gallery' layout, select 'Gallery' in 'Choose layout' dropdown in the formatting pane and use the `formatter` property. +To format rows in 'List' or 'Compact List' layout, select 'List' in 'Choose layout' dropdown in the formatting pane and use the `rowFormatter` or `additionalRowClass` properties. To format cards in 'Gallery' layout, select 'Gallery' in 'Choose layout' dropdown in the formatting pane and use the `formatter` property. To format cards in 'Board' view just use the `formatter` property. The easiest way to use view formatting is to start from an example and edit it to apply to your specific view. The following sections contain examples that you can copy, paste, and customize for your specific needs. There are also several samples available in the [SharePoint/sp-dev-list-formatting repository](https://github.com/SharePoint/sp-dev-list-formatting). -## List layout customizations - -### Apply conditional classes on rows - -You can use **`additionalRowClass`** to apply one or more classes to the entire list row depending on the value of one or more fields in the row. These examples leave the content and structure of list rows intact. - -For a list of recommended classes to use inside view formats, please see the [Style Guidelines section](https://docs.microsoft.com/sharepoint/dev/declarative-customization/column-formatting#style-guidelines) in the [Column Formatting reference document](https://docs.microsoft.com/sharepoint/dev/declarative-customization/column-formatting). - -> [!TIP] -> Using the `additionalRowClass` property to apply classes to list rows will leave the formatting of individual columns in place. This allows you to combine view formats with column formatting for some powerful visualizations. - -#### Example: Conditional classes based on a date field - -The following image shows a list layout with a class applied based on the value of a date column: - -![SharePoint list with view formatted with conditional formatting](../images/listformatting-additionalrowclass.png) - -This example applies the class `sp-field-severity--severeWarning` to a list row when the item's DueDate is before the current date/time: - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json", - "additionalRowClass": "=if([$DueDate] <= @now, 'sp-field-severity--severeWarning', '')" -} -``` - -#### Example: Conditional classes based on the value in a text or choice field - -This example was adopted from a column formatting example, [Conditional formatting based on the value in a text or choice field](https://github.com/SharePoint/sp-dev-list-formatting/tree/master/column-samples/text-conditional-format), with some important differences to apply the concept to list rows. The column formatting example applies both an icon and a class to a column based on the value of `@currentField`. The `additionalRowClass` attribute in view formatting, however, only allows you to specify a class and not an icon. Additionally, since `@currentField` always resolves to the value of the `Title` field when referenced inside a view format, this sample refers to the `Status` field directly (by using the [$Field] syntax inside the additionalRowClass property to determine which class to apply to the row). - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json", - "additionalRowClass": "=if([$Status] == 'Done', 'sp-field-severity--good', if([$Status] == 'In progress', 'sp-field-severity--low' ,if([$Status] == 'In review','sp-field-severity--warning', if([$Status] == 'Has issues','sp-field-severity--blocked', ''))))" -} -``` - -You can find this sample with additional details here: [Conditional formatting based on choice field](https://github.com/SharePoint/sp-dev-list-formatting/tree/master/view-samples/text-conditional-format) - -#### Example: Alternate Row Formatting based on Modulus - -This example applies `% (Mod)` to a list row with alternate coloring the rows: - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json", - "additionalRowClass": "=if(@rowIndex%2==0,'ms-bgColor-themeLight','')" -} -``` - -### Build custom list rows - -You can use **`rowFormatter`** to define a totally custom layout of field values inside a row using the same syntax used in [Column Formatting](column-formatting.md). - -#### Example: Multi-line view style - -The following image shows a list with a custom multi-line view style applied: - -![SharePoint list with multi-line view customization](../images/listformatting-rowformatter.png) - -This example uses the `rowFormatter` element, which totally overrides the rendering of a list row. The `rowFormatter` in this example creates a bounding `
` box for every list row. Inside this bounding box, the `$Title` and `$Feedback` fields are displayed on separate lines. Under those fields, a `button` element is displayed that, when clicked, does the same thing as clicking the list row in an uncustomized view, which is opening the property form for the item. This `button` is displayed conditionally, when the value of the `$Assigned_x0020_To` field (assumed to be a person/group field) matches the current signed-in user: - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/row-formatting.schema.json", - "hideSelection": true, - "hideColumnHeader": true, - "rowFormatter": { - "elmType": "div", - "attributes": { - "class": "sp-row-card" - }, - "children": [ - { - "elmType": "div", - "style": { - "text-align": "left" - }, - "children": [ - { - "elmType": "div", - "attributes": { - "class": "sp-row-title" - }, - "txtContent": "[$Title]" - }, - { - "elmType": "div", - "attributes": { - "class": "sp-row-listPadding" - }, - "txtContent": "[$Feedback]" - }, - { - "elmType": "button", - "customRowAction": { - "action": "defaultClick" - }, - "txtContent": "Give feedback", - "attributes": { - "class": "sp-row-button" - }, - "style": { - "display": { - "operator": "?", - "operands": [ - { - "operator": "==", - "operands": [ - "@me", - "[$Assigned_x0020_To.email]" - ] - }, - "", - "none" - ] - } - } - } - ] - } - ] - } -} -``` - -You can find this sample with additional details here: [Multi-line view rendering](https://github.com/SharePoint/sp-dev-list-formatting/tree/master/view-samples/multi-line-view) - -### Build custom group headers and footers - -You can use `groupProps` to format group headers with flexibility to add grouped column's data, display name and item count. You can also add group aggregates in the group headers or format it directly in the group footers. - -#### Example: Color coded group header - -In the example below we have list with group headers formatted according to column metadata. - -![Employee list grouped by City with formatted group header](../images/employee-formatted-group-header-list-layout.png) - -In this example below, the `headerFormatter` for `groupProps` is used to format the group header and the `@group` is used to access group info. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/row-formatting.schema.json", - "groupProps": { - "headerFormatter": { - "elmType": "div", - "style": { - "flex-wrap": "wrap", - "display": "flex", - "box-sizing": "border-box", - "padding": "4px 8px 5px 8px", - "border-radius": "6px", - "align-items": "center", - "white-space": "nowrap", - "overflow": "hidden", - "margin": "1px 4px 4px 1px" - }, - "attributes": { - "class": "=if(@group.fieldData == 'California', 'sp-css-backgroundColor-blueBackground37', - if(@group.fieldData == 'Chicago', 'sp-css-backgroundColor-successBackground50', - if(@group.fieldData == 'New York', 'sp-css-backgroundColor-warningBackground50', - if(@group.fieldData == 'Seattle', 'sp-css-backgroundColor-blockingBackground50', - if(@group.fieldData == 'Washington DC', 'sp-css-backgroundColor-errorBackground50', - 'sp-field-borderAllRegular sp-field-borderAllSolid sp-css-borderColor-neutralSecondary'))))" - }, - "children": [ - { - "elmType": "img", - "attributes": { - "src": "=if(@group.fieldData == 'California', 'https://upload.wikimedia.org/wikipedia/commons/thumb/0/01/Flag_of_California.svg/1920px-Flag_of_California.svg.png', - if(@group.fieldData == 'Chicago', 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/9b/Flag_of_Chicago%2C_Illinois.svg/1920px-Flag_of_Chicago%2C_Illinois.svg.png', - if(@group.fieldData == 'New York', 'https://upload.wikimedia.org/wikipedia/commons/thumb/b/ba/Flag_of_New_York_City.svg/2560px-Flag_of_New_York_City.svg.png', - if(@group.fieldData == 'Seattle', 'https://upload.wikimedia.org/wikipedia/en/thumb/6/6d/Flag_of_Seattle.svg/1920px-Flag_of_Seattle.svg.png', - if(@group.fieldData == 'Washington DC', 'https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/Flag_of_the_District_of_Columbia.svg/2560px-Flag_of_the_District_of_Columbia.svg.png', - ''))))" - }, - "style": { - "max-width": "24px", - "max-height": "24px", - "margin-top": "2px", - "border-radius": "2px" - } - }, - { - "elmType": "div", - "children": [ - { - "elmType": "span", - "style": { - "padding": "5px 5px 5px 5px", - "font-weight": "500" - }, - "txtContent": "@group.fieldData.displayValue" - } - ] - }, - { - "elmType": "div", - "children": [ - { - "elmType": "div", - "style": { - "display": "flex", - "flex-direction": "row", - "justify-content": "center" - }, - "children": [ - { - "elmType": "div", - "txtContent": "='has ' + @group.count + if(@group.count > '1', ' employees', ' employee')", - "style": { - "font-weight": "500" - } - } - ] - } - ] - } - ] - } - } -} -``` - -#### Example: Color coded group header with aggregate - -In the example below we have list with group headers formatted with group aggregates. - -![Employee list grouped by City with formatted group header with Aggregates summary](../images/employee-formatted-group-header-aggregate-list-layout.png) - -In this example the `hideFooter` for `groupProps` is set to `true` - to hide the group footer and the `@aggregates` array is used to display a summary in the group header. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/row-formatting.schema.json", - "groupProps": { - "hideFooter": true, - "headerFormatter": { - "elmType": "div", - "style": { - "flex-wrap": "wrap", - "display": "flex", - "box-sizing": "border-box", - "padding": "4px 8px 5px 8px", - "border-radius": "6px", - "align-items": "center", - "white-space": "nowrap", - "overflow": "hidden", - "margin": "1px 4px 4px 1px" - }, - "attributes": { - "class": "=if(@group.fieldData == 'California', 'sp-css-backgroundColor-blueBackground37', - if(@group.fieldData == 'Chicago', 'sp-css-backgroundColor-successBackground50', - if(@group.fieldData == 'New York', 'sp-css-backgroundColor-warningBackground50', - if(@group.fieldData == 'Seattle', 'sp-css-backgroundColor-blockingBackground50', - if(@group.fieldData == 'Washington DC', 'sp-css-backgroundColor-errorBackground50', - 'sp-field-borderAllRegular sp-field-borderAllSolid sp-css-borderColor-neutralSecondary'))))" - }, - "children": [ - { - "elmType": "img", - "attributes": { - "src": "=if(@group.fieldData == 'California', 'https://upload.wikimedia.org/wikipedia/commons/thumb/0/01/Flag_of_California.svg/1920px-Flag_of_California.svg.png', - if(@group.fieldData == 'Chicago', 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/9b/Flag_of_Chicago%2C_Illinois.svg/1920px-Flag_of_Chicago%2C_Illinois.svg.png', - if(@group.fieldData == 'New York', 'https://upload.wikimedia.org/wikipedia/commons/thumb/b/ba/Flag_of_New_York_City.svg/2560px-Flag_of_New_York_City.svg.png', - if(@group.fieldData == 'Seattle', 'https://upload.wikimedia.org/wikipedia/en/thumb/6/6d/Flag_of_Seattle.svg/1920px-Flag_of_Seattle.svg.png', - if(@group.fieldData == 'Washington DC', 'https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/Flag_of_the_District_of_Columbia.svg/2560px-Flag_of_the_District_of_Columbia.svg.png', - ''))))" - }, - "style": { - "max-width": "24px", - "max-height": "24px", - "margin-top": "2px", - "border-radius": "2px" - } - }, - { - "elmType": "div", - "children": [ - { - "elmType": "span", - "style": { - "padding": "5px 5px 5px 5px", - "font-weight": "500" - }, - "txtContent": "@group.fieldData.displayValue" - } - ] - }, - { - "elmType": "div", - "forEach": "aggregate in @aggregates", - "children": [ - { - "elmType": "div", - "style": { - "display": "=if([$aggregate.columnDisplayName] == 'Approved' && Number([$aggregate.value]) < @group.count, 'flex', 'none')", - "flex-direction": "row", - "justify-content": "center" - }, - "children": [ - { - "elmType": "div", - "txtContent": "='has approval pending for ' + Number(@group.count - Number([$aggregate.value])) + if(@group.count - Number([$aggregate.value]) > 1 , ' employees', ' employee')", - "style": { - "font-weight": "500" - } - } - ] - } - ] - } - ] - } - } -} - -``` - -#### Example: Custom group footer - -In the example below we have list with group footer formatted according to aggregate value. - -![Employee list grouped by City with formatted group footer](../images/group-footer-list-layout.png) - -In this example the `footerFormatter` for `groupProps` are used to format the group footer and the `@columnAggregate` is used to access column aggregate. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/row-formatting.schema.json", - "groupProps": { - "hideFooter": false, - "footerFormatter": { - "elmType": "div", - "children": [ - { - "elmType": "div", - "attributes": { - "iconName": "=if(@columnAggregate.type == 'Average' && @columnAggregate.value < 10, 'SortDown', 'SortUp')" - }, - "style": { - "color": "=if(@columnAggregate.type == 'Average' && @columnAggregate.value < 10, '#d13438', '#107c10')", - "font-weight": "600", - "margin-top": "10px" - } - }, - { - "elmType": "div", - "style": { - "color": "=if(@columnAggregate.type == 'Average' && @columnAggregate.value < 10, '#d13438', '#107c10')", - "font-weight": "600", - "margin-top": "10px", - "font-family": "Segoe UI" - }, - "txtContent": "=@columnAggregate.type + ': ' + @columnAggregate.value" - } - ] - } - } -} -``` - -### Build custom list footers - -You can use `footerFormatter` to format list footer with access to column aggregates. - -#### Example: Custom list footer - -In the example below we have list with formatted footer as per the aggregate value. - -![Employee list grouped by City with formatted list footer](../images/list-footer-list-layout.png) - -In this example the `footerFormatter` is set to format the list footer and the `@columnAggregate` is used to access column aggregate. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/row-formatting.schema.json", - "hideFooter": false, - "footerFormatter": { - "elmType": "div", - "attributes": { - "class": "ms-fontColor-themePrimary" - }, - "customCardProps": { - "formatter": { - "elmType": "div", - "children": [ - { - "elmType": "div", - "style": { - "display": "flex" - }, - "txtContent": "=@columnAggregate.type + ' of ' + @columnAggregate.columnDisplayName + ' is ' + @columnAggregate.value" - } - ], - "style": { - "height": "10px", - "width": "auto", - "cursor": "pointer", - "font-size": "14px", - "padding": "14px" - } - }, - "openOnEvent": "hover", - "directionalHint": "bottomCenter", - "isBeakVisible": true, - "beakStyle": { - "backgroundColor": "white" - } - }, - "txtContent": "View details", - "style": { - "text-decoration": "none", - "cursor": "pointer", - "font-size": "16px", - "margin-top": "10px" - } - } -} -``` - -## Gallery layout customizations - -### Build custom cards - -You can use Gallery **`formatter`** to define a totally custom layout of field values inside a card using the same syntax used in [Column Formatting](column-formatting.md). - -#### Example: Multi line custom card - -The following image shows a customized card in Gallery layout: - -![Feedback list formatted in Gallery layout](../images/feedback-tile-layout.png) - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/tile-formatting.schema.json", - "height": "250", - "width": "350", - "hideSelection": true, - "formatter": { - "elmType": "div", - "style": { - "display": "flex", - "align-items": "stretch", - "margin-bottom": "16px", - "min-width": "150px", - "flex-grow": "1", - "justify-content": "space-around", - "padding": "5px" - }, - "children": [ - { - "elmType": "div", - "style": { - "width": "95%", - "height": "92%", - "box-shadow": "0px 1.6px 3.6px 0 #00000024, 0px 0.3px 0.9px 0 #00000024", - "overflow": "hidden", - "border-radius": "2px", - "padding-left": "16px", - "padding-top": "16px" - }, - "attributes": { - "class": "ms-bgColor-neutralLighterAlt" - }, - "children": [ - { - "elmType": "div", - "style": { - "text-align": "left" - }, - "children": [ - { - "elmType": "div", - "style": { - "color":"#333333", - "font-size": "16px", - "font-weight":"600", - "margin-bottom":"5px" - }, - "txtContent": "[$Title]" - }, - { - "elmType": "div", - "style": { - "color":"#333333", - "font-size": "14px", - "line-height":"1.8" - }, - "attributes": { - "class": "sp-row-listPadding" - }, - "txtContent": "[$Feedback]" - }, - { - "elmType": "button", - "customRowAction": { - "action": "defaultClick" - }, - "txtContent": "Give feedback", - "attributes": { - "class": "sp-row-button" - }, - "style": { - "display": { - "operator": "?", - "operands": [ - { - "operator": "==", - "operands": [ - "@me", - "[$Assigned_x0020_To.email]" - ] - }, - "", - "none" - ] - } - } - } - ] - } - ] - } - ] - } - -} -``` - -### Build custom group headers - -You can use `groupProps` to format group headers with flexibility to add grouped column's data, display name and item count. You can also add group aggregates in the group headers. - -#### Example: Color coded group header - -In the example below we have gallery view with formatted group headers as per column metadata. - -![Employee gallery grouped by City with formatted group header](../images/employee-formatted-group-header-gallery-layout.png) - -> [!NOTE] -> Gallery card formatter is skipped in the below JSON for simplicity. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/tile-formatting.schema.json", - "height": 277, - "width": 254, - "hideSelection": false, - "groupProps": { - "headerFormatter": { - "elmType": "div", - "children": [ - { - "elmType": "div", - "style": { - "flex-wrap": "wrap", - "display": "flex", - "box-sizing": "border-box", - "padding": "4px 8px 5px 8px", - "border-radius": "6px", - "align-items": "center", - "white-space": "nowrap", - "overflow": "hidden", - "margin": "1px 4px 4px 1px" - }, - "attributes": { - "class": "=if(@group.fieldData == 'California', 'sp-css-backgroundColor-blueBackground37', - if(@group.fieldData == 'Chicago', 'sp-css-backgroundColor-successBackground50', - if(@group.fieldData == 'New York', 'sp-css-backgroundColor-warningBackground50', - if(@group.fieldData == 'Seattle', 'sp-css-backgroundColor-blockingBackground50', - if(@group.fieldData == 'Washington DC', 'sp-css-backgroundColor-errorBackground50', - 'sp-field-borderAllRegular sp-field-borderAllSolid sp-css-borderColor-neutralSecondary'))))" - }, - "children": [ - { - "elmType": "img", - "attributes": { - "src": "=if(@group.fieldData == 'California', 'https://upload.wikimedia.org/wikipedia/commons/thumb/0/01/Flag_of_California.svg/1920px-Flag_of_California.svg.png', - if(@group.fieldData == 'Chicago', 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/9b/Flag_of_Chicago%2C_Illinois.svg/1920px-Flag_of_Chicago%2C_Illinois.svg.png', - if(@group.fieldData == 'New York', 'https://upload.wikimedia.org/wikipedia/commons/thumb/b/ba/Flag_of_New_York_City.svg/2560px-Flag_of_New_York_City.svg.png', - if(@group.fieldData == 'Seattle', 'https://upload.wikimedia.org/wikipedia/en/thumb/6/6d/Flag_of_Seattle.svg/1920px-Flag_of_Seattle.svg.png', - if(@group.fieldData == 'Washington DC', 'https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/Flag_of_the_District_of_Columbia.svg/2560px-Flag_of_the_District_of_Columbia.svg.png', - ''))))" - }, - "style": { - "max-width": "24px", - "max-height": "24px", - "margin-top": "2px", - "border-radius": "2px" - } - }, - { - "elmType": "div", - "children": [ - { - "elmType": "span", - "style": { - "padding": "5px 5px 5px 5px", - "font-weight": "500" - }, - "txtContent": { - "operator": "+", - "operands": [ - "", - "@group.fieldData.displayValue" - ] - } - } - ] - }, - { - "elmType": "div", - "children": [ - { - "elmType": "div", - "style": { - "display": "flex", - "flex-direction": "row", - "justify-content": "center" - }, - "children": [ - { - "elmType": "div", - "txtContent": "='has ' + @group.count + if(@group.count > '1', ' employees', ' employee')", - "style": { - "font-weight": "500" - } - } - ] - } - ] - } - ] - } - ] - } - } -} -``` - -#### Example: Color coded group header with aggregate - -In the example below we have list with formatted group headers and group aggregates. - -![Employee gallery grouped by City with formatted group header with Aggregates summary](../images/employee-formatted-group-header-aggregate-gallery-layout.png) - -In this example the `@aggregates` array is used to display a summary in the group header using `headerFormatter` in `groupProps`. - -> [!NOTE] -> Gallery card formatter is skipped in the below JSON for simplicity. - -```JSON -{ - "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/tile-formatting.schema.json", - "height": 277, - "width": 254, - "hideSelection": false, - "fillHorizontally": true, - "groupProps": { - "headerFormatter": { - "debugMode": true, - "elmType": "div", - "children": [ - { - "elmType": "div", - "style": { - "flex-wrap": "wrap", - "display": "flex", - "box-sizing": "border-box", - "padding": "4px 8px 5px 8px", - "border-radius": "6px", - "align-items": "center", - "white-space": "nowrap", - "overflow": "hidden", - "margin": "1px 4px 4px 1px" - }, - "attributes": { - "class": "=if(@group.fieldData == 'California', 'sp-css-backgroundColor-blueBackground37', - if(@group.fieldData == 'Chicago', 'sp-css-backgroundColor-successBackground50', - if(@group.fieldData == 'New York', 'sp-css-backgroundColor-warningBackground50', - if(@group.fieldData == 'Seattle', 'sp-css-backgroundColor-blockingBackground50', - if(@group.fieldData == 'Washington DC', 'sp-css-backgroundColor-errorBackground50', - 'sp-field-borderAllRegular sp-field-borderAllSolid sp-css-borderColor-neutralSecondary'))))" - }, - "children": [ - { - "elmType": "img", - "attributes": { - "src": "=if(@group.fieldData == 'California', 'https://upload.wikimedia.org/wikipedia/commons/thumb/0/01/Flag_of_California.svg/1920px-Flag_of_California.svg.png', - if(@group.fieldData == 'Chicago', 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/9b/Flag_of_Chicago%2C_Illinois.svg/1920px-Flag_of_Chicago%2C_Illinois.svg.png', - if(@group.fieldData == 'New York', 'https://upload.wikimedia.org/wikipedia/commons/thumb/b/ba/Flag_of_New_York_City.svg/2560px-Flag_of_New_York_City.svg.png', - if(@group.fieldData == 'Seattle', 'https://upload.wikimedia.org/wikipedia/en/thumb/6/6d/Flag_of_Seattle.svg/1920px-Flag_of_Seattle.svg.png', - if(@group.fieldData == 'Washington DC', 'https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/Flag_of_the_District_of_Columbia.svg/2560px-Flag_of_the_District_of_Columbia.svg.png', - ''))))" - }, - "style": { - "max-width": "24px", - "max-height": "24px", - "margin-top": "2px", - "border-radius": "2px" - } - }, - { - "elmType": "div", - "children": [ - { - "elmType": "span", - "style": { - "padding": "5px 5px 5px 5px", - "font-weight": "500" - }, - "txtContent": "@group.fieldData.displayValue" - } - ] - }, - { - "elmType": "div", - "forEach": "aggregate in @aggregates", - "children": [ - { - "elmType": "div", - "style": { - "display": "=if([$aggregate.columnDisplayName] == 'Approved' && Number([$aggregate.value]) < @group.count, 'flex', 'none')", - "flex-direction": "row", - "justify-content": "center" - }, - "children": [ - { - "elmType": "div", - "txtContent": "='has approval pending for ' + Number(@group.count - Number([$aggregate.value])) + if(@group.count - Number([$aggregate.value]) > 1 , ' employees', ' employee')", - "style": { - "font-weight": "500" - } - } - ] - } - ] - } - ] - } - ] - } - } -} -``` - ## Creating custom JSON Creating custom view formatting JSON from scratch is simple if user understands the schema, Monaco Editor is integrated in the formatting pane with pre-filled JSON schema reference to assist in creation of view formatting, Monaco editor has validation and autocomplete to help in crafting right JSON. User can start adding JSON after the first line that defines the schema location. @@ -785,142 +40,12 @@ Creating custom view formatting JSON from scratch is simple if user understands > At any point, select **Ctrl**+**Space** for property/value suggestions. > [!TIP] -> You can start from a HTML using [**formatter helper tool**](https://pnp.github.io/sp-dev-list-formatting/tools/), which can convert HTML and CSS into formatter JSON with inline styles. - -## Detailed syntax reference - -### rowFormatter - -Optional element. Specifies a JSON object that describes a list row format. The schema of this JSON object is identical to the schema of a column format. For details on this schema and its capabilities, see the [Column Format detailed syntax reference](https://docs.microsoft.com/sharepoint/dev/declarative-customization/column-formatting#detailed-syntax-reference). Only valid for 'List' and 'Compact List' layouts. - -> [!NOTE] -> Using the `rowFormatter` property will override anything specified in the `additionalRowClass` property. They are mutually exclusive. - -#### Differences in behavior between the rowFormatter element and column formatting - -Despite sharing the same schema, there are some differences in behavior between elements inside a `rowFormatter` element and those same elements in a column formatting object. - -- `@currentField` always resolves to the value of the `Title` field inside a `rowFormatter`. - -### additionalRowClass - -Optional element. Specifies a CSS class(es) that is applied to the entire row. Supports expressions. Only valid for 'List' and 'Compact List' layouts. - -`additionalRowClass` only takes effect when there is no `rowFormatter` element specified. If a `rowFormatter` is specified, then `additionalRowClass` is ignored. - -### hideSelection - -Optional element. Specifies whether the ability to select rows in the view is disabled or not. `false` is the default behavior inside a list view (meaning selection is visible and enabled). `true` means that users will not be able to select list items. Valid in 'List', 'Compact List' and 'Gallery' layouts. - -For list & compact list layout, `hideSelection` only takes effect when there's a `rowFormatter` element specified. If no `rowFormatter` is specified, then `hideSelection` is ignored. - -### hideColumnHeader - -Optional element. Specifies whether the column headers in the view are hidden or not. `false` is the default behavior inside a list view (meaning column headers will be visible). `true` means that the view will not display column headers. Only valid for 'List' and 'Compact List' layouts. - -### height - -Optional element. Defines the height of the card in pixels for 'Gallery' layout. Only valid for 'Gallery' layout. - -### width - -Optional element. Defines the width of the card in pixels for 'Gallery' layout. Can go from height/2 to 3 x height. Only valid for 'Gallery' layout. - -### formatter - -JSON object that defines the layout of cards for 'Gallery' layout. The schema of this JSON object is identical to the schema of a column format (and that of rowFormatter). For details on this schema and its capabilities, see the [Column Format detailed syntax reference](https://docs.microsoft.com/sharepoint/dev/declarative-customization/column-formatting#detailed-syntax-reference). Only valid for 'Gallery' layout. - -### groupProps - -Groups the group related customization options. Valid in 'List', 'Compact List' and 'Gallery' layouts. - -### headerFormatter - -JSON object that defines the format for group header. The schema of this JSON object is identical to the schema of a column format. For details on this schema and its capabilities, see the [Column Format detailed syntax reference](https://docs.microsoft.com/sharepoint/dev/declarative-customization/column-formatting#detailed-syntax-reference). Valid in 'List', 'Compact List' and 'Gallery' layouts. - -### footerFormatter - -JSON object that defines the format for group and list footer. The schema of this JSON object is identical to the schema of a column format (and that of rowFormatter). For details on this schema and its capabilities, see the [Column Format detailed syntax reference](https://docs.microsoft.com/sharepoint/dev/declarative-customization/column-formatting#detailed-syntax-reference). Valid in 'List' and 'Compact List' layouts. - -### hideFooter - -Optional element. Specifies whether the list footers or the group footers in the view are hidden or not. `false` is the default behavior (meaning footer is visible). `true` means that view will not display footers. Valid in 'List' and 'Compact List' layouts. - -For list & compact list layout, `hideFooter` overrides the `footerFormatter`, if present. - -### Special string values - -The values for `txtContent`, styles, and attributes can be either strings or expression objects. A few special string patterns for retrieving values from group and aggregate are supported. - -#### "@group" - -Provides access to the grouped column's data, display name and item count. Valid in 'List', 'Compact List' and 'Gallery' layouts. Available only inside `groupProps`. - -The `@group` object has the following properties (with example values): - -```JSON -{ - "fieldData": "California", - "columnDisplayName": "City", - "count": 3 -} -``` - -You can also access sub properties for fields with rich data, e.g. People field, as mentioned under [Column Format special string values](https://docs.microsoft.com/sharepoint/dev/declarative-customization/column-formatting#special-string-values). - -```JSON -{ - "fieldData": { - "id": "122", - "title": "Kalya Tucker", - "email": "kaylat@contoso.com", - "sip": "kaylat@contoso.com", - "picture": "https://contoso.sharepoint.com/kaylat_contoso_com_MThumb.jpg?t=63576928822", - "department": "Human Resources", - "jobTitle": "HR Manager" - }, - "columnDisplayName": "Author", - "count": 5 -} - -``` - -#### "@columnAggregate" - -Provides access to the aggregated column's value, display name and aggregate type. Valid in 'List' and 'Compact List' layouts. Available only inside `footerFormatter`. - -The `@columnAggregate` object has the following properties (with example values): - -```JSON -{ - "value": "3", - "columnDisplayName": "Approved", - "type": "Count" -} -``` - -#### "@aggregates" - -Provides access to array of aggregated column's value, display name and aggregate type. Valid in 'List', 'Compact List' and 'Gallery' layouts. Available only inside `groupProps`. - -The `@aggregates` object has the following properties (with example value), and can be iterated on using [Column Format forEach](https://docs.microsoft.com/sharepoint/dev/declarative-customization/column-formatting#foreach) property. - -```JSON -[ - { - "value": "3", - "columnDisplayName": "Approved", - "type": "Count" - }, - { - "value": "1.2", - "columnDisplayName": "Growth", - "type": "Average" - }, - { - "value": "0.33%", - "columnDisplayName": "Rate of change", - "type": "Variance" - } -] -``` +> You can start from a HTML using [**formatter helper tool**](https://pnp.github.io/List-Formatting/tools/), which can convert HTML and CSS into formatter JSON with inline styles. + +## See also +- [List layout customization](./view-list-formatting.md) +- [Gallery layout customization](./view-gallery-formatting.md) +- [Board view customization](./view-gallery-formatting.md) +- [Group customization syntax reference](./view-group-formatting.md) +- [Advanced formatting concepts](./formatting-advanced.md) +- [Formatting syntax reference](./formatting-syntax-reference.md) diff --git a/docs/declarative-customization/view-gallery-formatting.md b/docs/declarative-customization/view-gallery-formatting.md new file mode 100644 index 000000000..7eb60a1f5 --- /dev/null +++ b/docs/declarative-customization/view-gallery-formatting.md @@ -0,0 +1,366 @@ +--- +title: Format gallery view to customize SharePoint +description: Customize how gallery views in SharePoint lists and libraries are displayed by constructing a JSON object that describes the elements and the styles to be applied to those elements. +ms.date: 06/28/2022 +ms.localizationpriority: high +--- + +# Gallery layout customizations + +## Build custom cards + +You can use Gallery **`formatter`** to define a totally custom layout of field values inside a card using the same syntax used in [Column Formatting](column-formatting.md). + +### Example: Multi line custom card + +The following image shows a customized card in Gallery layout: + +![Feedback list formatted in Gallery layout](../images/feedback-tile-layout.png) + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/tile-formatting.schema.json", + "height": "250", + "width": "350", + "hideSelection": true, + "formatter": { + "elmType": "div", + "style": { + "display": "flex", + "align-items": "stretch", + "margin-bottom": "16px", + "min-width": "150px", + "flex-grow": "1", + "justify-content": "space-around", + "padding": "5px" + }, + "children": [ + { + "elmType": "div", + "style": { + "width": "95%", + "height": "92%", + "box-shadow": "0px 1.6px 3.6px 0 #00000024, 0px 0.3px 0.9px 0 #00000024", + "overflow": "hidden", + "border-radius": "2px", + "padding-left": "16px", + "padding-top": "16px" + }, + "attributes": { + "class": "ms-bgColor-neutralLighterAlt" + }, + "children": [ + { + "elmType": "div", + "style": { + "text-align": "left" + }, + "children": [ + { + "elmType": "div", + "style": { + "color":"#333333", + "font-size": "16px", + "font-weight":"600", + "margin-bottom":"5px" + }, + "txtContent": "[$Title]" + }, + { + "elmType": "div", + "style": { + "color":"#333333", + "font-size": "14px", + "line-height":"1.8" + }, + "attributes": { + "class": "sp-row-listPadding" + }, + "txtContent": "[$Feedback]" + }, + { + "elmType": "button", + "customRowAction": { + "action": "defaultClick" + }, + "txtContent": "Give feedback", + "attributes": { + "class": "sp-row-button" + }, + "style": { + "display": { + "operator": "?", + "operands": [ + { + "operator": "==", + "operands": [ + "@me", + "[$Assigned_x0020_To.email]" + ] + }, + "", + "none" + ] + } + } + } + ] + } + ] + } + ] + } + +} +``` + +## Build custom group headers + +You can use `groupProps` to format group headers with flexibility to add grouped column's data, display name and item count. You can also add group aggregates in the group headers. + +### Example: Color coded group header + +In the example below we have gallery view with formatted group headers as per column metadata. + +![Employee gallery grouped by City with formatted group header](../images/employee-formatted-group-header-gallery-layout.png) + +> [!NOTE] +> Gallery card formatter is skipped in the below JSON for simplicity. +> The example below also contains line breaks. These have been added to improve the readability of the code. + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/tile-formatting.schema.json", + "height": 277, + "width": 254, + "hideSelection": false, + "groupProps": { + "headerFormatter": { + "elmType": "div", + "children": [ + { + "elmType": "div", + "style": { + "flex-wrap": "wrap", + "display": "flex", + "box-sizing": "border-box", + "padding": "4px 8px 5px 8px", + "border-radius": "6px", + "align-items": "center", + "white-space": "nowrap", + "overflow": "hidden", + "margin": "1px 4px 4px 1px" + }, + "attributes": { + "class": "=if(@group.fieldData == 'California', 'sp-css-backgroundColor-blueBackground37', + if(@group.fieldData == 'Chicago', 'sp-css-backgroundColor-successBackground50', + if(@group.fieldData == 'New York', 'sp-css-backgroundColor-warningBackground50', + if(@group.fieldData == 'Seattle', 'sp-css-backgroundColor-blockingBackground50', + if(@group.fieldData == 'Washington DC', 'sp-css-backgroundColor-errorBackground50', + 'sp-field-borderAllRegular sp-field-borderAllSolid sp-css-borderColor-neutralSecondary'))))" + }, + "children": [ + { + "elmType": "img", + "attributes": { + "src": "=if(@group.fieldData == 'California', 'https://upload.wikimedia.org/wikipedia/commons/thumb/0/01/Flag_of_California.svg/1920px-Flag_of_California.svg.png', + if(@group.fieldData == 'Chicago', 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/9b/Flag_of_Chicago%2C_Illinois.svg/1920px-Flag_of_Chicago%2C_Illinois.svg.png', + if(@group.fieldData == 'New York', 'https://upload.wikimedia.org/wikipedia/commons/thumb/b/ba/Flag_of_New_York_City.svg/2560px-Flag_of_New_York_City.svg.png', + if(@group.fieldData == 'Seattle', 'https://upload.wikimedia.org/wikipedia/en/thumb/6/6d/Flag_of_Seattle.svg/1920px-Flag_of_Seattle.svg.png', + if(@group.fieldData == 'Washington DC', 'https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/Flag_of_the_District_of_Columbia.svg/2560px-Flag_of_the_District_of_Columbia.svg.png', '')))))" + }, + "style": { + "max-width": "24px", + "max-height": "24px", + "margin-top": "2px", + "border-radius": "2px" + } + }, + { + "elmType": "div", + "children": [ + { + "elmType": "span", + "style": { + "padding": "5px 5px 5px 5px", + "font-weight": "500" + }, + "txtContent": { + "operator": "+", + "operands": [ + "", + "@group.fieldData.displayValue" + ] + } + } + ] + }, + { + "elmType": "div", + "children": [ + { + "elmType": "div", + "style": { + "display": "flex", + "flex-direction": "row", + "justify-content": "center" + }, + "children": [ + { + "elmType": "div", + "txtContent": "='has ' + @group.count + if(@group.count > '1', ' employees', ' employee')", + "style": { + "font-weight": "500" + } + } + ] + } + ] + } + ] + } + ] + } + } +} +``` + +### Example: Color coded group header with aggregate + +In the example below we have list with formatted group headers and group aggregates. + +![Employee gallery grouped by City with formatted group header with Aggregates summary](../images/employee-formatted-group-header-aggregate-gallery-layout.png) + +In this example the `@aggregates` array is used to display a summary in the group header using `headerFormatter` in `groupProps`. + +> [!NOTE] +> Gallery card formatter is skipped in the below JSON for simplicity. +> The example below also contains line breaks. These have been added to improve the readability of the code. + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/tile-formatting.schema.json", + "height": 277, + "width": 254, + "hideSelection": false, + "fillHorizontally": true, + "groupProps": { + "headerFormatter": { + "debugMode": true, + "elmType": "div", + "children": [ + { + "elmType": "div", + "style": { + "flex-wrap": "wrap", + "display": "flex", + "box-sizing": "border-box", + "padding": "4px 8px 5px 8px", + "border-radius": "6px", + "align-items": "center", + "white-space": "nowrap", + "overflow": "hidden", + "margin": "1px 4px 4px 1px" + }, + "attributes": { + "class": "=if(@group.fieldData == 'California', 'sp-css-backgroundColor-blueBackground37', + if(@group.fieldData == 'Chicago', 'sp-css-backgroundColor-successBackground50', + if(@group.fieldData == 'New York', 'sp-css-backgroundColor-warningBackground50', + if(@group.fieldData == 'Seattle', 'sp-css-backgroundColor-blockingBackground50', + if(@group.fieldData == 'Washington DC', 'sp-css-backgroundColor-errorBackground50', 'sp-field-borderAllRegular sp-field-borderAllSolid sp-css-borderColor-neutralSecondary')))))" + }, + "children": [ + { + "elmType": "img", + "attributes": { + "src": "=if(@group.fieldData == 'California', 'https://upload.wikimedia.org/wikipedia/commons/thumb/0/01/Flag_of_California.svg/1920px-Flag_of_California.svg.png', + if(@group.fieldData == 'Chicago', 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/9b/Flag_of_Chicago%2C_Illinois.svg/1920px-Flag_of_Chicago%2C_Illinois.svg.png', + if(@group.fieldData == 'New York', 'https://upload.wikimedia.org/wikipedia/commons/thumb/b/ba/Flag_of_New_York_City.svg/2560px-Flag_of_New_York_City.svg.png', + if(@group.fieldData == 'Seattle', 'https://upload.wikimedia.org/wikipedia/en/thumb/6/6d/Flag_of_Seattle.svg/1920px-Flag_of_Seattle.svg.png', + if(@group.fieldData == 'Washington DC', 'https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/Flag_of_the_District_of_Columbia.svg/2560px-Flag_of_the_District_of_Columbia.svg.png', '')))))" + }, + "style": { + "max-width": "24px", + "max-height": "24px", + "margin-top": "2px", + "border-radius": "2px" + } + }, + { + "elmType": "div", + "children": [ + { + "elmType": "span", + "style": { + "padding": "5px 5px 5px 5px", + "font-weight": "500" + }, + "txtContent": "@group.fieldData.displayValue" + } + ] + }, + { + "elmType": "div", + "forEach": "aggregate in @aggregates", + "children": [ + { + "elmType": "div", + "style": { + "display": "=if([$aggregate.columnDisplayName] == 'Approved' && Number([$aggregate.value]) < @group.count, 'flex', 'none')", + "flex-direction": "row", + "justify-content": "center" + }, + "children": [ + { + "elmType": "div", + "txtContent": "='has approval pending for ' + Number(@group.count - Number([$aggregate.value])) + if(@group.count - Number([$aggregate.value]) > 1 , ' employees', ' employee')", + "style": { + "font-weight": "500" + } + } + ] + } + ] + } + ] + } + ] + } + } +} +``` + +## Detailed syntax reference + +### hideSelection + +Optional element. Specifies whether the ability to select cards in the view is disabled or not. `false` is the default behavior inside a gallery view (meaning selection is visible and enabled). `true` means that users will not be able to select list items. +### fillHorizontally + +Optional element. Specifies whether the cards in the row should be stretched horizontally to fill the row. `false` is the default behavior (meaning cards in a row are stacked without resizing until they overflow). `true` means cards in the row are stretched horizontally only if necessary to fill the row. + +### height + +Optional element. Defines the height of the card in pixels. + +### width + +Optional element. Defines the width of the card in pixels. Can go from height/2 to 3 x height. + +### formatter + +JSON object that defines the layout of cards. The schema of this JSON object is identical to the schema of a column format (and that of rowFormatter). For details on this schema and its capabilities, see the [Formatting syntax reference](./formatting-syntax-reference.md). + +### groupProps + +Groups the group related customization options. For details on `groupProps`, see [Group Customization syntax reference](./view-group-formatting.md) + +### commandBarProps + +Groups the command bar customization options. For details on `commandBarProps`, see [Command bar customization syntax reference](./view-commandbar-formatting.md) + +## See also +- [Group customization syntax reference](./view-group-formatting.md) +- [Command bar customization syntax reference](./view-commandbar-formatting.md) +- [Advanced formatting concepts](./formatting-advanced.md) +- [Formatting syntax reference](./formatting-syntax-reference.md) diff --git a/docs/declarative-customization/view-group-formatting.md b/docs/declarative-customization/view-group-formatting.md new file mode 100644 index 000000000..32798d847 --- /dev/null +++ b/docs/declarative-customization/view-group-formatting.md @@ -0,0 +1,102 @@ +--- +title: Group customization syntax reference +description: Group customization syntax reference +ms.date: 06/28/2022 +ms.localizationpriority: high +--- + +# Group customization syntax reference + +## groupProps + +Groups the group related customization options. Valid in 'List', 'Compact List' and 'Gallery' layouts. + +## headerFormatter + +JSON object that defines the format for group header. The schema of this JSON object is identical to the schema of a column format. For details on this schema and its capabilities, see the [Formatting syntax reference](./formatting-syntax-reference.md). Valid in 'List', 'Compact List' and 'Gallery' layouts. + +## footerFormatter + +JSON object that defines the format for group and list footer. The schema of this JSON object is identical to the schema of a column format (and that of rowFormatter). For details on this schema and its capabilities, see the [Formatting syntax reference](./formatting-syntax-reference.md). Valid in 'List' and 'Compact List' layouts. + +## hideFooter + +Optional element. Specifies whether the list footers or the group footers in the view are hidden or not. `false` is the default behavior (meaning footer is visible). `true` means that view will not display footers. Valid in 'List' and 'Compact List' layouts. + +For list & compact list layout, `hideFooter` overrides the `footerFormatter`, if present. + +## Special string values + +The values for `txtContent`, styles, and attributes can be either strings or expression objects. A few special string patterns for retrieving values from group and aggregate are supported. + +### "@group" + +Provides access to the grouped column's data, display name and item count. Valid in 'List', 'Compact List' and 'Gallery' layouts. Available only inside `groupProps`. + +The `@group` object has the following properties (with example values): + +```JSON +{ + "fieldData": "California", + "columnDisplayName": "City", + "count": 3 +} +``` + +You can also access sub properties for fields with rich data, e.g. People field, as mentioned under [Formatting Special string values](./formatting-syntax-reference.md#special-string-values). + +```JSON +{ + "fieldData": { + "id": "122", + "title": "Kalya Tucker", + "email": "kaylat@contoso.com", + "sip": "kaylat@contoso.com", + "picture": "https://contoso.sharepoint.com/kaylat_contoso_com_MThumb.jpg?t=63576928822", + "department": "Human Resources", + "jobTitle": "HR Manager" + }, + "columnDisplayName": "Author", + "count": 5 +} +``` + +### "@columnAggregate" + +Provides access to the aggregated column's value, display name and aggregate type. Valid in 'List' and 'Compact List' layouts. Available only inside `footerFormatter`. + +The `@columnAggregate` object has the following properties (with example values): + +```JSON +{ + "value": "3", + "columnDisplayName": "Approved", + "type": "Count" +} +``` + +### "@aggregates" + +Provides access to array of aggregated column's value, display name and aggregate type. Valid in 'List', 'Compact List' and 'Gallery' layouts. Available only inside `groupProps`. + +The `@aggregates` object has the following properties (with example value), and can be iterated on using for [Formatting forEach](./formatting-syntax-reference.md#foreach) property. + +```JSON +[ + { + "value": "3", + "columnDisplayName": "Approved", + "type": "Count" + }, + { + "value": "1.2", + "columnDisplayName": "Growth", + "type": "Average" + }, + { + "value": "0.33%", + "columnDisplayName": "Rate of change", + "type": "Variance" + } +] +``` diff --git a/docs/declarative-customization/view-list-formatting.md b/docs/declarative-customization/view-list-formatting.md new file mode 100644 index 000000000..42bc48c36 --- /dev/null +++ b/docs/declarative-customization/view-list-formatting.md @@ -0,0 +1,474 @@ +--- +title: Format list view to customize SharePoint +description: Customize how list views in SharePoint lists and libraries are displayed by constructing a JSON object that describes the elements and the styles to be applied to those elements. +ms.date: 08/10/2022 +ms.localizationpriority: high +--- + +# List layout customizations + +## Apply conditional classes on rows + +You can use **`additionalRowClass`** to apply one or more classes to the entire list row depending on the value of one or more fields in the row. These examples leave the content and structure of list rows intact. + +For a list of recommended classes to use inside view formats, please see the [Style guidelines](./column-formatting.md#style-guidelines) in the [Use column formatting to customize SharePoint](column-formatting.md). + +> [!TIP] +> Using the `additionalRowClass` property to apply classes to list rows will leave the formatting of individual columns in place. This allows you to combine view formats with column formatting for some powerful visualizations. + +### Example: Conditional classes based on a date field + +The following image shows a list layout with a class applied based on the value of a date column: + +![SharePoint list with view formatted with conditional formatting](../images/listformatting-additionalrowclass.png) + +This example applies the class `sp-field-severity--severeWarning` to a list row when the item's DueDate is before the current date/time: + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json", + "additionalRowClass": "=if([$DueDate] <= @now, 'sp-field-severity--severeWarning', '')" +} +``` + +### Example: Conditional classes based on the value in a text or choice field + +This example was adopted from a column formatting example, [Conditional formatting based on the value in a text or choice field](https://github.com/SharePoint/sp-dev-list-formatting/tree/master/column-samples/text-conditional-format), with some important differences to apply the concept to list rows. The column formatting example applies both an icon and a class to a column based on the value of `@currentField`. The `additionalRowClass` attribute in view formatting, however, only allows you to specify a class and not an icon. Additionally, since `@currentField` always resolves to the value of the `Title` field when referenced inside a view format, this sample refers to the `Status` field directly (by using the [$Field] syntax inside the additionalRowClass property to determine which class to apply to the row). + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json", + "additionalRowClass": "=if([$Status] == 'Done', 'sp-field-severity--good', if([$Status] == 'In progress', 'sp-field-severity--low' ,if([$Status] == 'In review','sp-field-severity--warning', if([$Status] == 'Has issues','sp-field-severity--blocked', ''))))" +} +``` + +You can find this sample with additional details here: [Conditional formatting based on choice field](https://github.com/pnp/list-formatting/tree/master/view-samples/status-rowclass) + +### Example: Alternate Row Formatting based on Modulus + +This example applies `% (Mod)` to a list row with alternate coloring the rows: + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/view-formatting.schema.json", + "additionalRowClass": "=if(@rowIndex%2==0,'ms-bgColor-themeLight','')" +} +``` + +## Build custom list rows + +You can use **`rowFormatter`** to define a totally custom layout of field values inside a row using the same syntax used in [Column Formatting](column-formatting.md). + +### Example: Multi-line view style + +The following image shows a list with a custom multi-line view style applied: + +![SharePoint list with multi-line view customization](../images/listformatting-rowformatter.png) + +This example uses the `rowFormatter` element, which totally overrides the rendering of a list row. The `rowFormatter` in this example creates a bounding `
` box for every list row. Inside this bounding box, the `$Title` and `$Feedback` fields are displayed on separate lines. Under those fields, a `button` element is displayed that, when clicked, does the same thing as clicking the list row in an uncustomized view, which is opening the property form for the item. This `button` is displayed conditionally, when the value of the `$Assigned_x0020_To` field (assumed to be a person/group field) matches the current signed-in user: + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/row-formatting.schema.json", + "hideSelection": true, + "hideColumnHeader": true, + "rowFormatter": { + "elmType": "div", + "attributes": { + "class": "sp-row-card" + }, + "children": [ + { + "elmType": "div", + "style": { + "text-align": "left" + }, + "children": [ + { + "elmType": "div", + "attributes": { + "class": "sp-row-title" + }, + "txtContent": "[$Title]" + }, + { + "elmType": "div", + "attributes": { + "class": "sp-row-listPadding" + }, + "txtContent": "[$Feedback]" + }, + { + "elmType": "button", + "customRowAction": { + "action": "defaultClick" + }, + "txtContent": "Give feedback", + "attributes": { + "class": "sp-row-button" + }, + "style": { + "display": { + "operator": "?", + "operands": [ + { + "operator": "==", + "operands": [ + "@me", + "[$Assigned_x0020_To.email]" + ] + }, + "", + "none" + ] + } + } + } + ] + } + ] + } +} +``` + +You can find this sample with additional details here: [Multi-line view rendering](https://github.com/SharePoint/sp-dev-list-formatting/tree/master/view-samples/multi-line-view) + +## Build custom group headers and footers + +You can use `groupProps` to format group headers with flexibility to add grouped column's data, display name and item count. You can also add group aggregates in the group headers or format it directly in the group footers. + +### Example: Color coded group header + +In the example below we have list with group headers formatted according to column metadata. + +![Employee list grouped by City with formatted group header](../images/employee-formatted-group-header-list-layout.png) + +In this example below, the `headerFormatter` for `groupProps` is used to format the group header and the `@group` is used to access group info. + +> [!NOTE] +> The JSON below contains line breaks. These have been added to improve the readability of the code. + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/row-formatting.schema.json", + "groupProps": { + "headerFormatter": { + "elmType": "div", + "style": { + "flex-wrap": "wrap", + "display": "flex", + "box-sizing": "border-box", + "padding": "4px 8px 5px 8px", + "border-radius": "6px", + "align-items": "center", + "white-space": "nowrap", + "overflow": "hidden", + "margin": "1px 4px 4px 1px" + }, + "attributes": { + "class": "=if(@group.fieldData == 'California', 'sp-css-backgroundColor-blueBackground37', + if(@group.fieldData == 'Chicago', 'sp-css-backgroundColor-successBackground50', + if(@group.fieldData == 'New York', 'sp-css-backgroundColor-warningBackground50', + if(@group.fieldData == 'Seattle', 'sp-css-backgroundColor-blockingBackground50', + if(@group.fieldData == 'Washington DC', 'sp-css-backgroundColor-errorBackground50', + 'sp-field-borderAllRegular sp-field-borderAllSolid sp-css-borderColor-neutralSecondary')))))" + }, + "children": [ + { + "elmType": "img", + "attributes": { + "src": "=if(@group.fieldData == 'California', 'https://upload.wikimedia.org/wikipedia/commons/thumb/0/01/Flag_of_California.svg/1920px-Flag_of_California.svg.png', + if(@group.fieldData == 'Chicago', 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/9b/Flag_of_Chicago%2C_Illinois.svg/1920px-Flag_of_Chicago%2C_Illinois.svg.png', + if(@group.fieldData == 'New York', 'https://upload.wikimedia.org/wikipedia/commons/thumb/b/ba/Flag_of_New_York_City.svg/2560px-Flag_of_New_York_City.svg.png', + if(@group.fieldData == 'Seattle', 'https://upload.wikimedia.org/wikipedia/en/thumb/6/6d/Flag_of_Seattle.svg/1920px-Flag_of_Seattle.svg.png', + if(@group.fieldData == 'Washington DC', 'https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/Flag_of_the_District_of_Columbia.svg/2560px-Flag_of_the_District_of_Columbia.svg.png', '')))))" + }, + "style": { + "max-width": "24px", + "max-height": "24px", + "margin-top": "2px", + "border-radius": "2px" + } + }, + { + "elmType": "div", + "children": [ + { + "elmType": "span", + "style": { + "padding": "5px 5px 5px 5px", + "font-weight": "500" + }, + "txtContent": "@group.fieldData.displayValue" + } + ] + }, + { + "elmType": "div", + "children": [ + { + "elmType": "div", + "style": { + "display": "flex", + "flex-direction": "row", + "justify-content": "center" + }, + "children": [ + { + "elmType": "div", + "txtContent": "='has ' + @group.count + if(@group.count > '1', ' employees', ' employee')", + "style": { + "font-weight": "500" + } + } + ] + } + ] + } + ] + } + } +} +``` + +### Example: Color coded group header with aggregate + +In the example below we have list with group headers formatted with group aggregates. + +![Employee list grouped by City with formatted group header with Aggregates summary](../images/employee-formatted-group-header-aggregate-list-layout.png) + +In this example the `hideFooter` for `groupProps` is set to `true` - to hide the group footer and the `@aggregates` array is used to display a summary in the group header. + +> [!NOTE] +> The JSON below contains line breaks. These have been added to improve the readability of the code. + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/row-formatting.schema.json", + "groupProps": { + "hideFooter": true, + "headerFormatter": { + "elmType": "div", + "style": { + "flex-wrap": "wrap", + "display": "flex", + "box-sizing": "border-box", + "padding": "4px 8px 5px 8px", + "border-radius": "6px", + "align-items": "center", + "white-space": "nowrap", + "overflow": "hidden", + "margin": "1px 4px 4px 1px" + }, + "attributes": { + "class": "=if(@group.fieldData == 'California', 'sp-css-backgroundColor-blueBackground37', + if(@group.fieldData == 'Chicago', 'sp-css-backgroundColor-successBackground50', + if(@group.fieldData == 'New York', 'sp-css-backgroundColor-warningBackground50', + if(@group.fieldData == 'Seattle', 'sp-css-backgroundColor-blockingBackground50', + if(@group.fieldData == 'Washington DC', 'sp-css-backgroundColor-errorBackground50', + 'sp-field-borderAllRegular sp-field-borderAllSolid sp-css-borderColor-neutralSecondary')))))" + }, + "children": [ + { + "elmType": "img", + "attributes": { + "src": "=if(@group.fieldData == 'California', 'https://upload.wikimedia.org/wikipedia/commons/thumb/0/01/Flag_of_California.svg/1920px-Flag_of_California.svg.png', + if(@group.fieldData == 'Chicago', 'https://upload.wikimedia.org/wikipedia/commons/thumb/9/9b/Flag_of_Chicago%2C_Illinois.svg/1920px-Flag_of_Chicago%2C_Illinois.svg.png', + if(@group.fieldData == 'New York', 'https://upload.wikimedia.org/wikipedia/commons/thumb/b/ba/Flag_of_New_York_City.svg/2560px-Flag_of_New_York_City.svg.png', + if(@group.fieldData == 'Seattle', 'https://upload.wikimedia.org/wikipedia/en/thumb/6/6d/Flag_of_Seattle.svg/1920px-Flag_of_Seattle.svg.png', + if(@group.fieldData == 'Washington DC', 'https://upload.wikimedia.org/wikipedia/commons/thumb/d/d4/Flag_of_the_District_of_Columbia.svg/2560px-Flag_of_the_District_of_Columbia.svg.png', '')))))" + }, + "style": { + "max-width": "24px", + "max-height": "24px", + "margin-top": "2px", + "border-radius": "2px" + } + }, + { + "elmType": "div", + "children": [ + { + "elmType": "span", + "style": { + "padding": "5px 5px 5px 5px", + "font-weight": "500" + }, + "txtContent": "@group.fieldData.displayValue" + } + ] + }, + { + "elmType": "div", + "forEach": "aggregate in @aggregates", + "children": [ + { + "elmType": "div", + "style": { + "display": "=if([$aggregate.columnDisplayName] == 'Approved' && Number([$aggregate.value]) < @group.count, 'flex', 'none')", + "flex-direction": "row", + "justify-content": "center" + }, + "children": [ + { + "elmType": "div", + "txtContent": "='has approval pending for ' + Number(@group.count - Number([$aggregate.value])) + if(@group.count - Number([$aggregate.value]) > 1 , ' employees', ' employee')", + "style": { + "font-weight": "500" + } + } + ] + } + ] + } + ] + } + } +} + +``` + +### Example: Custom group footer + +In the example below we have list with group footer formatted according to aggregate value. + +![Employee list grouped by City with formatted group footer](../images/group-footer-list-layout.png) + +In this example the `footerFormatter` for `groupProps` are used to format the group footer and the `@columnAggregate` is used to access column aggregate. + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/row-formatting.schema.json", + "groupProps": { + "hideFooter": false, + "footerFormatter": { + "elmType": "div", + "children": [ + { + "elmType": "div", + "attributes": { + "iconName": "=if(@columnAggregate.type == 'Average' && @columnAggregate.value < 10, 'SortDown', 'SortUp')" + }, + "style": { + "color": "=if(@columnAggregate.type == 'Average' && @columnAggregate.value < 10, '#d13438', '#107c10')", + "font-weight": "600", + "margin-top": "10px" + } + }, + { + "elmType": "div", + "style": { + "color": "=if(@columnAggregate.type == 'Average' && @columnAggregate.value < 10, '#d13438', '#107c10')", + "font-weight": "600", + "margin-top": "10px", + "font-family": "Segoe UI" + }, + "txtContent": "=@columnAggregate.type + ': ' + @columnAggregate.value" + } + ] + } + } +} +``` + +## Build custom list footers + +You can use `footerFormatter` to format list footer with access to column aggregates. + +### Example: Custom list footer + +In the example below we have list with formatted footer as per the aggregate value. + +![Employee list grouped by City with formatted list footer](../images/list-footer-list-layout.png) + +In this example the `footerFormatter` is set to format the list footer and the `@columnAggregate` is used to access column aggregate. + +```JSON +{ + "$schema": "https://developer.microsoft.com/json-schemas/sp/v2/row-formatting.schema.json", + "hideFooter": false, + "footerFormatter": { + "elmType": "div", + "attributes": { + "class": "ms-fontColor-themePrimary" + }, + "customCardProps": { + "formatter": { + "elmType": "div", + "children": [ + { + "elmType": "div", + "style": { + "display": "flex" + }, + "txtContent": "=@columnAggregate.type + ' of ' + @columnAggregate.columnDisplayName + ' is ' + @columnAggregate.value" + } + ], + "style": { + "height": "10px", + "width": "auto", + "cursor": "pointer", + "font-size": "14px", + "padding": "14px" + } + }, + "openOnEvent": "hover", + "directionalHint": "bottomCenter", + "isBeakVisible": true, + "beakStyle": { + "backgroundColor": "white" + } + }, + "txtContent": "View details", + "style": { + "text-decoration": "none", + "cursor": "pointer", + "font-size": "16px", + "margin-top": "10px" + } + } +} +``` + +## Detailed syntax reference + +### rowFormatter + +Optional element. Specifies a JSON object that describes a list row format. The schema of this JSON object is identical to the schema of a column format. For details on this schema and its capabilities, see [Formatting syntax reference](./formatting-syntax-reference.md). + +> [!NOTE] +> Using the `rowFormatter` property will override anything specified in the `additionalRowClass` property. They are mutually exclusive. + +#### Differences in behavior between the rowFormatter element and column formatting + +Despite sharing the same schema, there are some differences in behavior between elements inside a `rowFormatter` element and those same elements in a column formatting object. + +- `@currentField` always resolves to the value of the `Title` field inside a `rowFormatter`. + +### additionalRowClass + +Optional element. Specifies a CSS class(es) that is applied to the entire row. Supports expressions. + +`additionalRowClass` only takes effect when there is no `rowFormatter` element specified. If a `rowFormatter` is specified, then `additionalRowClass` is ignored. + +### hideSelection + +Optional element. Specifies whether the ability to select rows in the view is disabled or not. `false` is the default behavior inside a list view (meaning selection is visible and enabled). `true` means that users will not be able to select list items. + +### hideColumnHeader + +Optional element. Specifies whether the column headers in the view are hidden or not. `false` is the default behavior inside a list view (meaning column headers will be visible). `true` means that the view will not display column headers. + +### groupProps + +Groups the group related customization options. For details on `groupProps`, see [Group Customization syntax reference](./view-group-formatting.md) + +### commandBarProps + +Groups the command bar customization options. For details on `commandBarProps`, see [Command bar customization syntax reference](./view-commandbar-formatting.md) + +## See also +- [Group customization syntax reference](./view-group-formatting.md) +- [Command bar customization syntax reference](./view-commandbar-formatting.md) +- [Advanced formatting concepts](./formatting-advanced.md) +- [Formatting syntax reference](./formatting-syntax-reference.md) diff --git a/docs/design/accessibility.md b/docs/design/accessibility.md index 217609c09..393091803 100644 --- a/docs/design/accessibility.md +++ b/docs/design/accessibility.md @@ -1,10 +1,9 @@ --- title: Accessibility in SharePoint web part design description: Guidelines for adding accessibility to your web part. -ms.date: 03/22/2018 -localization_priority: Normal +ms.date: 06/13/2022 +ms.localizationpriority: medium --- - # Accessibility in SharePoint web part design Developing an experience that meets all users' unique visual, hearing, dexterity, cognitive, and speech needs is an important component of SharePoint web part design. Accessible design applies not only to people with disabilities, but also to potential situational impairments. Accessible design is good design. @@ -15,7 +14,7 @@ All Microsoft products must meet the requirements listed in the [Microsoft Acces ## Making web parts accessible -The SharePoint Framework provides a structure to help make all web parts accessible. The web part container provides keyboard navigation defaults for the web part toolbar to edit, move, and delete the web part, a method to select the web part, and a keyboard short cut (Ctrl+P) to open the property pane. However, you still need to specify additional keyboard and screen reader navigation for the other aspects of the UI in the web part and in the property pane. +The SharePoint Framework provides a structure to help make all web parts accessible. The web part container provides keyboard navigation defaults for the web part toolbar to edit, move, and delete the web part, a method to select the web part, and a keyboard short cut (Ctrl+P) to open the property pane. However, you still need to specify additional keyboard and screen reader navigation for the other aspects of the UI in the web part and in the property pane. In addition, many [Office UI Fabric components](https://developer.microsoft.com/fabric#/components) have built-in support for accessibility options, to make it quick to configure keyboard and screen reader navigation when you use the components in a web part. @@ -27,9 +26,9 @@ The following image shows keyboard navigation on a web part. Test your web part first with [Narrator](https://support.microsoft.com/help/22798/windows-10-narrator-get-started) and Microsoft Edge, and then verify the accessibility experience with [JAWS](http://www.freedomscientific.com/Products/Blindness/JAWS). -Narrator and Microsoft Edge are standards compliant. When you test with that combination, you are more likely to find issues, and you can validate that your site meets accessibility standards. +Narrator and Microsoft Edge are standards compliant. When you test with that combination, you are more likely to find issues, and you can validate that your site meets accessibility standards. -JAWS is the market leader in screen readers. JAWS includes features that can improve the accessibility of some websites that aren't as accessible in other screen readers. Therefore, testing in JAWS might not ensure that your site meets all accessibility requirements. +JAWS is the market leader in screen readers. JAWS includes features that can improve the accessibility of some websites that aren't as accessible in other screen readers. Therefore, testing in JAWS might not ensure that your site meets all accessibility requirements.   You might also want to test for whatever combination of browser and screen reader has the greatest market share for your website. @@ -45,13 +44,6 @@ Each control is a tab stop. Within a control, the following rules apply: - For modal surfaces, the last tab stop should be the commit actions. - For lists, the first tab stop should be the first item in the list, the next should be the commands, and then the navigation, settings, and so on. - ![Image that shows the tab stops on a SharePoint page](../images/accessibility-illustration-04.png) ### Navigation within a control @@ -92,7 +84,7 @@ Users who have vision impairments rely on screen readers to navigate the site UI ## Alt text and transcripts -Use alt text to provide descriptions of images that can be consumed by screen readers. This is useful for vision-impaired users who cannot consume information visually. Make sure that your alt text is descriptive, keeping in mind that some readers are relying on a screen reader to access the information conveyed in the image. +Use alt text to provide descriptions of images that can be consumed by screen readers. This is useful for users who have visual impairments who cannot consume information visually. Make sure that your alt text is descriptive, keeping in mind that some readers are relying on a screen reader to access the information conveyed in the image. Don't rely only on color to convey meaning; rely on both color and shape. @@ -100,9 +92,9 @@ To be fully compliant with accessibility standards, include alt text and a compl ## Minimum readable contrast -A minimum level of contrast is essential to help users with vision impairments consume the content on the page. It is also important to aid readability in low light and glare situations. +A minimum level of contrast is essential to help users who have visual impairments consume the content on the page. It is also important to aid readability in low light and glare situations. -The following image shows theme colors on the left and neutral colors on the right. +The following image shows theme colors on the left and neutral colors on the right. ![Neutral and Theme colors for minimum readable contrast](../images/themes-colors-blue-neutral-theme-2.png) @@ -162,19 +154,14 @@ The following image shows theme colors on the left and neutral colors on the rig
- ## High contrast Use high contrast colors as a guide for color choices for components and states on the web. Windows computers only have the ability to detect whether a PC is running high contrast or high contrast white. For this reason, use the default high contrast black setting for any high contrast, non-white theme. ![High contrast black and high contrast white settings](../images/accessibility-illustration-14.png) - ## See also - [SharePoint themes and colors](themes-colors.md) - [Design a web part](design-a-web-part.md) - [Designing great SharePoint experiences](design-guidance-overview.md) - - - diff --git a/docs/design/authoring-pages.md b/docs/design/authoring-pages.md index 6264e6fe5..49002ad83 100644 --- a/docs/design/authoring-pages.md +++ b/docs/design/authoring-pages.md @@ -1,62 +1,48 @@ --- title: Authoring pages in a SharePoint site description: Author pages using Edit mode, Published mode, and consider the mobile view. -ms.date: 1/23/2018 -localization_priority: Priority +ms.date: 03/08/2023 +ms.localizationpriority: high --- # Authoring pages in a SharePoint site -Authoring pages in SharePoint is a simple process, but it does require some familiarity with the SharePoint environment, as well as an understanding of what and who you are designing the page for. A few basic principles, such as remembering to "Start simple" and "Build on what's working," are valuable things to consider as you start authoring. It's also a good idea to consistently remind yourself of your audience and the goals that you are trying to help them achieve. +Authoring pages in SharePoint is a simple process, but it does require some familiarity with the SharePoint environment, and an understanding of what and who you are designing the page for. A few basic principles, such as remembering to "Start simple" and "Build on what's working," are valuable things to consider as you start authoring. It's also a good idea to consistently remind yourself of your audience and the goals that you're trying to help them achieve. - - -The SharePoint page authoring experience has two modes: +The SharePoint page authoring experience has two modes: - **Edit**. Allows page authors to add and configure web parts to add content to a page. -- **Published**. Allows your team or audience to view content and interact with web parts. +- **Published**. Allows your team or audience to view content and interact with web parts. ## Edit mode -When creating a new page, users have access to the authoring UI to add content to and customize the page content. - -Edit control - -
+When creating a new page, users have access to the authoring UI to add content to and customize the page content. -Edit control with cursor showing highlight +![Edit control](../images/design-authoring-edit-01.png) -
+![Edit control with cursor showing highlight](../images/design-authoring-edit-02.png) ### Add hint and Toolbox The add hint is a horizontal line with a plus icon that is visible when a web part is selected and on hover to indicate where page authors can add new web parts to their page. The Toolbox opens when a user selects the plus icon. The Toolbox contains all the web parts that can be added to a page. -Hint and toolbox showing tools - -
+![Hint and toolbox showing tools](../images/design-authoring-add-hint.png) ### Toolbar -A vertical toolbar and bounding box is part of the framework for every web part and is provided by the page. Each web part has an edit and delete action in the toolbar. - -Expanded toolbar +A vertical toolbar and bounding box is part of the framework for every web part and is provided by the page. Each web part has an edit and delete action in the toolbar. -
+![Expanded toolbar](../images/design-authoring-toolbar.png) ### Active and hover states On hover/active, the hint bars are primary blue or the primary theme color for the site. -Hover and active state - -
+![Hover and active state](../images/design-authoring-active-hover-01.png) The bounding box for a web part is gray by default, but picks up the primary blue or primary theme color for the site on hover or when the web part is selected. -Bounding box on and off - -
+![Bounding box on and off](../images/design-authoring-active-hover-02.png) ### Contextual edits @@ -64,35 +50,27 @@ Design a WYSIWYG experience for web parts so that users can fill in information ![Contextual edits form element](../images/design-authoring-contextual-edits.png) -
- ### Item-level edits UI can change within the web part; for example, text can become a text field, or you can display UI to reorder items or to check off tasks in a web part. You can enable interactive functionality for web parts in edit mode, in read mode, or in both, depending on your design intent. ![Item level editing with selected state](../images/design-authoring-item-level.png) -
- ### Property panes -Property panes are invoked via the **Edit** icon on the toolbar. Property panes should primarily contain configuration settings that enable or disable features that either show on the page, or make a call to a service to display content. +Property panes are invoked via the **Edit** icon on the toolbar. Property panes should primarily contain configuration settings that enable or disable features that either show on the page, or make a call to a service to display content. ![Expanded pane](../images/design-authoring-panes.png) -
- ## Published mode After the page is published, all editing UI is disabled for the viewer or reader of the page. To continue editing the page, the user selects the **Edit** button on the top right corner of the command bar. ![Publish button highlighted](../images/design-authoring-published.png) -
- ## Mobile view -All SharePoint pages are [responsive](grid-and-responsive-design.md) to allow the content of the page to be viewed on mobile devices. While designing a web part, it is important to understand how the new SharePoint site pages render across different devices. +All SharePoint pages are [responsive](grid-and-responsive-design.md) to allow the content of the page to be viewed on mobile devices. While designing a web part, it's important to understand how the new SharePoint site pages render across different devices. ![Mobile view of site](../images/design-authoring-mobile.png) diff --git a/docs/design/design-a-web-part.md b/docs/design/design-a-web-part.md index a7671229f..72c3a4bc6 100644 --- a/docs/design/design-a-web-part.md +++ b/docs/design/design-a-web-part.md @@ -1,8 +1,8 @@ --- title: Designing a SharePoint web part description: Use three types of property panes to design and develop web parts that fit your business or customer needs. -ms.date: 01/23/2018 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # Designing a SharePoint web part @@ -57,7 +57,7 @@ Use accordion panes when you need to apply categorization for a complex web part ### Steps pane -Use a steps pane to group properties in multiple steps or pages when you need the web part to be configured in a linear order, or when choices in the first step affect the options that display in the second or third step. +Use a steps pane to group properties in multiple steps or pages when you need the web part to be configured in a linear order, or when choices in the first step affect the options that display in the second or third step. **Step 1 of the steps pane** @@ -67,7 +67,7 @@ In step 1, the back button is disabled and the next button is enabled.
-**Step 2 of the steps pane** +**Step 2 of the steps pane** In step 2, the back and next buttons are enabled. @@ -75,7 +75,7 @@ In step 2, the back and next buttons are enabled.
-**Step 3 of the steps pane** +**Step 3 of the steps pane** In step 3, the next button is disabled and the back button is enabled. @@ -85,5 +85,3 @@ In step 3, the next button is disabled and the back button is enabled. ## See also - [Designing great SharePoint experiences](design-guidance-overview.md) - - diff --git a/docs/design/design-guidance-overview.md b/docs/design/design-guidance-overview.md index 9ff8c935b..1566fe91e 100644 --- a/docs/design/design-guidance-overview.md +++ b/docs/design/design-guidance-overview.md @@ -1,8 +1,8 @@ --- title: Designing great SharePoint experiences description: Create compelling SharePoint experiences and effectively communicate your brand and message to your audience. -ms.date: 1/23/2018 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # Designing great SharePoint experiences @@ -14,7 +14,7 @@ SharePoint is a platform that delivers content to more than 200,000 organization ![SharePoint communication site on multiple devices](../images/design-guidance-overview.png) -## SharePoint design principles +## SharePoint design principles SharePoint builds on the design principles that shape the Office and Microsoft product families. These principles help the design stay true to our product goals and user needs. @@ -38,7 +38,45 @@ We search for what’s possible beyond today’s way of getting things done. We Accessibility is developing an equal experience for all users that enables individuals to adjust their user experience to meet their unique visual, hearing, dexterity, cognitive, and speech needs. SharePoint believes strongly in providing accessible experiences for everyone, everywhere, and in optimizing our experiences to reflect the needs of all of our customers. - + + +## SharePoint Web UI Kit in Figma + +![Screenshot 2024-10-02 134843](https://github.com/user-attachments/assets/c6f4eb87-abf2-48ca-b5f2-f35ee98883c1) + +The SharePoint Web UI Kit empowers you to design communication and team sites for desktop, tablet and mobile in Figma. ​This kit delivers a set of web parts, style options, templates, and detailed guidance so you can quickly design engaging sites and pages in Figma. Figma is a subscription-based application that is the industry standard tool for web design, and provides an alternative to designing sites and pages outside of SharePoint. + +[Access the kit in Figma Community](https://aka.ms/SPWebUIkit) + +[Watch a live demo on YouTube with the product team](https://youtu.be/2UPchEYhuxI?si=x8ZWEBe3YZQL3Dkp) + +### Design without organizational limitations + +This UI kit provides SharePoint users with another tool in their toolbox. While building a page in SharePoint is easy, we wanted to provide the ability to mockup sites and pages. It allows you to explore different design options for your site without the limitation of admin privileges and tenant restrictions, and doesn’t expose organization data. + +Figma mockups provide a quick snapshot of SharePoint updates which business stakeholders can use to plan and make decisions. They can provide appropriate requirements and use this UI kit in collaboration with their design team to iterate in the life cycle of your organization's intranet. + +### Share designs with ease + +This UI kit provides you with page layouts and a selection of web parts to allow you to mockup and share new ideas across organizations and companies. Figma gives you the flexibility of reviewing and sharing your designs without having to spend time and resources creating it in SharePoint. Figma also allows you to download your designs into easy-to-use formats that can be used in documentation and presentations. Learn more at https://www.figma.com/ + +Note that Figma does not build the pages in SharePoint, so once you finalize a design in Figma, you will need to build it in SharePoint. You should evaluate if Figma is the right solution for mocking up sites and pages for SharePoint. + +### Community feedback + +Please tell us what’s missing, what doesn’t work for you, and where your biggest challenges are by leaving a comment on the [Figma SharePoint Web UI kit page](https://aka.ms/SPWebUIkit). + +### Past Tech Community blog posts for each SharePoint Web UI Kit release + +v3.0: [Figma Variables and new components available (v3.0.0) in the SharePoint Web UI Kit](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/figma-variables-and-new-components-available-v3-0-0-in-the/ba-p/4180339) + +v2.2: [SharePoint Web UI Kit - New Figma web part components available (v2.2) and feedback requested](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/sharepoint-web-ui-kit-new-figma-web-part-components-available-v2/ba-p/4031084) + +v2.1: [New web parts available in the SharePoint Web UI kit!](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/new-web-parts-available-in-the-sharepoint-web-ui-kit/ba-p/3956251) + +v2.0: [Updated content for the SharePoint Web UI kit!](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/updated-content-for-the-sharepoint-web-ui-kit/ba-p/3905250) + +v1.0: [Introducing a new SharePoint Web UI kit!](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/introducing-a-new-sharepoint-web-ui-kit/ba-p/3870293) ## See also diff --git a/docs/design/designing-a-web-part-icon.md b/docs/design/designing-a-web-part-icon.md index 9b784b9ce..fd9b128ae 100644 --- a/docs/design/designing-a-web-part-icon.md +++ b/docs/design/designing-a-web-part-icon.md @@ -1,8 +1,8 @@ --- title: Designing a web part icon description: Learn how to design a web part icon that will look great in SharePoint. -ms.date: 08/24/2018 -localization_priority: Normal +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # Designing a SharePoint web part icon @@ -13,13 +13,13 @@ Web part icons are designed to be simple, representative, and symbolic. Every ic ## Grid keyline shapes -Web part icons are displayed at 32x32 px but are designed at twice the size, or 64x64 px. Create icons at 100% to ensure that pixels are accurate. +Web part icons are displayed at 32x32 px but are designed at twice the size, or 64x64 px. Create icons at 100% to ensure that pixels are accurate. ![Web part icon grid](../images/02_Icons_sizes.png) ## Layout -Design icons within the 64x64 px container area. This ensures that the icon renders correctly. +Design icons within the 64x64 px container area. This ensures that the icon renders correctly. ![Grid example for web part icons at 64px](../images/03_Icons_Layout.png) @@ -32,7 +32,7 @@ Not all icons or logos are designed in a perfect square. Use this guide of basic ## Pixel clarity -Try to avoid any icon distortion by snapping your edges to the X and Y coordinates. Use whole numbers when possible. +Try to avoid any icon distortion by snapping your edges to the X and Y coordinates. Use whole numbers when possible. ![Example of an icon that is not aligned to the pixel and one that is](../images/05_Icons_pixel_clarity.png) @@ -49,4 +49,3 @@ Web part icons can contain one color or be full color. Most icons work best when Export icons as SVGs at 64x64 px with transparent backgrounds. You can find the icon grid in the [SharePoint Design toolkit](https://developer.microsoft.com/fabric#/resources). - diff --git a/docs/design/empty-states.md b/docs/design/empty-states.md index 25217f409..dc78df4c2 100644 --- a/docs/design/empty-states.md +++ b/docs/design/empty-states.md @@ -1,13 +1,13 @@ --- title: Empty states for web parts description: The empty state is a visual representation of a web part, pre-configured to a content source like a list or with placeholder content, such as images and text. -ms.date: 4/16/2018 -localization_priority: Normal +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # Empty state of a web part -The empty state is a visual representation of a web part, pre-configured to a content source like a list or with placeholder content, such as images and text. +The empty state is a visual representation of a web part, pre-configured to a content source like a list or with placeholder content, such as images and text. The following web parts have a content source set by default but no content to show for a newly created Communication site (that is, they feature an empty state): @@ -18,7 +18,7 @@ The following web parts have a content source set by default but no content to s - Hero - Image gallery -Empty states are designed to convey the purpose, structure, and layout options of web parts before the web part is configured or content is added. The empty state is also a perfect way to illustrate the vertical rhythm and layout of a page that starts from a template. Empty states behave similarly to fully configured web parts, and reflow to accommodate available space. They should support author-configured web part layouts. +Empty states are designed to convey the purpose, structure, and layout options of web parts before the web part is configured or content is added. The empty state is also a perfect way to illustrate the vertical rhythm and layout of a page that starts from a template. Empty states behave similarly to fully configured web parts, and reflow to accommodate available space. They should support author-configured web part layouts. ![Image that shows sample web part empty states](../images/empty_state_template_01.png) @@ -26,9 +26,9 @@ Empty states are different from placeholders in that the latter are meant to be ## Empty state and editing rights -Web parts with empty states can change interaction options and display text depending on the permission level and mode of the page. +Web parts with empty states can change interaction options and display text depending on the permission level and mode of the page. -In the following example (left to right), a person with editing rights sees an empty state of the Events web part in Edit and Read modes. The last image shows a simplified empty state view for page readers that have no editing rights, with a message appropriate to their permission level. +In the following example (left to right), a person with editing rights sees an empty state of the Events web part in Edit and Read modes. The last image shows a simplified empty state view for page readers that have no editing rights, with a message appropriate to their permission level. ![Author amd reader empty states](../images/empty_state_events_02.png) @@ -38,7 +38,7 @@ The following are layout options for the Events web part in an empty state. ## Interactions with an empty state -Empty states are designed primarily for people with editing rights and change interaction options based on the current page mode. Authors can manually add content to web parts in the Read mode, such as adding a new event or new news post. +Empty states are designed primarily for people with editing rights and change interaction options based on the current page mode. Authors can manually add content to web parts in the Read mode, such as adding a new event or new news post. The following example shows an empty state with multiple items stacked vertically, where the first item acts as a call to action (CTA) to learn more or create an event. diff --git a/docs/design/grid-and-responsive-design.md b/docs/design/grid-and-responsive-design.md index 9aba73a1d..7e12fd385 100644 --- a/docs/design/grid-and-responsive-design.md +++ b/docs/design/grid-and-responsive-design.md @@ -1,85 +1,72 @@ --- title: SharePoint grid and responsive design -description: The underlying page grid system and the breakpoints, or key screen sizes where the layout of the pages will change. -ms.date: 01/23/2018 -localization_priority: Priority +description: The underlying page grid system and the breakpoints, or key screen sizes where the layout of the pages will change. +ms.date: 06/28/2022 +ms.localizationpriority: high --- # SharePoint grid and responsive design - -Responsive experiences seamlessly scale across devices to better display your content on a range of different screen sizes. Responsive design also eliminates the need to build multiple versions of your site pages to support different devices. -The design guidance for responsive pages in the SharePoint authoring environment incorporates a responsive grid system that is based on [Office UI Fabric](https://developer.microsoft.com/fabric). This article describes the underlying page grid system and the breakpoints, or key screen sizes where the layout of the pages will change. +Responsive experiences seamlessly scale across devices to better display your content on a range of different screen sizes. Responsive design also eliminates the need to build multiple versions of your site pages to support different devices. +The design guidance for responsive pages in the SharePoint authoring environment incorporates a responsive grid system that is based on [Office UI Fabric](https://developer.microsoft.com/fabric). This article describes the underlying page grid system and the breakpoints, or key screen sizes where the layout of the pages will change. ![SharePoint page on multiple devices](../images/design-grid-responsive-overview.png) +## Page type grids - -## Page type grids - -Each page type in the SharePoint authoring experience can have its own rules for how it applies the Fabric responsive grid. This is to ensure that each page looks great, regardless of what device it's designed for, and that the experience is optimized for that environment. The basic grid in the SharePoint desktop experiences is a 12-column structure. The number of columns and gutter width adjust based on the screen width. +Each page type in the SharePoint authoring experience can have its own rules for how it applies the Fabric responsive grid. This is to ensure that each page looks great, regardless of what device it's designed for, and that the experience is optimized for that environment. The basic grid in the SharePoint desktop experiences is a 12-column structure. The number of columns and gutter width adjust based on the screen width. The following sections show the basic grid structure applied across different types of SharePoint pages, to help you better understand how the grid adjusts to support the experience and device needs. - ![Twelve column grid diagram](../images/design-grid_diagram.png) -
- ### Team sites The content area for a team site is locked to the left. Team sites have a left navigation; therefore, the space that web parts occupy on the grid and the reflow behavior respects the space given to the navigation. The max width of the content area of a Team site is 1204 px and the minimum size is 320 px for mobile support. ![Team site](../images/design-grid-team-site.png) -
- The following examples show how the grid adjusts between key breakpoints on a team site. #### Small 320 x 568 + The small size has a single centered column area, with 20 px margins left and right. ![Team site small grid](../images/design-grid-Team-site-S-Canvas-no-column.png) -
- #### Medium 480 x 854 + The medium size has 12 columns, with 16 px gutters. ![Team site medium grid](../images/design-grid-Team-site-M-Canvas-16px-gutters.png) -
- #### Large 640 x 1024 + The large size has 12 columns, with 24 px gutters. ![Team site large grid](../images/design-grid-Team-site-L-Canvas-24px-gutters.png) -
- #### XL 1024 x 768 + The XL size has 12 columns, with 24 px gutters. ![Team site XL grid](../images/design-grid-Team-site-XL-Canvas-24px-gutters.png) -
- #### XXL 1366 x 768 + The XXL size has 12 columns, with 32 px gutters. ![Team site XXL grid](../images/design-grid-Team-site-XXL-Canvas-32px-gutters.png) -
- #### XXXL 1920 x 1080 + The XXXL size has 12 columns, with 32 px gutters. ![Team site XXXL grid](../images/design-grid-Team-site-XXXL-Canvas-32px-gutters-maxwidth-1204.png) -
- #### Team site multicolumn pages and web parts + Web parts scale horizontally depending on the page layout. The following example shows how the size of a web part adjusts to accommodate the left navigation. ![Team site multicolumn page with web parts](../images/design-grid-Team-site-web-parts.png) @@ -91,75 +78,64 @@ Communication sites have a top navigation and a centered content area. The maxim ![Communication site](../images/design-grid-communication_site.png) -
- The following examples show how the grid adjusts between key breakpoints on a communication site. #### Small 320 x 568 + The small size has a single centered column area, with 20 px margins left and right. ![Communication site small grid](../images/design-grid-Communication-site-S-Canvas-no-column.png) -
- #### Medium 480 x 854 + The medium size has 12 columns, with 16 px gutters. ![Communication site medium grid](../images/design-grid-Communication-site-M-Canvas-16px-gutters.png) -
- #### Large 640 x 1024 + The large size has 12 columns, with 24 px gutters. ![Communication site large grid](../images/design-grid-Communication-site-L-Canvas-24px-gutters.png) -
- #### XL 1024 x 768 + The XL size has 12 columns, with 24 px gutters. ![Communication site XL grid](../images/design-grid-Communication-site-XL-Canvas-24px-gutters.png) -
- #### XXL 1366 x 768 + The XXL size has 12 columns, with 32 px gutters. ![Communication site XXL grid](../images/design-grid-Communication-site-XXL-Canvas-32px-gutters-maxwidth-1204.png) -
- #### XXXL 1920 x 1080 + The XXXL size has 12 columns, with 32 px gutters. ![Communication site XXXL grid](../images/design-grid-Communication-site-XXXL-Canvas-32px-gutters-maxwidth-1204.png) -
- #### Communication site multicolumn pages and web parts + Web parts scale horizontally depending on the page layout. This example shows a communication site and web parts for single to three column layouts. ![Communication site multi-column with web parts](../images/design-grid-Communciation-site-web-parts.png) +## Breakpoints - -## Breakpoints - -To create a smooth flowing experience between screen sizes, the SharePoint UI should adapt layouts for the following breakpoint widths: +To create a smooth flowing experience between screen sizes, the SharePoint UI should adapt layouts for the following breakpoint widths: - 320 px - 1024 px - 1366 px - 1920 px - + Within these breakpoints, you should take into consideration how your content shifts when the viewport size becomes optimized for the nearest breakpoint. Note that this diagram is for illustration only and is not pixel accurate. ![SharePoint diagram showing breakpoints](../images/design-grid-breakpoints.png) -
- The responsive grid for both team sites and communication sites adjusts when going from large breakpoints to mobile breakpoints. This optimizes the site for the device and screen size. The following table describes the grid sizes at various breakpoints based on popular device sizes. @@ -176,11 +152,7 @@ The responsive grid for both team sites and communication sites adjusts when goi | 1600 | Web 1600x900 | XX-Large | 12 | 32 | 3 | | 1920 | Web 1920x1080 | XXX-Large | 12 | 32 | 3 | -
- ## See also - [Design toolkit and assets](https://developer.microsoft.com/fabric#/resources) - [Designing great SharePoint experiences](design-guidance-overview.md) - - diff --git a/docs/design/key-web-part-examples.md b/docs/design/key-web-part-examples.md index ab599f1db..e1ba4a44b 100644 --- a/docs/design/key-web-part-examples.md +++ b/docs/design/key-web-part-examples.md @@ -1,15 +1,15 @@ --- title: Key web part examples -description: A visual overview of Communication site and Team site templates. -ms.date: 5/08/2018 -localization_priority: Priority +description: A visual overview of Communication site and Team site templates. +ms.date: 06/28/2022 +ms.localizationpriority: high --- # Key web part examples -Web parts are the building blocks of your page. +Web parts are the building blocks of your page. -This is a visual overview of Communication site and Team site templates, highlighting how web parts work together to create a coherent overall design. Use these pages as reference when designing a SharePoint web part. +This is a visual overview of Communication site and Team site templates, highlighting how web parts work together to create a coherent overall design. Use these pages as reference when designing a SharePoint web part. It is important to consider how the web part will look and function when sitting next to other web parts on a page. Follow the patterns in this documentation and on the [Office UI Fabric site](https://developer.microsoft.com/fabric) to ensure consistency in layout and grid alignment, font size and hierarchy, commanding, empty states, and more. @@ -19,22 +19,20 @@ It is important to consider how the web part will look and function when sitting The Topic design is used when you have a lot of information to share, such as news, events, reports, and other content. It is built from the Hero, News, Events, Highlighted content, Quick links, and People web parts. -![Topic site homepage](../images/sites_topic.png) +![Topic site homepage](../images/sites_topic.png) ### Showcase design The Showcase design is used to feature a product, team, or event. It leverages the Hero and Image gallery web parts to show rich visual content. -![Showcase site homepage](../images/sites_showcase.png) +![Showcase site homepage](../images/sites_showcase.png) ## Team sites The Team site design is the default layout for any new team. It features the News, Quick links, Highlighted content, and Document library web parts. -![Team site homepage](../images/sites_teamsite.png) +![Team site homepage](../images/sites_teamsite.png) These example site and web part designs have been added to the SharePoint toolkit and can be used as reference when designing web parts. For more information, see the [SharePoint toolkit](https://developer.microsoft.com/fabric#/resources). - - diff --git a/docs/design/layout-patterns.md b/docs/design/layout-patterns.md index 699db6cc8..0d8891ca4 100644 --- a/docs/design/layout-patterns.md +++ b/docs/design/layout-patterns.md @@ -1,13 +1,13 @@ --- title: Layout patterns description: Find common SharePoint web part layout types and responsive patterns. -ms.date: 08/24/2018 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # SharePoint web part layouts -SharePoint uses a number of different layout types for web parts. The most common are grid, list, filmstrip, carousel, and compact. Each one of these five layouts serves a different purpose, depending on the layout, breakpoints, and content density of a page. +SharePoint uses a number of different layout types for web parts. The most common are grid, list, filmstrip, carousel, and compact. Each one of these five layouts serves a different purpose, depending on the layout, breakpoints, and content density of a page. When selecting a layout that works best for your web part, consider the type of content you are displaying. Is it highly visual or rich in text and data? Determine how much space is needed on the page for enough content to be displayed. Consider shortening long descriptions to optimize for displaying more items to the user. Remember that you can use the [property pane](reactive-and-nonreactive-web-parts.md) to let authors have control over how much content is displayed. diff --git a/docs/design/placeholders-and-fallbacks.md b/docs/design/placeholders-and-fallbacks.md index 41140447f..5354450c2 100644 --- a/docs/design/placeholders-and-fallbacks.md +++ b/docs/design/placeholders-and-fallbacks.md @@ -1,14 +1,14 @@ --- title: Placeholders and fallbacks in SharePoint web parts description: Add placeholders to SharePoint web parts as a fallback if an issue occurs loading content or data. -ms.date: 01/23/2018 -localization_priority: Normal +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # Placeholders and fallbacks in SharePoint web parts -You can add placeholders to SharePoint web parts that can also be used as a fallback if an issue occurs loading content or data for a web part. The web part name and description are automatically added from the metadata submitted with the web part. +You can add placeholders to SharePoint web parts that can also be used as a fallback if an issue occurs loading content or data for a web part. The web part name and description are automatically added from the metadata submitted with the web part. You can add a button that users can select to return to a state where they can configure the web part. diff --git a/docs/design/reactive-and-nonreactive-web-parts.md b/docs/design/reactive-and-nonreactive-web-parts.md index 87a981c83..38935ba67 100644 --- a/docs/design/reactive-and-nonreactive-web-parts.md +++ b/docs/design/reactive-and-nonreactive-web-parts.md @@ -1,47 +1,41 @@ --- title: Reactive and nonreactive SharePoint web parts description: Reactive web parts are client-side only; nonreactive web parts have elements that require a server to operate. -ms.date: 01/23/2018 -localization_priority: Priority +ms.date: 03/08/2023 +ms.localizationpriority: high --- # Reactive and nonreactive SharePoint web parts Reactive web parts are client-side only; nonreactive web parts have elements that require a server to operate. We recommend that you build your SharePoint web parts to be reactive because that best fits the UX model and WYSIWYG principles for authoring. However, it might not be possible or cost-effective in all cases to build reactive web parts. - ## Reactive web parts Reactive web parts are fully client-side web parts. This means that each component configured in the property pane reflects the change made within the web part on the page. For example, for the To-Do List web part, unchecking “Completed Tasks” hides this view in the web part. -A reactive web part +![A reactive web part](../images/design-reactive-01.png) ## Nonreactive web parts -Nonreactive web parts are not fully client-side; generally, one or more properties need to make a call to set/pull or store data on a server. For nonreactive web parts, you should enable the **Apply** button at the bottom of the property pane. -You can also customize the **Apply** button to be a more specific action. +Nonreactive web parts aren't fully client-side; generally, one or more properties need to make a call to set/pull or store data on a server. For nonreactive web parts, you should enable the **Apply** button at the bottom of the property pane. -A nonreactive web part with Apply and Cancel buttons +You can also customize the **Apply** button to be a more specific action. -
+![A nonreactive web part with Apply and Cancel buttons](../images/design-reactive-02.png) The following examples show nonreactive web parts in the context of the [three property pane structures](design-a-web-part.md). -**Single pane example** - -A nonreactive web part with a single pane property structure - -
+### Single pane example -**Accordion groups example** +![A nonreactive web part with a single pane property structure](../images/design-reactive-03.png) -A nonreactive web part with an according groups pane property structure +### Accordion groups example -
+![A nonreactive web part with an according groups pane property structure](../images/design-reactive-04.png) -**Steps pane example** +### Steps pane example -A nonreactive web part with a steps pane property structure +![A nonreactive web part with a steps pane property structure](../images/design-reactive-05.png) ## See also diff --git a/docs/design/semantic_slots.md b/docs/design/semantic_slots.md index 9232056f5..a6e5632b2 100644 --- a/docs/design/semantic_slots.md +++ b/docs/design/semantic_slots.md @@ -1,8 +1,8 @@ --- title: Designing for section backgrounds using semantic slots description: Learn how to design your web part to take advantage of section backgrounds using semantic slots. -ms.date: 05/18/2021 -localization_priority: Normal +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # Designing for section backgrounds using semantic slots @@ -15,7 +15,7 @@ Section background is a feature that applies background color to a canvas secti ## Variant vs. Section background -A variant describes different values of color generated from an existing theme. A variant will share the same set of colors as the original theme it was generated from, but will apply those colors differently. See [Office UI Fabric variant documentation](https://github.com/OfficeDev/office-ui-fabric-react/blob/master/packages/variants/README.md) for more detail. +A variant describes different values of color generated from an existing theme. A variant will share the same set of colors as the original theme it was generated from, but will apply those colors differently. See [@fluentui/scheme-utilities](https://github.com/microsoft/fluentui/blob/master/packages/scheme-utilities/README.md) for more detail. A Section Background allows the user to apply a variant color from the theme to a canvas section. Both concepts share "Neutral", "Soft", and "Strong" options and can be used interchangeably when describing color usage. @@ -25,46 +25,23 @@ A semantic slot is a theming slot that targets specific page elements. A Offic For example, default text uses the "bodyText" semantic slot. On the None, Neutral, and Soft section backgrounds, bodyText is assigned neutralPrimary. On the Strong section background, the palette color of bodyText changes to white. Semantic slots can be assigned palette colors for all variants in dark themes as well. -In the table below, you can see all eight palette colors defined for the bodyText slot. +In the table below, you can see all eight palette colors defined for the bodyText slot. ![Example table showing semantic slots on light and dark theme variants](../images/doc-semantic-slot-940px-table.png) -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Light themes Dark themes
NoneneutralPrimary #333333neutralPrimary #ffffff
NeutralneutralPrimary #333333neutralPrimary #ffffff
SoftneutralPrimary #333333neutralPrimary #ffffff
Strongwhite #ffffffwhite #1f1f1f
-
+| Weight | Light themes | Dark themes | +| ------- | ---------------------- | ---------------------- | +| None | neutralPrimary #333333 | neutralPrimary #ffffff | +| Neutral | neutralPrimary #333333 | neutralPrimary #ffffff | +| Soft | neutralPrimary #333333 | neutralPrimary #ffffff | +| Strong | white #ffffff | white #ffffff | > [!NOTE] > The current semantic slot list is defined by commonly used design patterns in SharePoint. We want to avoid creating case-specific semantic slots. When designing a new web part, consider aligning to an existing design pattern. Office UI Fabric's policy is that semantic slots may never be removed from the list, so any additions are permanent. ## Identifying semantic slots in your designs -Semantic slots should be assigned based on the function of a page element. The name of a semantic slot can quickly tell you how it’s meant to be used. You can find all existing semantic slots and their use case examples in the [Fabric semantic colors documentation](/fluentui#/styles/web/colors/theme-slots). +Semantic slots should be assigned based on the function of a page element. The name of a semantic slot can quickly tell you how it’s meant to be used. You can find all existing semantic slots and their use case examples in the [Fabric semantic colors documentation](https://developer.microsoft.com/fluentui#/styles/web/colors/theme-slots). Fabric palette colors should be referenced from your site theme’s color ramp. If your site is using a SharePoint out of the box theme, you can reference [SharePoint theme color ramps](https://fluentfabric.azurewebsites.net/#/color/products). If your site is using a custom theme, you can generate a unique color ramp using the [Fluent UI Theme Designer](https://aka.ms/themedesigner). diff --git a/docs/design/showcase-web-part.md b/docs/design/showcase-web-part.md index ce8eb74f0..09965c263 100644 --- a/docs/design/showcase-web-part.md +++ b/docs/design/showcase-web-part.md @@ -1,86 +1,61 @@ --- title: "SharePoint web part design showcase: Create a To-Do list property pane" description: Create a To-Do list web part that uses a single pane and is reactive. -ms.date: 01/23/2018 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # SharePoint web part design showcase: Create a To-Do list property pane This article describes how to create a To-Do list web part. This example uses the single pane [property pane type](design-a-web-part.md) and is [reactive](reactive-and-nonreactive-web-parts.md) and based on the [Office UI Fabric](https://developer.microsoft.com/fabric) responsive grid. - ## Create a To-Do list web part 1. Add a description to help users understand more about the web part and its properties. - In this example, the description is "Select a source for your to-dos and customize the display for the list of tasks." - - ![Adding a description](../images/design-showcase-01.png) - -
- -2. Add a Fabric [drop-down component](https://developer.microsoft.com/fabric#/components/dropdown) connected to a list. - - ![Adding a Fabric dropdown](../images/design-showcase-02.png) - -
- -3. Add a Fabric [checkbox component](https://developer.microsoft.com/fabric#/components/checkbox) to display completed tasks. - - ![Adding a Fabric check box](../images/design-showcase-03.png) - -
+ In this example, the description is "Select a source for your to-dos and customize the display for the list of tasks." -4. Add two more check boxes to control display options. + ![Adding a description](../images/design-showcase-01.png) - ![Adding two more Fabric check boxes](../images/design-showcase-04.png) +1. Add a Fabric [drop-down component](https://developer.microsoft.com/fabric#/components/dropdown) connected to a list. -
+ ![Adding a Fabric dropdown](../images/design-showcase-02.png) -5. Add a Fabric [slider](https://developer.microsoft.com/fabric#/components/slider) for the maximum number of items to display. +1. Add a Fabric [checkbox component](https://developer.microsoft.com/fabric#/components/checkbox) to display completed tasks. - ![Adding a Fabric slider](../images/design-showcase-05.png) + ![Adding a Fabric check box](../images/design-showcase-03.png) -
+1. Add two more check boxes to control display options. -6. Next, the author of the page selects a list or manually adds tasks to prepopulate the To-Do list web part. + ![Adding two more Fabric check boxes](../images/design-showcase-04.png) - ![Select a list in pane](../images/design-showcase-06.png) +1. Add a Fabric [slider](https://developer.microsoft.com/fabric#/components/slider) for the maximum number of items to display. -
+ ![Adding a Fabric slider](../images/design-showcase-05.png) - ![Select a list in pane expanded](../images/design-showcase-07.png) +1. Next, the author of the page selects a list or manually adds tasks to prepopulate the To-Do list web part. -
+ ![Select a list in pane](../images/design-showcase-06.png) - ![Manual addition of tasks to list](../images/design-showcase-08.png) + ![Select a list in pane expanded](../images/design-showcase-07.png) -
+ ![Manual addition of tasks to list](../images/design-showcase-08.png) -7. The web part shows an indicator of items loading onto the page. +1. The web part shows an indicator of items loading onto the page. - ![Indicator of items](../images/design-showcase-09.png) + ![Indicator of items](../images/design-showcase-09.png) -
+1. Items from the list load. -8. Items from the list load. + ![List items loading](../images/design-showcase-10.png) - ![List items loading](../images/design-showcase-10.png) + When the new tasks are loaded, they fade into view by using animation components from Office UI Fabric. -
+ ![New tasks loaded](../images/design-showcase-11.png) - When the new tasks are loaded, they fade into view by using animation components from Office UI Fabric. +1. The property pane controls the UI. Tasks with pivots enabled are displayed via the Display check boxes in the property pane. - ![New tasks loaded](../images/design-showcase-11.png) - -
- -9. The property pane controls the UI. Tasks with pivots enabled are displayed via the Display check boxes in the property pane. - - ![Property pane controlling web part items](../images/design-showcase-12.png) - -
+ ![Property pane controlling web part items](../images/design-showcase-12.png) ## Responsive views @@ -88,20 +63,14 @@ The following example shows the 2/3 column view of the web part. ![Two thirds column view](../images/design-showcase-13.png) -
- The following example shows the 1/3 column view of the web part. ![One third column view](../images/design-showcase-14.png) -
- The following example shows the mobile (read-only) view of the web part. ![Mobile view of the to-do list web part](../images/design-showcase-15.png) -
- ## See also - [Designing great SharePoint experiences](design-guidance-overview.md) diff --git a/docs/design/themes-colors.md b/docs/design/themes-colors.md index e8dfac7c5..d2eee4ec8 100644 --- a/docs/design/themes-colors.md +++ b/docs/design/themes-colors.md @@ -1,8 +1,8 @@ --- title: SharePoint themes and colors description: Design principles that help form the current SharePoint themes and color palette. -ms.date: 05/21/2018 -localization_priority: Priority +ms.date: 09/04/2024 +ms.localizationpriority: high --- # SharePoint themes and colors @@ -19,90 +19,13 @@ The SharePoint color palette is now optimized for screens and devices. In additi Neutral colors recede into the background to let our products shine. They allow brand colors to pop when we need to draw attention to content. When coupling neutrals with brand colors, make sure there is suitable contrast between them. -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Neutral greysblack: #000000
neutralDark: #212121
neutralPrimary: #333333
neutralPrimaryAlt: #3c3c3c
neutralSecondary: #666666
neutralTertiary: #a6a6a6
neutralTertiaryAlt: #c8c8c8
neutralQuaternary: #d0d0d0
neutralQuaternaryAlt: #dadada
neutralLight: #eaeaea
neutralLighter: #f4f4f4
neutralLighterAlt: #f8f8f8
white: #ffffff
-
+![Neutral greys](../images/sharepoint-neutralgreys.png) ## Shades and tints After you select a color, light and dark shades of the accent color are created based on HSB values of color luminosity. Web parts and apps can use shade variations to create visual hierarchy and provide an indication of interaction. -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Theme primary colorsthemeDarker: #004578
themeDark: #005a9e
themeDarkAlt: #106ebe
themePrimary: #0078d4
themeSecondary: #2b88d8
themeTertiary: #71afe5
themeLight: #c7e0f4
themeLighter: #deecf9
themeLighterAlt: #eff6fc
- -
- +![Theme primary colors](../images/sharepoint-theme-primary.png) ## Dark themes @@ -110,22 +33,6 @@ SharePoint includes a palette that supports dark themes. The SharePoint-provided ![SharePoint dark theme color palette, Red EF6950, Yellow FFC83D, Green 00b294, Blue 3a96dd, Purple 9c89e9, Grey b1adab](../images/sharepoint-themes-dark.png) -## Principles - -The following design principles helped form the current SharePoint themes and color palette. - -### Guided -Our theming system works at a global level so that updates can be made consistently across each site, allowing users to optimize their websites effortlessly. Our theming system operates in a controlled environment so that successful outcomes can be optimized quickly. - -### Smart and efficient -Our theming system expedites the site creation process by using smart algorithms to generate options that maximize aesthetic choices. - -### Professional -Our themes embody a professional look and feel that ensures coherency and conveys the brand of our enterprise audiences. - -### Accessible -Our built-in accessibility checker ensures universal design at all levels of default themes. For users who decide to customize, we provide helpful guidelines to design for accessibility. - ## See also - [Accessibility](accessibility.md) diff --git a/docs/design/ui-text-for-web-parts.md b/docs/design/ui-text-for-web-parts.md index 9be1c6ec3..5dfd50870 100644 --- a/docs/design/ui-text-for-web-parts.md +++ b/docs/design/ui-text-for-web-parts.md @@ -1,64 +1,56 @@ --- title: UI text guidelines for SharePoint web parts description: Use simple, understandable, and concise UI text to create effective web parts in SharePoint. -ms.date: 01/23/2018 -localization_priority: Normal +ms.date: 03/08/2023 +ms.localizationpriority: medium --- # UI text guidelines for SharePoint web parts - -One aspect of creating effective web parts in SharePoint is to use simple, understandable, and concise UI text. By keeping your message clear and easy to understand, you ensure that customers move through your experiences quickly and can identify the content they are looking for. This article provides guidance for writing UI text for key areas within SharePoint web parts. +One aspect of creating effective web parts in SharePoint is to use simple, understandable, and concise UI text. By keeping your message clear and easy to understand, you ensure that customers move through your experiences quickly and can identify the content they're looking for. This article provides guidance for writing UI text for key areas within SharePoint web parts. ## Capitalization -Use sentence casing (first letter of first word is capitalized, the rest all lowercase) for all UI elements, including buttons, page titles, and control labels. - +Use sentence casing (first letter of first word is capitalized, the rest all lowercase) for all UI elements, including buttons, page titles, and control labels. Always capitalize: - The first word of a new sentence. - The word following a colon in a title or heading. For example, "Step 1: Begin by entering your account information." -- Proper nouns, such as the names of people, cities, and so on. - -An image web part with sentence-style capitalization highlighted +- Proper nouns, such as the names of people, cities, and so on. -
+![Screenshot of an image alternative-text web part with sentence-style capitalization highlighted](../images/design-uitext-01.png) -An image web part with sentence-style capitalization highlighted +![Screenshot of an image gallery add web part with sentence-style capitalization highlighted](../images/design-uitext-02.png) ## Punctuation Follow the basic rules of punctuation to avoid grammatical errors in your experience. The following table provides guidance and reminders about what punctuation to use when, and why. -|Punctuation |Guidance |Example | -|-------------|------------------------------------------------|-----------------| -|Colons (:) | Use colons if you are introducing a list in the web part description.
Don't use colons in UI labels.| Choose one of the following: Cats, Dogs, Quokkas | -|Commas (,) | Use serial commas (including before the word "and"). |I like cats, birds, and dogs. | -|Ellipses (…)| Use ellipses to show truncation and for progress indicator strings.
Don't use ellipses to indicate that the user must make further choices.|Truncation: Last modified by John Armstr…
Progress indicator: Uploading… | -|Periods (.) | Use periods as you normally would for descriptions.
Don't use periods in titles, headings, or labels. Don't use periods for radio button options or check boxes. | Select the content that you want to highlight and how you want it displayed. Use a filter to narrow your selection. | - - +| Punctuation | Guidance | Example | +| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| Colons (:) | Use colons if you're introducing a list in the web part description.
Don't use colons in UI labels. | Choose one of the following: Cats, Dogs, Quokkas | +| Commas (,) | Use serial commas (including before the word "and"). | I like cats, birds, and dogs. | +| Ellipses (…) | Use ellipses to show truncation and for progress indicator strings.
Don't use ellipses to indicate that the user must make further choices. | Truncation: Last modified by John Armstr…
Progress indicator: Uploading… | +| Periods (.) | Use periods as you normally would for descriptions.
Don't use periods in titles, headings, or labels. Don't use periods for radio button options or check boxes. | Select the content that you want to highlight and how you want it displayed. Use a filter to narrow your selection. | ## Voice and tone Crafting the right tone in your product communication is essential to building a strong, lasting relationship with your audience. Try to keep your words crisp and clear, warm and relaxed, and approachable. How you talk to your audience influences how they engage with your site and content, and how much value they derive from it. -**Do:** +### Do -- Use a casual, conversational tone in the UI. -- Use contractions. For example, use "can't" instead of "cannot". +- Use a casual, conversational tone in the UI. +- Use contractions. For example, use "can't" instead of "can't". - Read your UI text out loud to test the tone. Does it sound like everyday language? -- Use simple words. -- Remove technical details if they're not relevant to the user experience. -- Use "Please" only if you are inconveniencing the user. Avoid overuse. -- Use "Sorry" only in error messages in SharePoint that result in serious problems for the customer. +- Use simple words. +- Remove technical details if they're not relevant to the user experience. +- Use "Please" only if you're inconveniencing the user. Avoid overuse. +- Use "Sorry" only in error messages in SharePoint that result in serious problems for the customer. +### Don't -**Don't:** - -- Clutter the UI text with unnecessary repetition. Make every word meaningful. - +- Clutter the UI text with unnecessary repetition. Make every word meaningful. ## Pronouns @@ -66,25 +58,21 @@ Avoid pronouns in UI elements if possible. If you can say something equally well If your design does warrant using pronouns, apply the following guidelines to make sure that you're using them correctly. -**Do:** +### Do - Use second person ("you" or "your") when you're presenting something that belongs to the user. For example, "Your drafts" or "Your images". - Use first person ("me" or "my") for UI in which the user instructs the service to do something. For example, "Alert me when someone responds to my post." - Use "they" or "their" as a singular possessive modifier to avoid awkward "he/she" or "his/her" constructs. Ideally, rewrite the sentence as plural if possible. - Avoid using "them"; instead, use words like "someone" or "people". For example, "Enter a user name and domain to give someone permission to use this PC." -An image showing the correct use of the second person you and the incorrect use of the third person users in the UI - -
+![An image showing the correct use of the second person you and the incorrect use of the third person users in the UI](../images/design-uitext-03.png) -An image showing the correct use of the UI text Select the page you want people to see first +![An image showing the correct use of the UI text Select the page you want people to see first](../images/design-uitext-04.png) -**Don't:** +### Don't - Use third person references, as they sound impersonal and can create a disconnected customer experience. Instead of saying "Users can change the layout", use a phrase like "You can change the layout". - - ## Error messages Error conditions are inherent in any software or service. Your error messages can affect the overall user satisfaction with the product. A good error message should do the following: @@ -93,50 +81,44 @@ Error conditions are inherent in any software or service. Your error messages ca - Provide a workaround or resolution suggestions. - Show empathy. - - The following is an example of an error message that occurs when a user tries to edit a page that's checked out by another user. - -| You can't edit right now | -|-------------------------------------------------------------------------| +| You can't edit right now | +| ------------------------------------------------------------------------------- | | Another user is currently editing this page. Please try again in a few minutes. | - ## Links to help articles Make an effort to link strategically to help articles. Try to anticipate where the user might need help, and then include a link to the help article close to that UI element. The following are some key things to remember when you place help article links in your UI. -**Do:** - -- Keep the in-product help links specific. Ensure that the target article is appropriate. When the user opens the article, they should be able to locate the information they need. -- Use natural language for your hyperlinks. +### Do - +- Keep the in-product help links specific. Ensure that the target article is appropriate. When the user opens the article, they should be able to locate the information they need. +- Use natural language for your hyperlinks. -**Don’t:** +### Don't - Put a help article link next to every UI element. This results in visual noise. - Include multiple links that go to the same target in the same UI. -- Use "click here" for the text for your hyperlink. +- Use "click here" for the text for your hyperlink. -An image of the More information and examples as the help link text +![An image of the More information and examples as the help link text](../images/design-uitext-05.png) ## Hint text Hint text, or ghost text, is the text element you display in a UI element, typically a text box, to help the user interact with the UI. The hint text gives information about what the user should enter. For example, it might mention field restrictions or show an example. -**Do:** +### Do - Use hint text sparingly, and only if it helps the user. Not all UI elements require hint text. For some complex fields, hint text can help provide more context and clarity. For example, if you have a field that requires the user to enter a secured URL, the hint text https://www.example.com might be more helpful than the text **Enter secure URL here.** -**Don't** +### Don't - Repeat the label. For example, if you have a text box with the label **Name**, the hint text **Enter name** is redundant and potentially confusing. -The following hint text is for the embed web part. The text field can accept a secure website address or an iframe embed code. The text shows an example of both. +The following hint text is for the embed web part. The text field can accept a secure website address or an ` + + +``` + +## Load the document preview dynamically + +If you intend to dynamically load the preview in the same page without leaving it, you might get a CORS error if you attempt to access the Microsoft Graph endpoint directly from a script from your page. + +One way to solve this problem is to create an endpoint in your application that makes the request and returns the url. + +For example, your server-side code should first obtain the document's preview url: + +```csharp +[HttpGet] +[AuthorizeForScopes(Scopes = new string[] { "Files.Read.All" })] +public async Task> GetPreviewUrl(string driveId, string itemId) +{ + // Obtain tokens for the the request + // Use the function created in the first step + return url + "&nb=true"; //Use nb=true to suppress banner +} +``` + +The client-side application can then use the browser's `fetch` API to request and inject the url into the `iframe`: + +```javascript +async function preview(driveId, itemId) { + const url = `/GetPreviewUrl?driveId=${driveId}&itemId=${itemId}`; + const response = await fetch(url, { + credentials: 'include', + }).then(response => response.text()); + + document.getElementById('preview').src = response + "&nb=true"; //Use nb=true to suppress banner +} +``` diff --git a/docs/embedded/development/tutorials/using-webhooks.md b/docs/embedded/development/tutorials/using-webhooks.md new file mode 100644 index 000000000..b0511b294 --- /dev/null +++ b/docs/embedded/development/tutorials/using-webhooks.md @@ -0,0 +1,113 @@ +--- +title: Using Webhooks +description: Use webhooks with SharePoint Embedded. +ms.date: 03/03/2025 +ms.localizationpriority: high +--- + +# Using Webhooks + +## Set Up Webhooks with SharePoint Embedded + +Webhooks are automated messages that are transmitted by an application when a trigger is activated. They can be used in SPE to enable the automation of workflows, the integration of systems, and to respond to events in real-time. + +You'll use webhooks to invoke the Azure Cognitive Services APIs from the application whenever an existing file is updated, or a new file is uploaded. + +To set up webhooks with your [current SharePoint Embedded application](/training/modules/sharepoint-embedded-create-app/), you need to: + +1. Create and register a webhook endpoint to get notifications whenever there's a change in your container. This will be done using REST APIs. +1. Connect to Graph and subscribe to changes. You can expose your application to the internet by either running it locally or deploying it on the cloud. For this tutorial, you'll be employing the former by utilizing ngrok and then subscribing to the changes by making a POST call. +1. Perform any desired action by handling the webhook data. One such use case is covered in [Enabling document processing with Azure Cognitive Services tutorial](./doc-processing-acs.md). + +![using webhooks schema](../../images/Using-Webhooks.png) + +> [!TIP] +> To learn more about the Microsoft Graph APIs used in this tutorial, see [Create subscription](/graph/api/subscription-post-subscriptions). + +## Create and register a webhook + +Open the **index.ts** file and add an endpoint `onReceiptAdded`: + +```typescript +server.post('/api/onReceiptAdded', async (req, res, next) => { + try { + const response = await onReceiptAdded(req, res); + res.send(200, response) + } catch (error: any) { + res.send(500, { message: `Error in API server: ${error.message}` }); + } + next(); +}); +``` + +You also need to add the query parser plugin at the top of this file so that it runs at server startup: + +```typescript +server.use(restify.plugins.bodyParser(), restify.plugins.queryParser()); +``` + +Create **onReceiptAdded.ts** and implement the method `onReceiptAdded` to read `validationToken` and `driveId`. `validationToken` is required when Microsoft Graph makes a one-time call to verify the endpoint upon creation of the webhook subscription. `driveId` is the container-id for which the subscription is created. + +```typescript +require('isomorphic-fetch'); + +export const onReceiptAdded = async (req: Request, res: Response) => { + + const validationToken = req.query['validationToken']; + if (validationToken) { + res.send(200, validationToken, {"Content-Type":"text/plain"}); + return; + } + + const driveId = req.query['driveId']; + if (!driveId) { + res.send(200, "Notification received without driveId, ignoring", {"Content-Type":"text/plain"}); + return; + } + + console.log(`Received driveId: ${driveId}`); + + res.send(200, ""); + return; +} +``` + +## Connect to Graph and subscribe to changes + +Follow the [documentation](https://ngrok.com/docs/getting-started/) to create a tunnel for your backend server using ngrok. + +After starting the app, run the following command in a terminal: + +```powershell +ngrok http 3001 +``` + +On successful completion, you should get the following output. The public-facing endpoint for the app is highlighted in the red rectangle: + +![ngrok registration](../../images/ngrok-registration.png) + +Once the tunneling is active, you can subscribe to delta changes in the container by adding the webhook URL. To do that, open Postman and make the following `POST` request with the appropriate graph access token and `notificationUrl` with the `driveId` appended as a query parameter to ensure that you get notifications for changes only in the desired container. + +```json +POST https://graph.microsoft.com/v1.0/subscriptions +{ + "changeType": "updated", + "notificationUrl":"https://5ac2-2404-f801-8028-3-691a-87b2-d309-545b.ngrok-free.app/api/onReceiptAdded?driveId={{ContainerId}}", + "resource": "drives/{{ContainerId}}/root", + "expirationDateTime": "2024-01-20T03:58:34.088Z", + "clientState": "" +} +``` + +You can use the following code snippet for setting the max possible expiration time of 4230 minutes from the current time by adding this to the "Pre-request Script" section. It will set an environment variable that can be used in the request body. + +```javascript +var now = new Date() +var duration = 1000 * 60 * 4230; // max lifespan of driveItem subscription is 4230 minutes +var expiry = new Date(now.getTime() + duration); +var expiryDateTime = expiry.toISOString(); + +pm.environment.set("ContainerSubscriptionExpiry", expiryDateTime); +``` + +At this point, if you add/update any file in the container, you'll get a notification at the previously added endpoint (`/api/onReceiptAdded`) and a log message at the console: `Received driveId: ` diff --git a/docs/embedded/getting-started/containertypes.md b/docs/embedded/getting-started/containertypes.md new file mode 100644 index 000000000..f21edc78f --- /dev/null +++ b/docs/embedded/getting-started/containertypes.md @@ -0,0 +1,207 @@ +--- +title: Create New SharePoint Embedded Container Types +description: This article explains how Container Types work and the steps to create new Container Types. +ms.date: 03/03/2025 +ms.localizationpriority: high +--- + +# SharePoint Embedded Container Types + +A container type is a SharePoint Embedded resource that defines the relationship, access privileges, and billing accountability between a SharePoint Embedded application and a set of containers. Also, the container type defines behaviors on the set of containers. + +Each container type is strongly coupled with one SharePoint Embedded application, which is referred to as the owning application. The owning application developer is responsible for creating and managing their container types. SharePoint Embedded mandates a 1:1 relationship between owning application and a container type. + +Container type is represented on each container instance as an immutable property (ContainerTypeID) and is used across the entire SharePoint Embedded ecosystem, including: + +- **Access authorization**: A SharePoint Embedded application must be associated with a container type to get access to container instances of that type. Once associated, the application has access to all container instances of that type. The actual access privilege is determined by the application-ContainerTypeID permission setting. The owning application by default has full access privilege to all container instances of the container type it's strongly coupled with. Learn more about [SharePoint Embedded Authorization](../development/auth.md). +- **Easy exploration**: Container type can be created for trial purposes, allowing developers to explore SharePoint Embedded application development and assess its features for free. +- **Billing**: Container types for non-trial purposes are billable and must be created with an Azure Subscription. The usage of containers is metered and charged. Learn more about [metering](../administration/billing/meters.md) and the [SharePoint Embedded billing experience](../administration/billing/billingmanagement.md). +- **Configurable behaviors**: Container type defines selected behaviors for all container instances of that type. Learn more about setting [Container type configuration](../getting-started/containertypes.md#configuring-container-types). + +> [!NOTE] +> +> 1. You must specify the purpose of the container type you're creating at creation time. Depending on the purpose, you may or may not need to provide your Azure Subscription ID. A container type set for trial purposes can't be converted for production; or vice versa. +> 1. Standard and pass through container types can't be converted once created. If you want to convert a standard container type to pass through billing or vice versa, you must delete and re-create the container type. +> 1. You must use the latest version of SharePoint PowerShell to configure a container type. For permissions and the most current information about Windows PowerShell for SharePoint Embedded, see the documentation at [Intro to SharePoint Embedded Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell). + +## Creating Container Types + +SharePoint Embedded has 2 different Container Types you can create. + +1. [Trial Container Type](#trial-container-type) +1. [Standard Container Type](#standard-container-types-non-trial) + +### Prerequisites to create SharePoint Embedded container type + +A new container type will be created using **SharePoint Online Management Shell**: + +1. Download and install the [latest version of SharePoint Online Management Shell](https://www.microsoft.com/download/details.aspx?id=35588) +1. Open SharePoint Online Management Shell from **Start** screen, type **sharepoint**, and then select **SharePoint Online Management Shell**. +1. Connect to SPO service using `Connect-SPOService` cmdlet by providing admin credentials associated with tenancy. For information on [how to use Connect-SPOService](/powershell/module/sharepoint-online/connect-sposervice), refer the linked documentation. + +### Tenant requirements + +- An active instance of SharePoint is required in your Microsoft 365 tenant. +- Users who will be authenticating into SharePoint Embedded Container Types and Containers must be in Entra ID (Members and Guests) + + > [!NOTE] + > An Office license is not required to collaborate on Microsoft Office documents stored in a container. + +### Roles and Permissions + +- The admin who sets up the billing relationship for SharePoint Embedded needs to have owner or contributor permissions on the Azure subscription. +- Admin needs to have a SharePoint Embedded Administrator or Global Admin role to operate billing cmdlets. + +### Azure Subscription + +For the standard billing container type, the global administrator or SharePoint Embedded Administrator needs to set up: + +- An existing SharePoint tenancy +- An Azure subscription in the tenancy +- A resource group attached to the Azure subscription + +## Trial Container Type + +A container type can be created for trial/development purposes and isn't linked to any Azure billing profile. This enables developers to explore SharePoint Embedded application development and assess its features for free. For trial container types, the developer tenant is the same as the consuming tenant. +Each developer can have only one container type in the trial status in their tenant at a time. The trial container type is valid for up to 30 days but can be removed at any time within this period. + +To create a container type for trial purposes, you can: + +- Use SharePoint Embedded Visual Studio Code Extension to create the container type in just a few steps. The Visual Studio Code extension registers your container type and creates containers for you. +- Use SharePoint PowerShell. You must be a SharePoint Embedded Administrator or Global Administrator to run the following cmdlet. If you're a SharePoint Administrator, grant yourself the SharePoint Embedded Admin role as well to execute these cmdlets. + + ```powershell + New-SPOContainerType [–TrialContainerType] [-ContainerTypeName] [-OwningApplicationId] [-ApplicationRedirectUrl] [] + ``` + +The following restrictions are applied to trial container types: + +- Up to five containers of the container type can be created. This includes active containers and those in the recycle bin. +- Each container has up to 1 GB of storage space. +- The container type expires after 30 days and access to any existing containers of that container type will be removed. +- The developer must permanently delete all containers of an existing container type in trial status to create a new container type for trial. This includes containers in the deleted container collection. +- The container type is restricted to work in the developer tenant. It can't be deployed in other consuming tenants. + +## Standard Container Types (non-trial) + +A standard container type in SharePoint Embedded defines the relationship, access privileges, and billing profile between an application and its containers. It establishes how the application interacts with the containers, including access permissions, and is associated with a billing profile for non-trial purposes. Each tenant can have 25 container types at a time. + +### Billing profile + +SharePoint Embedded is a consumption-based Pay-as-you-go (PAYG) offering meaning you pay only for what you use. SharePoint Embedded provides two billing models that the tenant developing the SharePoint Embedded application can select for respective container types, tailoring it to their unique business requirements. The two billing models are Standard and Pass-through billing. + +### Standard Container Type - with billing profile + +With the standard billing profile, all consumption-based charges are directly billed to the tenant who owns or develops the application. The admin in the developer tenant must establish a valid billing profile when creating a standard container type. + +![Standard](../images/1bill521.png) + +Each developer tenant can create up to five container types consisting of 1 trial container type and 4 standard container types or 5 standard container types. +Standard container types are created using the [New-SPOContainerType](/powershell/module/sharepoint-online/new-spocontainertype) cmdlet. + +You need the following to create a standard container type: + +- Use SharePoint PowerShell. You must be a SharePoint Embedded Administrator or Global Administrator to run this cmdlet. If you're a SharePoint Administrator, grant yourself the SharePoint Embedded Admin role as well to execute these cmdlets. +- An Azure subscription and a resource group must be present in the Azure portal for regular billing. +- An App registration must be created in Microsoft Entra ID. + +To create a standard container type using an Azure billing profile, use the following cmdlets: + +```powershell +New-SPOContainerType [-ContainerTypeName] [-OwningApplicationId] [-ApplicationRedirectUrl] [] +``` + +Once the container type is created, add the Azure billing profile. + +```powershell +Add-SPOContainerTypeBilling –ContainerTypeId -AzureSubscriptionId -ResourceGroup -Region +``` + +> [!NOTE] +> The user or admin who sets up a billing relationship for SharePoint Embedded must have owner or contributor permissions on the Azure subscription. +> +> Every container type must have an owning application. +> +> A single-owning app can only own one container type at a time. +> +> An Azure subscription can be attached to any number of container types. +> +> If the cmdlet above fails with a SubscriptionNotRegistered error, it is because **Microsoft.Syntex** is not registered as a resource provider in the subscription. The cmdlet will send a resource provider registration request on your behalf but it will take a few minutes to be completed. Please wait 5-10 minutes and try again until the cmdlet succeeds. + +### Standard Container Type - pass-through billing + +With pass-through billing, consumption-based charges are billed directly to the tenant registered to use the SharePoint Embedded application (consuming tenant). Admins in the developer tenant don't need to set up an Azure billing profile when creating a pass-through SharePoint Embedded container type. + +![Pass Through](../images/2bill521.png) + +For container types intended to be directly billed to a customer use the flag `-IsPassThroughBilling`. For the direct to customer billed container type, there's no need to attach a billing profile. + +To create a pass through billing, standard container type, use the following cmdlet: + +```powershell +New-SPOContainerType [-ContainerTypeName] [-OwningApplicationId] [-ApplicationRedirectUrl] [-IsPassThroughBilling] [] +``` + +Once the container type is [registered](../getting-started/register-api-documentation.md) in the consuming tenant, the consuming tenant admin (SharePoint Admin or Global Admin) needs to set up the billing profile in the consuming tenant to use the SharePoint Embedded application. + +#### Set Up Billing Profile in Consuming Tenant + +1. In [Microsoft 365 admin center](https://admin.microsoft.com/), select **Setup**, and the view the **Billing and licenses** section. Select **Activate pay-as-you-go services.** + + ![Microsoft 365 admin center Files and Content](../images/SyntexActivatePAYGSetup.png) + +1. Select **Go to Pay as you go services**. +1. Select **Apps** under **Syntex services for**, select **Apps** and **SharePoint Embedded** + + ![Microsoft 365 admin center SharePoint Embedded Billing setting](../images/SyntexPAYGActivateSPE.png) + + > [NOTE] + The subscription configured in the Syntex services will reflect the consuming charges in the Azure billing portal. + +1. [Register the container type](#registering-container-types) using the App only authentication token. + +## Configuring Container Types + +The Developer Admin can set selected settings on the SharePoint Embedded container types created by using this PowerShell cmdlet. + +This cmdlet allows admins to set [Microsoft 365 content discoverability](../development/content-experiences/user-experiences-overview.md) and [sharing](../development/sharing-and-perm.md) settings on container types. The setting applies to all container instances of the container type: + +```powershell +Set-SPOContainerTypeConfiguration -ContainerTypeId 4f0af585-8dcc-0000-223d-661eb2c604e4 -DiscoverabilityDisabled $False +``` + +## Viewing Container Types + +The Developer Admin can view all the SharePoint Embedded container types they created on their tenant using `Get-SPOContainerType`. This cmdlet retrieves and returns the list of container types created for a SharePoint Embedded Application in the tenant. + +```powershell +Get-SPOContainerType [] +``` + +Example output of the `Get-SPOContainerType` cmdlet + +```powershell +ContainerTypeId : 4f0af585-8dcc-0000-223d-661eb2c604e4 +ContainerTypeName : ContosoLegal +OwningApplicationId : a735e4af-b86e-0000-93ba-1faded6c39e1 +Classification : Standard +AzureSubscriptionId : 564e9025-f7f5-xxx9-9ddd-4cdxxxx1755 +ResourceGroup : prod-resources +Region : EastUS +``` + +## Registering Container Types + +To create and interact with containers, you must [register](../getting-started/register-api-documentation.md) the container type within the Consuming Tenant. The owning application defines the permissions for the container type by invoking the [registration API](../getting-started/register-api-documentation.md). + +## Deleting Container Types + +Developer admins can delete both trial and standard container types. To delete a container type, you must first remove all containers of that container type, including from the deleted container collection. To remove containers, refer to [Consuming Tenant Admin](../administration/consuming-tenant-admin/cta.md). +Once all the containers are deleted, Developer admins can delete the container type using `Remove-SPOContainerType`. + +```powershell +Remove-SPOContainerType [-ContainerTypeId ] +``` +## SharePoint Embedded meters + +To learn more about the supported pay-as-you-go meters, refer to the [SharePoint Embedded meters](../administration/billing/meters.md) article. diff --git a/docs/embedded/getting-started/register-api-documentation.md b/docs/embedded/getting-started/register-api-documentation.md new file mode 100644 index 000000000..320893e72 --- /dev/null +++ b/docs/embedded/getting-started/register-api-documentation.md @@ -0,0 +1,175 @@ +--- +title: Register File Storage container Type Application Permissions +description: Register the container type. +ms.date: 03/03/2025 +ms.localizationpriority: high +--- + +# Register file storage container type application permissions + +In order for a SharePoint Embedded application to interact with containers in a consuming tenant, the container type must first be registered in the consuming tenant. Container type registration happens when the owning application invokes the registration API to specify what permissions can be performed against its container type. The registration API also grants access to other Guest Apps to interact with the owning application's containers. For example, a SharePoint Embedded application can grant permissions to another application--a Guest App so that the Guest App can perform backup operations against its containers. + +Since the registration API controls the permissions that a SharePoint Embedded application can perform against the container in the consuming tenant, this call should be one of the first APIs invoked. Failure to do so results in access denied errors when invoking other APIs against the container and/or the content in the containers. + +There are no restrictions on how many times the registration API can be invoked. How often the registration API is invoked and when it's invoked is dependent on the SharePoint Embedded application. However, the last successful call to the registration API determines the settings used in the consuming tenant. + +## Authentication and authorization requirements + +For the container type's owning application to act on a consuming tenant, some pre-requisites must be completed: + +- the owning app must have a service principal installed on the consuming tenant; and +- the owning app must be granted admin consent to perform container type registration in the consuming tenant. + +> [!NOTE] +> Only the owning application of the container type can invoke the registration API in the consuming tenant. + +Both requirements can be satisfied by having a tenant administrator of the consuming tenant [grant admin consent](/entra/identity/enterprise-apps/grant-admin-consent?pivots=portal) to the container type's owning application. + +The container type registration API requires the `Container.Selected` app-only permission for SharePoint (see [Exceptional access patterns](../development/auth.md#exceptional-access-patterns)). You will need to use the [client credentials grant flow](/entra/identity-platform/v2-oauth2-client-creds-grant-flow) and [request a token with a certificate](/entra/identity-platform/v2-oauth2-client-creds-grant-flow#second-case-access-token-request-with-a-certificate) to use the registration API. + +> [!NOTE] +> The registration API is **NOT** a Microsoft Graph API but a SharePoint API. This API will be ported to Microsoft Graph in the future. + +To request admin consent from a tenant administrator in the consuming tenant, you may direct them to the [admin consent endpoint](/entra/identity-platform/v2-admin-consent). For the right endpoints on national clouds, see [Microsoft identity platform endpoints on national clouds](/entra/identity-platform/authentication-national-cloud#microsoft-entra-authentication-endpoints): + +```http +https://login.microsoftonline.com//adminconsent?client_id= +``` + +You may configure the admin consent endpoint to fit your needs, including handling errors and successful grants. For more information, see [Admin consent URI](/entra/identity-platform/v2-admin-consent). + + +## Container type Permissions + +The registration API determines what permissions a SharePoint Embedded application can perform against containers and content in containers for the specified container type. + +| Permission | Description | +| -------------------- | ------------------------------------------------------------------------------------------------------------------ | +| None | Has no permissions to any containers or content of this container type. | +| ReadContent | Can read content of containers of this container type. | +| WriteContent | Can write content to containers for this container type. This permission can't be granted without the ReadContent permission. | +| Create | Can create containers of this container type. | +| Delete | Can delete containers of this container type. | +| Read | Can read the metadata of containers of this container type. | +| Write | Can update the metadata of containers of this container type. | +| EnumeratePermissions | Can enumerate the members of a container and their roles for containers of this container type. | +| AddPermissions | Can add members to the container for containers of this container type. | +| UpdatePermissions | Can update (change roles of) existing memberships in the container for containers of this container type. | +| DeletePermissions | Can delete other members (but not self) from the container for containers of this container type. | +| DeleteOwnPermissions | Can remove own membership from the container for containers of this container type. | +| ManagePermissions | Can add, remove (including self) or update members in the container roles for containers of this container type. | +| Full | Has all permissions for containers of this container type. | + +## HTTP request + +```http +PUT {RootSiteUrl}/_api/v2.1/storageContainerTypes/{containerTypeId}/applicationPermissions +``` + +> [!NOTE] +> This is NOT a Graph API +> +> `{RootSiteURL}` is the SharePoint URL of the consuming tenant. For example, https://contoso.sharepoint.com. + +### Request body + +In the request body, supply a JSON representation of the container type permissions for the SharePoint Embedded applications. + +### Response + +If successful, this method returns a `200 OK` response code and the container type permissions configured for the SharePoint Embedded applications in the response body. + +| HTTP Code | Description | +| :--------: | ----------- | +| 400 | Bad request. | +| 401 | Request lacks valid authentication credentials. | +| 403 | Provided authentication credentials are valid but insufficient to perform the requested operation. Examples: the calling app isn't the owning app of the container type. | +| 404 | Container type doesn't exist. | + +## Examples + +### Register the container type in a consuming tenant with permissions only for the Owning App + +Register the container type in the consuming tenant and grant full permissions to the Owning Application (AppId 71392b2f-1765-406e-86af-5907d9bdb2ab) for Delegated and AppOnly calls. + +#### Request + +```json +PUT {RootSiteUrl}/_api/v2.1/storageContainerTypes/{containerTypeId}/applicationPermissions +Content-Type: application/json + +{ + "value": [ + { + "appId": "71392b2f-1765-406e-86af-5907d9bdb2ab", + "delegated": ["full"], + "appOnly": ["full"] + } + ] +} +``` + +#### Response + +```json +HTTP/1.1 200 OK +Content-type: application/json + +{ + "value": [ + { + "appId": "71392b2f-1765-406e-86af-5907d9bdb2ab", + "delegated": ["full"], + "appOnly": ["full"] + } + ] +} +``` + +### Register the container type in a consuming tenant with permissions for a Guest App + +Register the container type in the consuming tenant and grant full permissions to the Owning Application (AppId 71392b2f-1765-406e-86af-5907d9bdb2ab) for Delegated and AppOnly calls. In addition, grant a Guest App (AppId 89ea5c94-7736-4e25-95ad-3fa95f62b6) read and write permissions only for Delegated calls. + +#### Request + +```json +PUT /storagecontainerTypes/{containerTypeId}/applicationPermissions +Content-Type: application/json + +{ + "value": [ + { + "appId": "71392b2f-1765-406e-86af-5907d9bdb2ab", + "delegated": ["full"], + "appOnly": ["full"] + }, + { + "appId": "89ea5c94-7736-4e25-95ad-3fa95f62b6", + "delegated": ["read", "write"], + "appOnly": ["none"] + } + ] +} +``` + +#### Response + +```json +HTTP/1.1 200 OK +Content-type: application/json + +{ + "value": [ + { + "appId": "71392b2f-1765-406e-86af-5907d9bdb2ab", + "delegated": ["full"], + "appOnly": ["read"] + }, + { + "appId": "89ea5c94-7736-4e25-95ad-3fa95f62b6", + "delegated": ["read", "write"], + "appOnly": ["none"] + } + ] +} +``` diff --git a/docs/embedded/getting-started/spembedded-for-vscode.md b/docs/embedded/getting-started/spembedded-for-vscode.md new file mode 100644 index 000000000..343a842f5 --- /dev/null +++ b/docs/embedded/getting-started/spembedded-for-vscode.md @@ -0,0 +1,176 @@ +--- +title: SharePoint Embedded for Visual Studio Code +description: Installation and getting started with SharePoint Embedded for Visual Studio Code +ms.date: 07/16/2025 +ms.localizationpriority: high +--- + +# SharePoint Embedded for Visual Studio Code + +The SharePoint Embedded Visual Studio Code extension helps developers get started for free with SharePoint Embedded application development. + +> [!IMPORTANT] +> To start building with SharePoint Embedded, you'll need administrative access to a Microsoft 365 tenant. +> If you don't already have a tenant, you can get your own tenant with the [Microsoft 365 Developer Program](https://developer.microsoft.com/microsoft-365/dev-program), [Microsoft Customer Digital Experience](https://cdx.transform.microsoft.com/), or create a free trial of a [Microsoft 365 E3 license](https://www.microsoft.com/microsoft-365/enterprise/microsoft365-plans-and-pricing). + +## Install SharePoint Embedded for Visual Studio Code + +1. Open a new window in [Visual Studio Code](https://code.visualstudio.com/) and navigate to "**Extensions**" on the activity bar. +1. Search "SharePoint Embedded" in the Extensions view. You can also view the extension in [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=SharepointEmbedded.ms-sharepoint-embedded-vscode-extension). +1. Select **"Install"** and the SharePoint Embedded icon will appear on the activity bar. +1. If already installed, please update to the latest version if one is available. +1. Select the icon to open the SharePoint Embedded view and create a container type with trial configuration. + +![SharePoint Embedded VS Extensions](../images/vsx-images/n1downloadvsx.png) + +### Sign in with admin credentials + +To use the extension, you must sign in to a Microsoft 365 tenant with an administrator account. + +![Install](../images/vsx-images/n2vsx-signin.png) + +- Authentication opens a new tab in an external browser to grant permissions + + ![authorize and authenticate the extension to your M365 Entra tenant](../images/vsx-images/auth-allow-extension-uri.png) + +- Review the requested permissions carefully, then select **Accept** on the pop-up window prompting admin consent + + ![review before consenting to the permissions the extension is asking for](../images/vsx-images/n3vsx-grant-admin-consent.png) + +After successful authorization, select open on the dialog to be redirected to VSCode: + +![authorization completed in browser now redirecting to visual studio code](../images/vsx-images/auth-redirect.png) + +## Create a container type with a trial configuration + +Once signed in, you're prompted to create a [container type with trial configuration](./containertypes.md#trial-container-type). A container type lets you get started calling SharePoint Embedded APIs and building a proof-of-concept application using SharePoint Embedded. Learn more about [container types](containertypes.md). + +![home screen](../images/vsx-images/n4vsx-home-screen.png) + +- Select **Create Trial Container Type** +- Follow the prompts to name your container type. You can change your container type name later on. + +![create container type](../images/vsx-images/n5a-name-ct.png) + +> [!NOTE] +> SharePoint Embedded for Visual Studio Code only supports container types with trial configuration at this time. Other container types with standard or pass-through billing configurations must be created using the SharePoint Online PowerShell Module. + +## Create a Microsoft Entra ID App + +Every container type is owned by a Microsoft Entra ID application. The first step when creating a free trial container type is to create a new or select an existing Microsoft Entra ID application as the owning application. You can either specify the name of your new application or pick one of your existing applications. Learn more about SharePoint Embedded [app architecture](../development/app-architecture.md) + +- Follow the prompts to name your new Entra application or select an existing application ID: + +![Create App](../images/vsx-images/n6aname-app.png) + +> [!NOTE] +> If you choose an existing application, the extension will update that app's configuration settings for it to work with both SharePoint Embedded and this extension. Doing this is NOT recommended on production applications. + +After your container type is created and your application is configured, you'll be able to view your local tenant registration as a tree in the left nav-bar. + +## Register your container type + +After creating your container type, you'll need to register that container type on your local tenant. Learn more about container type [registration](./register-api-documentation.md). + +- Follow the prompts and select **Register on local tenant** on the lower right corner of the VS Code window + + ![local tenant registration popup](../images/vsx-images/local-tenant-registration-popup.png) + +- If you don't see the prompt, you can right-click on your `` and select **Register** from the menu + + ![register](../images/vsx-images/n7aregister-ct.png) + +### Grant permissions + +Review permissions and follow the prompt to grant admin consent + +![grant admin consent popup](../images/vsx-images/auth-grant-admin-consent-popup.png) + +An external browser window will pop open for you to sign-in and grant admin consent + +![login permissions](../images/vsx-images/n9alogin-grant-permissions.png) + +## Create your first container + +With your container type registered, you can now create your first container. Only five containers of container type can be created to upload and manage content. + +- Right-click on the **Containers** drop-down from the tree in the left nav-bar and select **Create container** +- Enter a name for the container you would like to create + +![create container](../images/vsx-images/n10acreate-container.png) +![name container](../images/vsx-images/n11aname-first-cont.png) + +## Recycling Containers + +You can also recycle and recover containers within the extension. + +![recycle containers](../images/vsx-images/n12arecycle-cont.png) + +![final home page](../images/vsx-images/n13a-final-home-page.png) + +## Load Sample App + +With your free trial container type created, you can use the extension to load one of the SharePoint Embedded sample apps and automatically populate the runtime configuration file with the details of your Microsoft Entra ID app and container type. + +![Load Sample App](../images/vsx-images/n15vsxsa-c.png) + +When loading the sample application, you'll be notified that it will create plain text secrets to authenticate on your local machine. + +![sample app plain text secrets notice](../images/vsx-images/sample-app-app-secrets-notice.png) + +If no client secret is found on your application, it will ask if you would like to create one. Press OK to proceed. + +![sample app creating client secret](../images/vsx-images/sample-app-create-client-secret.png) + +> [!IMPORTANT] +> This isn't intended for production environments. [Find out more on how to setup Application Registration for production environments here.](/entra/identity-platform/quickstart-register-app) + +## Using Sample App + +In your terminal, run the following command, this will start the sample application, which consists of 2 parts: + +1. **React Client Application** - The frontend user interface running on port 8080 +1. **Azure Function Application Server** - The backend API server that handles SharePoint Embedded operations + +```console +# Navigate to your sample application directory +cd [your-path]\SharePoint-Embedded-Samples\Samples\spe-typescript-react-azurefunction + +# Install dependencies and start the application +npm run start +``` + +> [!NOTE] +> The initial startup may take a few minutes as dependencies are installed and both applications are built. Wait for both console outputs to appear before navigating to the application. + +This will install the dependencies and run the server and client application, once running, you'll see the following in the terminal, after which you can navigate to http://localhost:8080 to access the application. + +![function api console logs](../images/vsx-images/fn-api-logs.png) + +![client app console logs](../images/vsx-images/client-app-logs.png) + +Once both applications are running successfully: + +1. Open your web browser and navigate to **http://localhost:8080** +1. Sign in using your Microsoft 365 administrator account (the same account used in the VS Code extension) +1. On the home page, select **"Containers"** to begin creating containers and uploading files +1. Follow the on-screen prompts to interact with your SharePoint Embedded containers + +![home-page-for-spe-sample-app](../images/vsx-images/spe-sample-app-home.png) + +> [!IMPORTANT] +> This sample application stores authentication secrets in plain text for development purposes only. Never use this configuration in a production environment. + +### Troubleshooting + +If you encounter issues: + +- **Port already in use**: If port 8080 is already in use, the application will automatically try the next available port +- **Dependencies not installing**: Try running `npm install` manually before `npm run start` +- **Authentication errors**: Ensure your Microsoft Entra ID app is properly configured with the correct redirect URIs + +## Export Postman Environment + +The [SharePoint Embedded Postman Collection](https://github.com/microsoft/SharePoint-Embedded-Samples/tree/main/Postman) allows you to explore and call the SharePoint Embedded APIs. The Collection requires an environment file with variables used for authentication and various identifiers. This extension automates the generation of this populated environment file so you can import it into Postal worker and immediately call the SharePoint Embedded APIs. + +![Export Postman Environment](../images/vsx-images/n14postman-c.png) diff --git a/docs/embedded/images/1bill521.png b/docs/embedded/images/1bill521.png new file mode 100644 index 000000000..6528d71c3 Binary files /dev/null and b/docs/embedded/images/1bill521.png differ diff --git a/docs/embedded/images/2bill521.png b/docs/embedded/images/2bill521.png new file mode 100644 index 000000000..d4dfc162b Binary files /dev/null and b/docs/embedded/images/2bill521.png differ diff --git a/docs/embedded/images/DTCBilling1.png b/docs/embedded/images/DTCBilling1.png new file mode 100644 index 000000000..6a24fa4b5 Binary files /dev/null and b/docs/embedded/images/DTCBilling1.png differ diff --git a/docs/embedded/images/DTCBilling2.png b/docs/embedded/images/DTCBilling2.png new file mode 100644 index 000000000..b4c7318b9 Binary files /dev/null and b/docs/embedded/images/DTCBilling2.png differ diff --git a/docs/embedded/images/Document-Processing.png b/docs/embedded/images/Document-Processing.png new file mode 100644 index 000000000..7982dba53 Binary files /dev/null and b/docs/embedded/images/Document-Processing.png differ diff --git a/docs/embedded/images/SPEAdmin1.png b/docs/embedded/images/SPEAdmin1.png new file mode 100644 index 000000000..87c3a1fa8 Binary files /dev/null and b/docs/embedded/images/SPEAdmin1.png differ diff --git a/docs/embedded/images/SPEAdmin10.png b/docs/embedded/images/SPEAdmin10.png new file mode 100644 index 000000000..9f5feab08 Binary files /dev/null and b/docs/embedded/images/SPEAdmin10.png differ diff --git a/docs/embedded/images/SPEAdmin11.png b/docs/embedded/images/SPEAdmin11.png new file mode 100644 index 000000000..1027fc70a Binary files /dev/null and b/docs/embedded/images/SPEAdmin11.png differ diff --git a/docs/embedded/images/SPEAdmin12.png b/docs/embedded/images/SPEAdmin12.png new file mode 100644 index 000000000..102e0dacf Binary files /dev/null and b/docs/embedded/images/SPEAdmin12.png differ diff --git a/docs/embedded/images/SPEAdmin13.png b/docs/embedded/images/SPEAdmin13.png new file mode 100644 index 000000000..83d556813 Binary files /dev/null and b/docs/embedded/images/SPEAdmin13.png differ diff --git a/docs/embedded/images/SPEAdmin14.png b/docs/embedded/images/SPEAdmin14.png new file mode 100644 index 000000000..dc66703b5 Binary files /dev/null and b/docs/embedded/images/SPEAdmin14.png differ diff --git a/docs/embedded/images/SPEAdmin15.png b/docs/embedded/images/SPEAdmin15.png new file mode 100644 index 000000000..4a3f80cdb Binary files /dev/null and b/docs/embedded/images/SPEAdmin15.png differ diff --git a/docs/embedded/images/SPEAdmin16.png b/docs/embedded/images/SPEAdmin16.png new file mode 100644 index 000000000..03568e615 Binary files /dev/null and b/docs/embedded/images/SPEAdmin16.png differ diff --git a/docs/embedded/images/SPEAdmin2.png b/docs/embedded/images/SPEAdmin2.png new file mode 100644 index 000000000..8be14b0b4 Binary files /dev/null and b/docs/embedded/images/SPEAdmin2.png differ diff --git a/docs/embedded/images/SPEAdmin3.png b/docs/embedded/images/SPEAdmin3.png new file mode 100644 index 000000000..010bf998b Binary files /dev/null and b/docs/embedded/images/SPEAdmin3.png differ diff --git a/docs/embedded/images/SPEAdmin4.png b/docs/embedded/images/SPEAdmin4.png new file mode 100644 index 000000000..26b05d149 Binary files /dev/null and b/docs/embedded/images/SPEAdmin4.png differ diff --git a/docs/embedded/images/SPEAdmin5.png b/docs/embedded/images/SPEAdmin5.png new file mode 100644 index 000000000..b82c2bbfc Binary files /dev/null and b/docs/embedded/images/SPEAdmin5.png differ diff --git a/docs/embedded/images/SPEAdmin6.png b/docs/embedded/images/SPEAdmin6.png new file mode 100644 index 000000000..e80422388 Binary files /dev/null and b/docs/embedded/images/SPEAdmin6.png differ diff --git a/docs/embedded/images/SPEAdmin7.png b/docs/embedded/images/SPEAdmin7.png new file mode 100644 index 000000000..1b97c3acb Binary files /dev/null and b/docs/embedded/images/SPEAdmin7.png differ diff --git a/docs/embedded/images/SPEAdmin8.png b/docs/embedded/images/SPEAdmin8.png new file mode 100644 index 000000000..62cd5b268 Binary files /dev/null and b/docs/embedded/images/SPEAdmin8.png differ diff --git a/docs/embedded/images/SPEAdmin9.png b/docs/embedded/images/SPEAdmin9.png new file mode 100644 index 000000000..08a6f7120 Binary files /dev/null and b/docs/embedded/images/SPEAdmin9.png differ diff --git a/docs/embedded/images/SPEArch.png b/docs/embedded/images/SPEArch.png new file mode 100644 index 000000000..cb0818e3f Binary files /dev/null and b/docs/embedded/images/SPEArch.png differ diff --git a/docs/embedded/images/SPECTDedicated.png b/docs/embedded/images/SPECTDedicated.png new file mode 100644 index 000000000..67b94e68c Binary files /dev/null and b/docs/embedded/images/SPECTDedicated.png differ diff --git a/docs/embedded/images/SPECTShared.png b/docs/embedded/images/SPECTShared.png new file mode 100644 index 000000000..bcc4de7e8 Binary files /dev/null and b/docs/embedded/images/SPECTShared.png differ diff --git a/docs/embedded/images/SharePointEmbeddedToS-1.jpg b/docs/embedded/images/SharePointEmbeddedToS-1.jpg new file mode 100644 index 000000000..03777613c Binary files /dev/null and b/docs/embedded/images/SharePointEmbeddedToS-1.jpg differ diff --git a/docs/embedded/images/SharePointEmbeddedToS-2.jpg b/docs/embedded/images/SharePointEmbeddedToS-2.jpg new file mode 100644 index 000000000..c7196e505 Binary files /dev/null and b/docs/embedded/images/SharePointEmbeddedToS-2.jpg differ diff --git a/docs/embedded/images/SharePointEmbeddedToS-3.jpg b/docs/embedded/images/SharePointEmbeddedToS-3.jpg new file mode 100644 index 000000000..e7fb61050 Binary files /dev/null and b/docs/embedded/images/SharePointEmbeddedToS-3.jpg differ diff --git a/docs/embedded/images/SharePointEmbeddedToS-4.jpg b/docs/embedded/images/SharePointEmbeddedToS-4.jpg new file mode 100644 index 000000000..0d29fbfd4 Binary files /dev/null and b/docs/embedded/images/SharePointEmbeddedToS-4.jpg differ diff --git a/docs/embedded/images/SharePointEmbeddedToS-5.jpg b/docs/embedded/images/SharePointEmbeddedToS-5.jpg new file mode 100644 index 000000000..e09f5cd1c Binary files /dev/null and b/docs/embedded/images/SharePointEmbeddedToS-5.jpg differ diff --git a/docs/embedded/images/SharingPartitions.png b/docs/embedded/images/SharingPartitions.png new file mode 100644 index 000000000..5b3b4bd66 Binary files /dev/null and b/docs/embedded/images/SharingPartitions.png differ diff --git a/docs/embedded/images/SyntexActivatePAYGSetup.png b/docs/embedded/images/SyntexActivatePAYGSetup.png new file mode 100644 index 000000000..00147f57b Binary files /dev/null and b/docs/embedded/images/SyntexActivatePAYGSetup.png differ diff --git a/docs/embedded/images/SyntexPAYGActivateSPE.png b/docs/embedded/images/SyntexPAYGActivateSPE.png new file mode 100644 index 000000000..739a58a47 Binary files /dev/null and b/docs/embedded/images/SyntexPAYGActivateSPE.png differ diff --git a/docs/embedded/images/Using-Webhooks.png b/docs/embedded/images/Using-Webhooks.png new file mode 100644 index 000000000..5d98224cf Binary files /dev/null and b/docs/embedded/images/Using-Webhooks.png differ diff --git a/docs/embedded/images/add-owners-one.png b/docs/embedded/images/add-owners-one.png new file mode 100644 index 000000000..bba134252 Binary files /dev/null and b/docs/embedded/images/add-owners-one.png differ diff --git a/docs/embedded/images/add-owners-two.png b/docs/embedded/images/add-owners-two.png new file mode 100644 index 000000000..fe7af04ed Binary files /dev/null and b/docs/embedded/images/add-owners-two.png differ diff --git a/docs/embedded/images/app-arch.png b/docs/embedded/images/app-arch.png new file mode 100644 index 000000000..0129f6719 Binary files /dev/null and b/docs/embedded/images/app-arch.png differ diff --git a/docs/embedded/images/app-flow7.jpg b/docs/embedded/images/app-flow7.jpg new file mode 100644 index 000000000..cbf6f4801 Binary files /dev/null and b/docs/embedded/images/app-flow7.jpg differ diff --git a/docs/embedded/images/app-registration-console-platform.png b/docs/embedded/images/app-registration-console-platform.png new file mode 100644 index 000000000..177c0bc5a Binary files /dev/null and b/docs/embedded/images/app-registration-console-platform.png differ diff --git a/docs/embedded/images/apparc-1.png b/docs/embedded/images/apparc-1.png new file mode 100644 index 000000000..082e51788 Binary files /dev/null and b/docs/embedded/images/apparc-1.png differ diff --git a/docs/embedded/images/apparc-2.png b/docs/embedded/images/apparc-2.png new file mode 100644 index 000000000..7f8a72df8 Binary files /dev/null and b/docs/embedded/images/apparc-2.png differ diff --git a/docs/embedded/images/apparchexample.png b/docs/embedded/images/apparchexample.png new file mode 100644 index 000000000..f862809ad Binary files /dev/null and b/docs/embedded/images/apparchexample.png differ diff --git a/docs/embedded/images/architecture-overview.png b/docs/embedded/images/architecture-overview.png new file mode 100644 index 000000000..b815cb4cd Binary files /dev/null and b/docs/embedded/images/architecture-overview.png differ diff --git a/docs/embedded/images/billing-1.png b/docs/embedded/images/billing-1.png new file mode 100644 index 000000000..14eb0f29a Binary files /dev/null and b/docs/embedded/images/billing-1.png differ diff --git a/docs/embedded/images/billing-2.png b/docs/embedded/images/billing-2.png new file mode 100644 index 000000000..669b0642a Binary files /dev/null and b/docs/embedded/images/billing-2.png differ diff --git a/docs/embedded/images/billing-manage.png b/docs/embedded/images/billing-manage.png new file mode 100644 index 000000000..014db7f05 Binary files /dev/null and b/docs/embedded/images/billing-manage.png differ diff --git a/docs/embedded/images/billmanag1.png b/docs/embedded/images/billmanag1.png new file mode 100644 index 000000000..bebe7f8b9 Binary files /dev/null and b/docs/embedded/images/billmanag1.png differ diff --git a/docs/embedded/images/billmanag2.png b/docs/embedded/images/billmanag2.png new file mode 100644 index 000000000..1bca53b4f Binary files /dev/null and b/docs/embedded/images/billmanag2.png differ diff --git a/docs/embedded/images/billmanag3.png b/docs/embedded/images/billmanag3.png new file mode 100644 index 000000000..2ac8dd97b Binary files /dev/null and b/docs/embedded/images/billmanag3.png differ diff --git a/docs/embedded/images/ctaux1.png b/docs/embedded/images/ctaux1.png new file mode 100644 index 000000000..c5ff77540 Binary files /dev/null and b/docs/embedded/images/ctaux1.png differ diff --git a/docs/embedded/images/ctaux10.png b/docs/embedded/images/ctaux10.png new file mode 100644 index 000000000..d60b84e5d Binary files /dev/null and b/docs/embedded/images/ctaux10.png differ diff --git a/docs/embedded/images/ctaux11.png b/docs/embedded/images/ctaux11.png new file mode 100644 index 000000000..01dc83bc0 Binary files /dev/null and b/docs/embedded/images/ctaux11.png differ diff --git a/docs/embedded/images/ctaux12.png b/docs/embedded/images/ctaux12.png new file mode 100644 index 000000000..b7f53ffed Binary files /dev/null and b/docs/embedded/images/ctaux12.png differ diff --git a/docs/embedded/images/ctaux13.png b/docs/embedded/images/ctaux13.png new file mode 100644 index 000000000..e77fd7b11 Binary files /dev/null and b/docs/embedded/images/ctaux13.png differ diff --git a/docs/embedded/images/ctaux14.png b/docs/embedded/images/ctaux14.png new file mode 100644 index 000000000..b62786140 Binary files /dev/null and b/docs/embedded/images/ctaux14.png differ diff --git a/docs/embedded/images/ctaux15-n.png b/docs/embedded/images/ctaux15-n.png new file mode 100644 index 000000000..c534fae69 Binary files /dev/null and b/docs/embedded/images/ctaux15-n.png differ diff --git a/docs/embedded/images/ctaux2.png b/docs/embedded/images/ctaux2.png new file mode 100644 index 000000000..3c5dac782 Binary files /dev/null and b/docs/embedded/images/ctaux2.png differ diff --git a/docs/embedded/images/ctaux3.png b/docs/embedded/images/ctaux3.png new file mode 100644 index 000000000..88728dc03 Binary files /dev/null and b/docs/embedded/images/ctaux3.png differ diff --git a/docs/embedded/images/ctaux4.png b/docs/embedded/images/ctaux4.png new file mode 100644 index 000000000..5c06e1b4f Binary files /dev/null and b/docs/embedded/images/ctaux4.png differ diff --git a/docs/embedded/images/ctaux5.png b/docs/embedded/images/ctaux5.png new file mode 100644 index 000000000..4ca1d7238 Binary files /dev/null and b/docs/embedded/images/ctaux5.png differ diff --git a/docs/embedded/images/ctaux6.png b/docs/embedded/images/ctaux6.png new file mode 100644 index 000000000..ab0b73ff8 Binary files /dev/null and b/docs/embedded/images/ctaux6.png differ diff --git a/docs/embedded/images/ctaux7.png b/docs/embedded/images/ctaux7.png new file mode 100644 index 000000000..d5f841cc6 Binary files /dev/null and b/docs/embedded/images/ctaux7.png differ diff --git a/docs/embedded/images/ctaux8.png b/docs/embedded/images/ctaux8.png new file mode 100644 index 000000000..48e3c9b4e Binary files /dev/null and b/docs/embedded/images/ctaux8.png differ diff --git a/docs/embedded/images/ctaux9.png b/docs/embedded/images/ctaux9.png new file mode 100644 index 000000000..233cded62 Binary files /dev/null and b/docs/embedded/images/ctaux9.png differ diff --git a/docs/embedded/images/enable1.png b/docs/embedded/images/enable1.png new file mode 100644 index 000000000..e6f7a30d3 Binary files /dev/null and b/docs/embedded/images/enable1.png differ diff --git a/docs/embedded/images/enable2.png b/docs/embedded/images/enable2.png new file mode 100644 index 000000000..d3bcbbfa2 Binary files /dev/null and b/docs/embedded/images/enable2.png differ diff --git a/docs/embedded/images/enable3.png b/docs/embedded/images/enable3.png new file mode 100644 index 000000000..52f0cd78e Binary files /dev/null and b/docs/embedded/images/enable3.png differ diff --git a/docs/embedded/images/enable4.png b/docs/embedded/images/enable4.png new file mode 100644 index 000000000..3bd2d76ee Binary files /dev/null and b/docs/embedded/images/enable4.png differ diff --git a/docs/embedded/images/enable5.png b/docs/embedded/images/enable5.png new file mode 100644 index 000000000..ec852a6ce Binary files /dev/null and b/docs/embedded/images/enable5.png differ diff --git a/docs/embedded/images/featuretbl.png b/docs/embedded/images/featuretbl.png new file mode 100644 index 000000000..e2cf7c5df Binary files /dev/null and b/docs/embedded/images/featuretbl.png differ diff --git a/docs/embedded/images/filter-on-delete.png b/docs/embedded/images/filter-on-delete.png new file mode 100644 index 000000000..87599873d Binary files /dev/null and b/docs/embedded/images/filter-on-delete.png differ diff --git a/docs/embedded/images/filter.png b/docs/embedded/images/filter.png new file mode 100644 index 000000000..6f1eacbeb Binary files /dev/null and b/docs/embedded/images/filter.png differ diff --git a/docs/embedded/images/itemcount.png b/docs/embedded/images/itemcount.png new file mode 100644 index 000000000..5ceb712fe Binary files /dev/null and b/docs/embedded/images/itemcount.png differ diff --git a/docs/embedded/images/ngrok-registration.png b/docs/embedded/images/ngrok-registration.png new file mode 100644 index 000000000..86c133609 Binary files /dev/null and b/docs/embedded/images/ngrok-registration.png differ diff --git a/docs/embedded/images/office1.png b/docs/embedded/images/office1.png new file mode 100644 index 000000000..8ff7d3ba9 Binary files /dev/null and b/docs/embedded/images/office1.png differ diff --git a/docs/embedded/images/office2.png b/docs/embedded/images/office2.png new file mode 100644 index 000000000..3753f7c67 Binary files /dev/null and b/docs/embedded/images/office2.png differ diff --git a/docs/embedded/images/raasflow.png b/docs/embedded/images/raasflow.png new file mode 100644 index 000000000..a23fd1eff Binary files /dev/null and b/docs/embedded/images/raasflow.png differ diff --git a/docs/embedded/images/raaspic2.png b/docs/embedded/images/raaspic2.png new file mode 100644 index 000000000..bd77feabc Binary files /dev/null and b/docs/embedded/images/raaspic2.png differ diff --git a/docs/embedded/images/reassign-user.png b/docs/embedded/images/reassign-user.png new file mode 100644 index 000000000..5ae1447ed Binary files /dev/null and b/docs/embedded/images/reassign-user.png differ diff --git a/docs/embedded/images/remove-user.png b/docs/embedded/images/remove-user.png new file mode 100644 index 000000000..ffa8d357a Binary files /dev/null and b/docs/embedded/images/remove-user.png differ diff --git a/docs/embedded/images/sc1.png b/docs/embedded/images/sc1.png new file mode 100644 index 000000000..7e284f0a5 Binary files /dev/null and b/docs/embedded/images/sc1.png differ diff --git a/docs/embedded/images/sc2.png b/docs/embedded/images/sc2.png new file mode 100644 index 000000000..f621f6df3 Binary files /dev/null and b/docs/embedded/images/sc2.png differ diff --git a/docs/embedded/images/sc3.png b/docs/embedded/images/sc3.png new file mode 100644 index 000000000..62e1623f4 Binary files /dev/null and b/docs/embedded/images/sc3.png differ diff --git a/docs/embedded/images/sc4.png b/docs/embedded/images/sc4.png new file mode 100644 index 000000000..285aa9dad Binary files /dev/null and b/docs/embedded/images/sc4.png differ diff --git a/docs/embedded/images/sc5.png b/docs/embedded/images/sc5.png new file mode 100644 index 000000000..5fb5d3ae5 Binary files /dev/null and b/docs/embedded/images/sc5.png differ diff --git a/docs/embedded/images/sc6.png b/docs/embedded/images/sc6.png new file mode 100644 index 000000000..98fc406ed Binary files /dev/null and b/docs/embedded/images/sc6.png differ diff --git a/docs/embedded/images/sc7.png b/docs/embedded/images/sc7.png new file mode 100644 index 000000000..fb4038ad6 Binary files /dev/null and b/docs/embedded/images/sc7.png differ diff --git a/docs/embedded/images/search.png b/docs/embedded/images/search.png new file mode 100644 index 000000000..02c1c3ffc Binary files /dev/null and b/docs/embedded/images/search.png differ diff --git a/docs/embedded/images/sensitivity-label.png b/docs/embedded/images/sensitivity-label.png new file mode 100644 index 000000000..5180a30a0 Binary files /dev/null and b/docs/embedded/images/sensitivity-label.png differ diff --git a/docs/embedded/images/sorting-on-deleted.png b/docs/embedded/images/sorting-on-deleted.png new file mode 100644 index 000000000..961e81d55 Binary files /dev/null and b/docs/embedded/images/sorting-on-deleted.png differ diff --git a/docs/embedded/images/sorting.png b/docs/embedded/images/sorting.png new file mode 100644 index 000000000..3f495f85c Binary files /dev/null and b/docs/embedded/images/sorting.png differ diff --git a/docs/embedded/images/spe-vscode-marketplace.png b/docs/embedded/images/spe-vscode-marketplace.png new file mode 100644 index 000000000..ac9a383b6 Binary files /dev/null and b/docs/embedded/images/spe-vscode-marketplace.png differ diff --git a/docs/embedded/images/speco-apparch.png b/docs/embedded/images/speco-apparch.png new file mode 100644 index 000000000..ec05874da Binary files /dev/null and b/docs/embedded/images/speco-apparch.png differ diff --git a/docs/embedded/images/speco-appscopingvenn.png b/docs/embedded/images/speco-appscopingvenn.png new file mode 100644 index 000000000..d5727486a Binary files /dev/null and b/docs/embedded/images/speco-appscopingvenn.png differ diff --git a/docs/embedded/images/speco-bound.png b/docs/embedded/images/speco-bound.png new file mode 100644 index 000000000..8f3cff455 Binary files /dev/null and b/docs/embedded/images/speco-bound.png differ diff --git a/docs/embedded/images/speco-cloneproject.png b/docs/embedded/images/speco-cloneproject.png new file mode 100644 index 000000000..4573bdc74 Binary files /dev/null and b/docs/embedded/images/speco-cloneproject.png differ diff --git a/docs/embedded/images/speco-createappsecret.png b/docs/embedded/images/speco-createappsecret.png new file mode 100644 index 000000000..b283b8259 Binary files /dev/null and b/docs/embedded/images/speco-createappsecret.png differ diff --git a/docs/embedded/images/speco-createclientsecret.png b/docs/embedded/images/speco-createclientsecret.png new file mode 100644 index 000000000..37cf20e57 Binary files /dev/null and b/docs/embedded/images/speco-createclientsecret.png differ diff --git a/docs/embedded/images/speco-createcontosocontainer2.png b/docs/embedded/images/speco-createcontosocontainer2.png new file mode 100644 index 000000000..995cd7f88 Binary files /dev/null and b/docs/embedded/images/speco-createcontosocontainer2.png differ diff --git a/docs/embedded/images/speco-createdcontainer.png b/docs/embedded/images/speco-createdcontainer.png new file mode 100644 index 000000000..e429321c4 Binary files /dev/null and b/docs/embedded/images/speco-createdcontainer.png differ diff --git a/docs/embedded/images/speco-feedbackcombined.png b/docs/embedded/images/speco-feedbackcombined.png new file mode 100644 index 000000000..c3d95ef63 Binary files /dev/null and b/docs/embedded/images/speco-feedbackcombined.png differ diff --git a/docs/embedded/images/speco-feedbackmodal.png b/docs/embedded/images/speco-feedbackmodal.png new file mode 100644 index 000000000..ef3b9ab51 Binary files /dev/null and b/docs/embedded/images/speco-feedbackmodal.png differ diff --git a/docs/embedded/images/speco-feedbackthumbsdown.png b/docs/embedded/images/speco-feedbackthumbsdown.png new file mode 100644 index 000000000..d9e3bd0f5 Binary files /dev/null and b/docs/embedded/images/speco-feedbackthumbsdown.png differ diff --git a/docs/embedded/images/speco-ragai.png b/docs/embedded/images/speco-ragai.png new file mode 100644 index 000000000..28b3f3eac Binary files /dev/null and b/docs/embedded/images/speco-ragai.png differ diff --git a/docs/embedded/images/speco-ragm365.png b/docs/embedded/images/speco-ragm365.png new file mode 100644 index 000000000..17a016ff8 Binary files /dev/null and b/docs/embedded/images/speco-ragm365.png differ diff --git a/docs/embedded/images/speco-ragquery.png b/docs/embedded/images/speco-ragquery.png new file mode 100644 index 000000000..b8a52311b Binary files /dev/null and b/docs/embedded/images/speco-ragquery.png differ diff --git a/docs/embedded/images/speco-reacttypescripthomepage.png b/docs/embedded/images/speco-reacttypescripthomepage.png new file mode 100644 index 000000000..b25861791 Binary files /dev/null and b/docs/embedded/images/speco-reacttypescripthomepage.png differ diff --git a/docs/embedded/images/speco-runnpmrunstart.png b/docs/embedded/images/speco-runnpmrunstart.png new file mode 100644 index 000000000..1f26f6395 Binary files /dev/null and b/docs/embedded/images/speco-runnpmrunstart.png differ diff --git a/docs/embedded/images/speco-runsampleapp.png b/docs/embedded/images/speco-runsampleapp.png new file mode 100644 index 000000000..3d3341eaf Binary files /dev/null and b/docs/embedded/images/speco-runsampleapp.png differ diff --git a/docs/embedded/images/speco-setshowsidebartrue.png b/docs/embedded/images/speco-setshowsidebartrue.png new file mode 100644 index 000000000..2b73eac96 Binary files /dev/null and b/docs/embedded/images/speco-setshowsidebartrue.png differ diff --git a/docs/embedded/images/speco-spechatenabled.png b/docs/embedded/images/speco-spechatenabled.png new file mode 100644 index 000000000..87f35bb1b Binary files /dev/null and b/docs/embedded/images/speco-spechatenabled.png differ diff --git a/docs/embedded/images/speco-uncommentchatsidebar.png b/docs/embedded/images/speco-uncommentchatsidebar.png new file mode 100644 index 000000000..ccc7cfd46 Binary files /dev/null and b/docs/embedded/images/speco-uncommentchatsidebar.png differ diff --git a/docs/embedded/images/speco-vscodeclonedproject.png b/docs/embedded/images/speco-vscodeclonedproject.png new file mode 100644 index 000000000..c88e78db4 Binary files /dev/null and b/docs/embedded/images/speco-vscodeclonedproject.png differ diff --git a/docs/embedded/images/speco-vscodeextensiondisablediscovery.png b/docs/embedded/images/speco-vscodeextensiondisablediscovery.png new file mode 100644 index 000000000..d1c9d63d2 Binary files /dev/null and b/docs/embedded/images/speco-vscodeextensiondisablediscovery.png differ diff --git a/docs/embedded/images/vscodeconsentperms.png b/docs/embedded/images/vscodeconsentperms.png new file mode 100644 index 000000000..05d708775 Binary files /dev/null and b/docs/embedded/images/vscodeconsentperms.png differ diff --git a/docs/embedded/images/vscodecontcreate.png b/docs/embedded/images/vscodecontcreate.png new file mode 100644 index 000000000..df87b340f Binary files /dev/null and b/docs/embedded/images/vscodecontcreate.png differ diff --git a/docs/embedded/images/vscodecontname.png b/docs/embedded/images/vscodecontname.png new file mode 100644 index 000000000..9b2c6d17a Binary files /dev/null and b/docs/embedded/images/vscodecontname.png differ diff --git a/docs/embedded/images/vscodeinstall.png b/docs/embedded/images/vscodeinstall.png new file mode 100644 index 000000000..68ea5d36c Binary files /dev/null and b/docs/embedded/images/vscodeinstall.png differ diff --git a/docs/embedded/images/vscodelaunch.png b/docs/embedded/images/vscodelaunch.png new file mode 100644 index 000000000..50ada3175 Binary files /dev/null and b/docs/embedded/images/vscodelaunch.png differ diff --git a/docs/embedded/images/vscodelogin.png b/docs/embedded/images/vscodelogin.png new file mode 100644 index 000000000..b6921c523 Binary files /dev/null and b/docs/embedded/images/vscodelogin.png differ diff --git a/docs/embedded/images/vscoderegister.png b/docs/embedded/images/vscoderegister.png new file mode 100644 index 000000000..5cfb6fb43 Binary files /dev/null and b/docs/embedded/images/vscoderegister.png differ diff --git a/docs/embedded/images/vscodetree.png b/docs/embedded/images/vscodetree.png new file mode 100644 index 000000000..3d7337b18 Binary files /dev/null and b/docs/embedded/images/vscodetree.png differ diff --git a/docs/embedded/images/vsx-images/auth-allow-extension-uri.png b/docs/embedded/images/vsx-images/auth-allow-extension-uri.png new file mode 100644 index 000000000..f71029396 Binary files /dev/null and b/docs/embedded/images/vsx-images/auth-allow-extension-uri.png differ diff --git a/docs/embedded/images/vsx-images/auth-grant-admin-consent-popup.png b/docs/embedded/images/vsx-images/auth-grant-admin-consent-popup.png new file mode 100644 index 000000000..a8b8485e7 Binary files /dev/null and b/docs/embedded/images/vsx-images/auth-grant-admin-consent-popup.png differ diff --git a/docs/embedded/images/vsx-images/auth-redirect.png b/docs/embedded/images/vsx-images/auth-redirect.png new file mode 100644 index 000000000..ee09cc6bb Binary files /dev/null and b/docs/embedded/images/vsx-images/auth-redirect.png differ diff --git a/docs/embedded/images/vsx-images/client-app-logs.png b/docs/embedded/images/vsx-images/client-app-logs.png new file mode 100644 index 000000000..61c81ce0f Binary files /dev/null and b/docs/embedded/images/vsx-images/client-app-logs.png differ diff --git a/docs/embedded/images/vsx-images/fn-api-logs.png b/docs/embedded/images/vsx-images/fn-api-logs.png new file mode 100644 index 000000000..dc0263c40 Binary files /dev/null and b/docs/embedded/images/vsx-images/fn-api-logs.png differ diff --git a/docs/embedded/images/vsx-images/local-tenant-registration-popup.png b/docs/embedded/images/vsx-images/local-tenant-registration-popup.png new file mode 100644 index 000000000..e233afcf7 Binary files /dev/null and b/docs/embedded/images/vsx-images/local-tenant-registration-popup.png differ diff --git a/docs/embedded/images/vsx-images/n10acreate-container.png b/docs/embedded/images/vsx-images/n10acreate-container.png new file mode 100644 index 000000000..6be23f1cc Binary files /dev/null and b/docs/embedded/images/vsx-images/n10acreate-container.png differ diff --git a/docs/embedded/images/vsx-images/n11aname-first-cont.png b/docs/embedded/images/vsx-images/n11aname-first-cont.png new file mode 100644 index 000000000..3a184eb9c Binary files /dev/null and b/docs/embedded/images/vsx-images/n11aname-first-cont.png differ diff --git a/docs/embedded/images/vsx-images/n12arecycle-cont.png b/docs/embedded/images/vsx-images/n12arecycle-cont.png new file mode 100644 index 000000000..6c26b1b20 Binary files /dev/null and b/docs/embedded/images/vsx-images/n12arecycle-cont.png differ diff --git a/docs/embedded/images/vsx-images/n13a-final-home-page.png b/docs/embedded/images/vsx-images/n13a-final-home-page.png new file mode 100644 index 000000000..bb77e35ed Binary files /dev/null and b/docs/embedded/images/vsx-images/n13a-final-home-page.png differ diff --git a/docs/embedded/images/vsx-images/n14postman-c.png b/docs/embedded/images/vsx-images/n14postman-c.png new file mode 100644 index 000000000..86d9b8a80 Binary files /dev/null and b/docs/embedded/images/vsx-images/n14postman-c.png differ diff --git a/docs/embedded/images/vsx-images/n15vsxsa-c.png b/docs/embedded/images/vsx-images/n15vsxsa-c.png new file mode 100644 index 000000000..6391443a2 Binary files /dev/null and b/docs/embedded/images/vsx-images/n15vsxsa-c.png differ diff --git a/docs/embedded/images/vsx-images/n1downloadvsx.png b/docs/embedded/images/vsx-images/n1downloadvsx.png new file mode 100644 index 000000000..94229faf7 Binary files /dev/null and b/docs/embedded/images/vsx-images/n1downloadvsx.png differ diff --git a/docs/embedded/images/vsx-images/n2vsx-signin.png b/docs/embedded/images/vsx-images/n2vsx-signin.png new file mode 100644 index 000000000..fa78d61e6 Binary files /dev/null and b/docs/embedded/images/vsx-images/n2vsx-signin.png differ diff --git a/docs/embedded/images/vsx-images/n3vsx-grant-admin-consent.png b/docs/embedded/images/vsx-images/n3vsx-grant-admin-consent.png new file mode 100644 index 000000000..c6cfd5cdc Binary files /dev/null and b/docs/embedded/images/vsx-images/n3vsx-grant-admin-consent.png differ diff --git a/docs/embedded/images/vsx-images/n4vsx-home-screen.png b/docs/embedded/images/vsx-images/n4vsx-home-screen.png new file mode 100644 index 000000000..6b9a85cae Binary files /dev/null and b/docs/embedded/images/vsx-images/n4vsx-home-screen.png differ diff --git a/docs/embedded/images/vsx-images/n5a-name-ct.png b/docs/embedded/images/vsx-images/n5a-name-ct.png new file mode 100644 index 000000000..aca25d3a8 Binary files /dev/null and b/docs/embedded/images/vsx-images/n5a-name-ct.png differ diff --git a/docs/embedded/images/vsx-images/n6aname-app.png b/docs/embedded/images/vsx-images/n6aname-app.png new file mode 100644 index 000000000..d58360b2a Binary files /dev/null and b/docs/embedded/images/vsx-images/n6aname-app.png differ diff --git a/docs/embedded/images/vsx-images/n7aregister-ct.png b/docs/embedded/images/vsx-images/n7aregister-ct.png new file mode 100644 index 000000000..9ae83ca19 Binary files /dev/null and b/docs/embedded/images/vsx-images/n7aregister-ct.png differ diff --git a/docs/embedded/images/vsx-images/n9alogin-grant-permissions.png b/docs/embedded/images/vsx-images/n9alogin-grant-permissions.png new file mode 100644 index 000000000..a5cdd7fe2 Binary files /dev/null and b/docs/embedded/images/vsx-images/n9alogin-grant-permissions.png differ diff --git a/docs/embedded/images/vsx-images/sample-app-app-secrets-notice.png b/docs/embedded/images/vsx-images/sample-app-app-secrets-notice.png new file mode 100644 index 000000000..1ade7d0fb Binary files /dev/null and b/docs/embedded/images/vsx-images/sample-app-app-secrets-notice.png differ diff --git a/docs/embedded/images/vsx-images/sample-app-create-client-secret.png b/docs/embedded/images/vsx-images/sample-app-create-client-secret.png new file mode 100644 index 000000000..2bddaef4f Binary files /dev/null and b/docs/embedded/images/vsx-images/sample-app-create-client-secret.png differ diff --git a/docs/embedded/images/vsx-images/spe-sample-app-home.png b/docs/embedded/images/vsx-images/spe-sample-app-home.png new file mode 100644 index 000000000..575c8da11 Binary files /dev/null and b/docs/embedded/images/vsx-images/spe-sample-app-home.png differ diff --git a/docs/embedded/overview.md b/docs/embedded/overview.md new file mode 100644 index 000000000..9f707d52e --- /dev/null +++ b/docs/embedded/overview.md @@ -0,0 +1,72 @@ +--- +title: SharePoint Embedded Overview +description: Microsoft SharePoint Embedded is a cloud-based file and document management system suitable for use in any application. SharePoint Embedded is a new API-only solution that enables app developers to harness the power of the Microsoft 365 file and document storage platform for any app, and is suitable for enterprises building line-of-business applications and ISVs building multitenant applications. +ms.date: 08/17/2024 +ms.localizationpriority: high +--- + +# Overview of SharePoint Embedded + +Microsoft SharePoint Embedded is a cloud-based file and document management system suitable for use in any application. SharePoint Embedded is a new API-only solution that enables app developers to harness the power of the Microsoft 365 file and document storage platform for any app, and is suitable for enterprises building line-of-business applications and ISVs building multitenant applications. + +SharePoint Embedded allows you to integrate advanced Microsoft 365 features into your apps including full-featured collaborative functions from Office, Purview's security and compliance tools, and Copilot capabilities. + +> [!IMPORTANT] +> Help us shape the future of SharePoint Embedded! +> Take our [quick survey](https://forms.microsoft.com/r/1YpGd2pAUS) and share your experience! + +## App documents stay in their Microsoft 365 tenant + +When a consumer uses a SharePoint Embedded application in their Microsoft 365 tenant, SharePoint Embedded creates another partition within their tenant. This storage partition doesn't have a user experience and the documents in the partition are only accessible via APIs. This means that all documents will be accessible to the developer’s application, but the documents will only reside in the consumer’s Microsoft 365 tenant. Within this new storage partition inside of a Microsoft 365 tenant, a SharePoint Embedded application can create many "File Storage Containers" for storing content. + +## Introducing File Storage Containers + +SharePoint Embedded applications use Microsoft Graph APIs to store files and documents in a new entity called a "File Storage Container” or Container for short.  If you’re an ISV, your app will create these containers in your customer’s Microsoft 365 tenant, and if you’re an enterprise, your app will create these containers in your own tenant. Each container provides a place to store files - you can think of them as similar to an API-only Document Library in SharePoint, but with some slight differences. Your app can create many of these containers inside each tenant that uses your app, and each container can be granted permissions separately storing many files with multiple terabytes of content. + +SharePoint Embedded containers are dedicated to and accessible by just your app, so the files and documents your app depends on are isolated and secure within that tenant boundary. + +## App-managed content experiences + +By default, the content stored within a Microsoft 365 tenant by a SharePoint Embedded application is only accessible through that owning application. Applications using SharePoint Embedded also provide the user experience layer for accessing and managing content, using some of the rich content capabilities that Microsoft 365 offers such as: + +- Core content management features like support for any file type and folder structure, searching, sharing, automatic versioning, recycle-bin, and more +- Collaboration features like view, edit, and co-authoring Office Word, Excel, and PowerPoint documents in Office Web and Desktop + +SharePoint Embedded is used by several types of applications: + +- Certain Microsoft products use SharePoint Embedded to manage customer content, such as Loop and Designer. +- ISVs can use SharePoint Embedded in their apps to manage content within their customer’s Microsoft 365 tenant +- Enterprises can use SharePoint Embedded to manage and store content within their own Microsoft 365 tenant, but outside of regular Microsoft 365 entitlements + +## Consumer Microsoft 365 settings apply to app documents + +All documents stored in the SharePoint partition created by the SharePoint Embedded app are in the consumer’s Microsoft 365 tenant and therefore are subject to the consumer’s Microsoft 365 tenant settings. + +This includes settings from Microsoft Purview compliance, risk, and security settings, documents can be opened from Office clients, and customers can use the Office web clients to view and collaborate on the documents. Choosing applications that are built on SharePoint Embedded provides the app consumer Microsoft Purview security and compliance capabilities on that app content, such as: + +- eDiscovery +- Auditing +- Data loss prevention (DLP) +- Retention policies, sensitivity labels, conditional access + +## Understanding the costs and billing for SharePoint Embedded content + +Microsoft 365 customers have different entitlements related to storage, usage, and features depending on the licenses the customer has purchased. + +The partition created in the consumer’s Microsoft 365 tenant by a SharePoint Embedded app doesn’t count towards other Microsoft 365 entitlements including the total amount of Microsoft SharePoint storage that can be used by your organization. Instead, the partition in the consumer’s Microsoft 365 tenant by the SharePoint Embedded app are billed separately through an Azure subscription on a pay-as-you-go metered consumption model that’s based on total storage and the number of API calls. + +> [!NOTE] +> Learn more about billing for SharePoint Embedded, see [Billing Meters](./administration/billing/meters.md). + +## Get Started with SharePoint Embedded + +[Review the prerequisites](./administration/billing/billing.md) + +Create a "File Storage Container" in 15 minutes or less: + +- [Free trial: SharePoint Embedded for Visual Studio Code](./getting-started/spembedded-for-vscode.md) + +Follow manual set-up on SharePoint Embedded from the following Microsoft Learning modules: + +- [Microsoft Learning: SharePoint Embedded - overview & configuration](/training/modules/sharepoint-embedded-setup) +- [Microsoft Learning: SharePoint Embedded - building applications](/training/modules/sharepoint-embedded-create-app) diff --git a/docs/embedded/scenarios-and-use-cases.md b/docs/embedded/scenarios-and-use-cases.md new file mode 100644 index 000000000..2c199f287 --- /dev/null +++ b/docs/embedded/scenarios-and-use-cases.md @@ -0,0 +1,71 @@ +--- +title: Scenarios and Use Cases +description: Scenarios and Use Cases for SharePoint Embedded +ms.date: 05/21/2024 +ms.localizationpriority: high +--- + +# Scenarios and use cases for SharePoint Embedded + +Use these example scenarios to prompt ideas about how custom applications can use SharePoint Embedded. + +> [!NOTE] +> This article is not intended to be an exhaustive list of all SharePoint Embedded features and scenarios. The intention is that these scenarios are contextualized examples of how combinations of features can be used. + +## Scenario: Structured user experience + +### Description + +Where your application requires a guided user experience to make users work in a structured way, rather than the flexible experience of SharePoint. + +Where your application is enabling a business-critical or time sensitive process, use the dedicated resource allocation of SharePoint Embedded to simplify management of throttling. + +### Examples + +- Extended Relationship Management (XRM) applications +- Engagement-based applications +- Workflow-based collaboration, with defined state + +### Why use SharePoint Embedded instead of SharePoint? + +- Your application is the only user interface, allowing you to create a prescriptive user experience +- Resources are separate from your Microsoft 365 entitlements– allowing for simpler resource management. + +## Scenario: Highly controlled collaboration + +### Description + +When building applications on top of SharePoint, it will still be possible for a user with permissions to navigate to the underlying site. Based on their permission level, a user might complete actions in the SharePoint interface that weren't intended by your application, for example changing site settings. These actions might have unintended consequences for your application or content. + +Because SharePoint Embedded is headless, there's no user interface other than what is provided by your custom application. If you don't supply a method to change content or settings through your application, then it won’t be possible for a user to circumvent this through SharePoint. You have the choice for which collaborative features are available in your application, for example sharing. + +### Examples + +- Deal room applications +- Shared research environments + +### Why use SharePoint Embedded instead of SharePoint? + +- You need the collaborative capabilities of SharePoint, only via a highly customized user interface +- You're handling high-value content, where you want to manage risk by removing abilities for a user to discover or alter the content repository +- All containers for the application can share default sharing settings that are separate from your OneDrive and SharePoint settings +- Content is logically separated from other Microsoft 365 content + +## Scenario: Customer facing document upload + +### Description + +Your application is aimed at an end customer, either within your organization or externally, who needs to upload a file as part of their interaction. You require a simplified end-user experience in your custom application, along with the Microsoft 365 capabilities of document storage and compliance. + +Using SharePoint Embedded will support this scenario, while not requiring the users of your application to have access or entitlement to your Microsoft 365 tenant. + +### Examples + +- Applying evidence to mortgage application +- Identity document verification + +### Why use SharePoint Embedded instead of SharePoint? + +- It's critical to segregate this data from the rest of your Microsoft 365 storage, while still being in scope for compliance tools like eDiscovery +- No Microsoft 365 licensing is required for users, or the use of external users in SharePoint +- Containers offer a simple, flexible unit of data storage diff --git a/docs/embedded/whats-new.md b/docs/embedded/whats-new.md new file mode 100644 index 000000000..4a0ba7af0 --- /dev/null +++ b/docs/embedded/whats-new.md @@ -0,0 +1,19 @@ +--- +title: What's new in SharePoint Embedded? +description: Updates about Microsoft SharePoint Embedded. +ms.date: 06/23/2025 +ms.localizationpriority: medium +--- + +# What's new in SharePoint Embedded + +## June 2025 + +- The `CopilotEmbeddedChatHosts` container type setting is now required to use [SharePoint Embedded agent](./development/declarative-agent/spe-da-adv.md#csp-policies). It must be set by the application owner via [`Set-SPOContainerTypeConfiguration`](/powershell/module/sharepoint-online/set-spocontainertypeconfiguration) and can optionally be overridden by consuming tenant administrators via [`Set-SPOApplication`](/powershell/module/SharePoint-online/set-spoapplication). + +## May 2025 + +- The limit of container types that a partner tenant can create has been increased to 25 by default. See [Limits and Calling Patterns](./development/limits-calling.md#size-limits). +- SharePoint Embedded agent switched to a consumption-based model for all users regardless of whether they have a Copilot license or not. See [SharePoint Embedded agent](./development/declarative-agent/spe-da.md). +- The guidance on how to grant admin consent to a SharePoint Embedded application has been updated to use URL-based admin consent. See [Authentication and authorization](./development/auth.md#whats-next). +- Documented an exceptional access pattern for operations that may require a user license. See [Authentication and authorization](./development/auth.md#operations-that-require-a-user-license). diff --git a/docs/features/embed-pages-to-teams.md b/docs/features/embed-pages-to-teams.md index 50fa37b8d..a4085809f 100644 --- a/docs/features/embed-pages-to-teams.md +++ b/docs/features/embed-pages-to-teams.md @@ -1,13 +1,13 @@ --- -title: Embedding modern SharePoint pages in Microsoft Teams as personal apps (preview) +title: Embedding modern SharePoint pages in Microsoft Teams as personal apps description: SharePoint pages can be embedded as personal apps in the Microsoft Teams. -ms.date: 04/20/2021 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- -# Embedding modern SharePoint pages in Microsoft Teams as personal apps (preview) +# Embedding modern SharePoint pages in Microsoft Teams as personal apps _**Applies to:** Microsoft 365_ ->[!Important] -> When you are planning to embed SharePoint sites in Microsoft Teams, please use the [Viva Connections Desktop model](https://docs.microsoft.com/en-gb/SharePoint/viva-connections) for the optimal experience. +> [!Important] +> When you are planning to embed SharePoint sites in Microsoft Teams, please use the [Viva Connections model](/sharepoint/guide-to-setting-up-viva-connections) for the supported experience. diff --git a/docs/features/groupify/groupify-csom.md b/docs/features/groupify/groupify-csom.md index be5adaac1..32e38e055 100644 --- a/docs/features/groupify/groupify-csom.md +++ b/docs/features/groupify/groupify-csom.md @@ -1,8 +1,8 @@ --- title: Connect to new Microsoft 365 group - CSOM development description: Client-side object model development for connecting to a new Microsoft 365 group operation. -ms.date: 11/18/2020 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # Connect to new Microsoft 365 group: CSOM development @@ -23,7 +23,7 @@ You also need to reference the [Microsoft.SharePointOnline.CSOM](https://www.nug ## CSOM code example -The following example shows how to create a __Microsoft.Online.SharePoint.TenantAdministration.Tenant__ object and call the __CreateGroupForSite__ method to return a list of themes. +The following example shows how to create a __Microsoft.Online.SharePoint.TenantAdministration.Tenant__ object and call the __CreateGroupForSite__ method to return a list of themes. > [!NOTE] > * The URL used to create the context object includes the _-admin_ suffix, because **TenantAdministration** methods work with the admin site. @@ -84,6 +84,3 @@ __type:__ Microsoft.Online.SharePoint.TenantAdministration.GroupCreationParams - When using POST to update a hub site with new information, use the following additional header values: | Header | Value | @@ -63,8 +61,7 @@ For GET, no request body is needed. When using POST to update a hub site with ne #### Sample request ```HTTP -GET -https://contoso.sharepoint.com/_api/HubSites/GetById?hubSiteId='f93eff08-5806-499c-92db-38800eefbe44' +GET https://contoso.sharepoint.com/_api/HubSites/GetById?hubSiteId='f93eff08-5806-499c-92db-38800eefbe44' ``` #### Sample response @@ -73,19 +70,19 @@ https://contoso.sharepoint.com/_api/HubSites/GetById?hubSiteId='f93eff08-5806-49 ```JSON { - "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#hubsites/$entity", - "@odata.type": "#SP.HubSite", - "@odata.id": "https://contoso.sharepoint.com/_api/HubSites/GetById", - "@odata.etag": "\"3\"", - "@odata.editLink": "HubSites/GetById", - "Description": null, - "ID": "f93eff08-5806-499c-92db-38800eefbe44", - "LogoUrl": "https://contoso.sharepoint.com/sites/marketing/SiteAssets/__hubLogo____hubLogo__.png", - "SiteId": "f93eff08-5806-499c-92db-38800eefbe44", - "SiteUrl": "https://contoso.sharepoint.com/sites/marketing", - "Targets": "", - "TenantInstanceId": "00000000-0000-0000-0000-000000000000", - "Title": "" + "@odata.context": "https://contoso.sharepoint.com/_api/$metadata#hubsites/$entity", + "@odata.type": "#SP.HubSite", + "@odata.id": "https://contoso.sharepoint.com/_api/HubSites/GetById", + "@odata.etag": "\"3\"", + "@odata.editLink": "HubSites/GetById", + "Description": null, + "ID": "f93eff08-5806-499c-92db-38800eefbe44", + "LogoUrl": "https://contoso.sharepoint.com/sites/marketing/SiteAssets/__hubLogo____hubLogo__.png", + "SiteId": "f93eff08-5806-499c-92db-38800eefbe44", + "SiteUrl": "https://contoso.sharepoint.com/sites/marketing", + "Targets": "", + "TenantInstanceId": "00000000-0000-0000-0000-000000000000", + "Title": "" } ``` @@ -94,8 +91,7 @@ https://contoso.sharepoint.com/_api/HubSites/GetById?hubSiteId='f93eff08-5806-49 #### Sample request ```HTTP -POST -https://contoso.sharepoint.com/_api/HubSites/GetById?hubSiteId='f93eff08-5806-499c-92db-38800eefbe44' +POST https://contoso.sharepoint.com/_api/HubSites/GetById?hubSiteId='f93eff08-5806-499c-92db-38800eefbe44' ``` #### Sample response @@ -110,6 +106,28 @@ https://contoso.sharepoint.com/_api/HubSites/GetById?hubSiteId='f93eff08-5806-49 } ``` +### Associate a hub with another hub (parent hub association) + +#### Sample request + +```HTTP +POST https://contoso.sharepoint.com/_api/HubSites/GetById('f93eff08-5806-499c-92db-38800eefbe44') +``` + +```JSON +{ + "__metadata": { "type": "SP.HubSite" }, + "Title":"Marketing hub site", + "LogoUrl": "https://contoso.sharepoint.com/sites/marketing/SiteAssets/__hubLogo____hubLogo__.png", + "Description": "Hub site for marketing coordination", + "ParentHubSiteId":"269da5d4-6a9e-45a5-9502-a74d14977293" +} +``` + +#### Sample response + +**Status code:** 204 + ## See also - [Hub site REST API](hub-site-rest-api.md) diff --git a/docs/features/hub-site/REST-hubsitedata-method.md b/docs/features/hub-site/REST-hubsitedata-method.md index aba75ce34..9d0911b2d 100644 --- a/docs/features/hub-site/REST-hubsitedata-method.md +++ b/docs/features/hub-site/REST-hubsitedata-method.md @@ -1,8 +1,8 @@ --- title: HubSiteData REST method description: Gets hub site data for the current web. -ms.date: 6/18/2019 -localization_priority: Normal +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # HubSiteData diff --git a/docs/features/hub-site/REST-hubsites-method.md b/docs/features/hub-site/REST-hubsites-method.md index c19a5fbcd..5db692961 100644 --- a/docs/features/hub-site/REST-hubsites-method.md +++ b/docs/features/hub-site/REST-hubsites-method.md @@ -1,8 +1,8 @@ --- title: HubSites REST method description: Gets information about all hub sites that the current user can access. -ms.date: 6/18/2019 -localization_priority: Normal +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # HubSites diff --git a/docs/features/hub-site/REST-joinhubsite-method.md b/docs/features/hub-site/REST-joinhubsite-method.md index ab84427dd..0962b6db4 100644 --- a/docs/features/hub-site/REST-joinhubsite-method.md +++ b/docs/features/hub-site/REST-joinhubsite-method.md @@ -1,8 +1,8 @@ --- title: JoinHubSite REST method description: Associates a site with an existing hub site. You can also use this method to disassociate a site from a hub site. -ms.date: 6/18/2019 -localization_priority: Normal +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # JoinHubSite diff --git a/docs/features/hub-site/REST-registerhubsite.method.md b/docs/features/hub-site/REST-registerhubsite.method.md index 4ee23cc85..50a8a7d82 100644 --- a/docs/features/hub-site/REST-registerhubsite.method.md +++ b/docs/features/hub-site/REST-registerhubsite.method.md @@ -1,8 +1,8 @@ --- title: RegisterHubSite REST method description: Registers an existing site as a hub site. -ms.date: 6/18/2019 -localization_priority: Normal +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # RegisterHubSite diff --git a/docs/features/hub-site/REST-sphubsite-type.md b/docs/features/hub-site/REST-sphubsite-type.md index 394429cf4..36cfaad0d 100644 --- a/docs/features/hub-site/REST-sphubsite-type.md +++ b/docs/features/hub-site/REST-sphubsite-type.md @@ -1,8 +1,8 @@ --- title: SPHubSite object type -description: Contains data describing a SharePoint hub site. -ms.date: 6/18/2019 -localization_priority: Normal +description: The SPHubSite object type contains data describing a SharePoint hub site. +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # SPHubSite object type diff --git a/docs/features/hub-site/REST-sphubsitedata-type.md b/docs/features/hub-site/REST-sphubsitedata-type.md index 45014adc6..6457fbd56 100644 --- a/docs/features/hub-site/REST-sphubsitedata-type.md +++ b/docs/features/hub-site/REST-sphubsitedata-type.md @@ -1,8 +1,8 @@ --- title: SPHubSiteData object type -description: Contains data describing a SharePoint hub site. -ms.date: 6/18/2019 -localization_priority: Normal +description: The SPHubSiteData object type contains data describing a SharePoint hub site. +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # SPHubSiteData object type diff --git a/docs/features/hub-site/REST-synchubsitetheme-method.md b/docs/features/hub-site/REST-synchubsitetheme-method.md index 545e974ba..9980cfe9d 100644 --- a/docs/features/hub-site/REST-synchubsitetheme-method.md +++ b/docs/features/hub-site/REST-synchubsitetheme-method.md @@ -1,13 +1,13 @@ --- title: SyncHubSiteTheme REST method description: Applies any theme updates from the parent hub site. -ms.date: 6/18/2019 -localization_priority: Normal +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # SyncHubSiteTheme -Applies any theme updates from the parent hub site. +Applies any theme updates from the parent hub site. ## HTTP request diff --git a/docs/features/hub-site/REST-unregisterhubsite-method.md b/docs/features/hub-site/REST-unregisterhubsite-method.md index 787f462fb..bc676626d 100644 --- a/docs/features/hub-site/REST-unregisterhubsite-method.md +++ b/docs/features/hub-site/REST-unregisterhubsite-method.md @@ -1,16 +1,13 @@ --- title: UnRegisterHubSite REST method description: Unregisters a hub site so that it is no longer a hub site. -ms.date: 4/20/2018 -localization_priority: Normal +ms.date: 06/28/2022 +ms.localizationpriority: medium --- # UnRegisterHubSite -> [!IMPORTANT] -> The hub sites feature is currently in preview and is subject to change. It is not currently supported for use in production environments. - -Unregisters a hub site so that it is no longer a hub site. It will become a regular site. Any sites associated with the hub site will no longer be associated. This can take up to an hour to propagate. If you want to speed up the process, first remove any associated sites before unregistering the hub site. +Unregisters a hub site so that it is no longer a hub site. It will become a regular site. Any sites associated with the hub site will no longer be associated. This can take up to an hour to propagate. If you want to speed up the process, first remove any associated sites before unregistering the hub site. ## HTTP request diff --git a/docs/features/hub-site/create-hub-site-with-powershell.md b/docs/features/hub-site/create-hub-site-with-powershell.md index e5fb0bb06..16c183783 100644 --- a/docs/features/hub-site/create-hub-site-with-powershell.md +++ b/docs/features/hub-site/create-hub-site-with-powershell.md @@ -1,23 +1,24 @@ --- title: Create SharePoint hub sites using PowerShell description: Example code for creating a SharePoint hub site by using PowerShell. -ms.date: 11/18/2020 -localization_priority: Priority +ms.date: 04/23/2025 +ms.localizationpriority: high --- # Create SharePoint hub sites by using PowerShell If you're a global or SharePoint admin in Office 365, you can convert any existing site to a hub site by using Microsoft PowerShell. In this example, you'll learn how to create a SharePoint hub site and to associate another site with it. In this scenario, you are setting up sites for the Contoso marketing department: + - You will create a hub site that all other marketing sites will be associated with. - You will then specify settings and permissions for the hub site. -- Finally, you will create a second site and associate it with the hub site. +- Finally, you will create a second site and associate it with the hub site. > [!NOTE] > To work with this example in SharePoint Online, we recommend that you use a developer tenant and not your production tenant. All of the following steps use a fictional tenant named "Contoso" that you can replace with your tenant name. ## Using PnP PowerShell -The samples below can be performed using [PnP PowerShell](https://www.powershellgallery.com/packages/SharePointPnPPowerShellOnline). +The samples below can be performed using [PnP PowerShell](https://www.powershellgallery.com/packages/PnP.PowerShell). > [!NOTE] > In the remainder of this exercise, **contoso** will be used as the tenant name. Continue to use your own tenant name in place of **contoso**. @@ -28,29 +29,29 @@ The samples below can be performed using [PnP PowerShell](https://www.powershell First, we will create the marketing site that will serve as a hub site that other sites can associate with. The intent is that any sites that are marketing-oriented will be part of the hub site. This applies common navigation and branding across the associated sites, enables team members to search across all the sites associated with the single hub site, and takes advantage of other hub site features. -1. Connect to the SharePoint Online Admin center using: +1. Connect to the SharePoint Online Admin center using interactive login and [registered Azure AD (Entra ID)](https://pnp.github.io/powershell/articles/registerapplication.html) application: - ```powershell - Connect-PnPOnline -Url https://contoso-admin.sharepoint.com -UseWebLogin - ``` + ```powershell + Connect-PnPOnline -Url https://contoso-admin.sharepoint.com -Interactive -ClientId + ``` -2. Create the site to be used as a hub site using the [New-PnPSite](https://docs.microsoft.com/powershell/module/sharepoint-pnp/new-pnpsite) cmdlet: +1. Create the site to be used as a hub site using the [New-PnPSite](https://pnp.github.io/powershell/cmdlets/New-PnPSite.html) cmdlet: - ```powershell - New-PnPSite -Type TeamSite -Title "Contoso marketing division" -Alias "marketing" -Description "Main site for collaboration for marketing teams at Contoso" - ``` + ```powershell + New-PnPSite -Type TeamSite -Title "Contoso marketing division" -Alias "marketing" -Description "Main site for collaboration for marketing teams at Contoso" + ``` - The cmdlet returns the URL of the new site similar to the following: + The cmdlet returns the URL of the new site similar to the following: - ``` - https://contoso.sharepoint.com/sites/marketing - ``` + ```http + https://contoso.sharepoint.com/sites/marketing + ``` -3. Register the new marketing site as a hub site by using the [Register-SPOHubSite](https://docs.microsoft.com/powershell/module/sharepoint-online/register-spohubsite?view=sharepoint-ps) cmdlet: +1. Register the new marketing site as a hub site by using the [Register-PnPHubSite](https://pnp.github.io/powershell/cmdlets/Register-PnPHubSite.html) cmdlet: - ```powershell - Register-SPOHubSite -Site https://contoso.sharepoint.com/sites/marketing - ``` + ```powershell + Register-PnPHubSite -Site https://contoso.sharepoint.com/sites/marketing + ``` ## Set properties and permissions on the hub site @@ -58,58 +59,56 @@ The hub site doesn't have a logo or description yet. We also want to constrain i ### Set properties -1. Upload a logo image for the site by going to `https://contoso.sharepoint.com/sites/marketing/SiteAssets` and uploading any image you like. Make a note of the image file name. - -2. Use the [Set-PnPHubSite](https://docs.microsoft.com/powershell/module/sharepoint-pnp/set-pnphubsite) cmdlet to set the logo and description. In place of `mylogo.jpg`, specify the name of the image that you uploaded: +1. Upload a logo image for the site by going to `https://contoso.sharepoint.com/sites/marketing/SiteAssets` and uploading any image you like. Make a note of the image file name. +1. Use the [Set-PnPHubSite](https://pnp.github.io/powershell/cmdlets/Set-PnPHubSite.html) cmdlet to set the logo and description. In place of `mylogo.jpg`, specify the name of the image that you uploaded: - ```powershell - Set-PnPHubSite - -Identity https://contoso.sharepoint.com/sites/marketing - -LogoUrl https://contoso.sharepoint.com/sites/marketing/SiteAssets/mylogo.jpg - -Description "Main hub site for collaboration on marketing activities across Contoso" - ``` + ```powershell + Set-PnPHubSite + -Identity https://contoso.sharepoint.com/sites/marketing + -LogoUrl https://contoso.sharepoint.com/sites/marketing/SiteAssets/mylogo.jpg + -Description "Main hub site for collaboration on marketing activities across Contoso" + ``` ### Set permissions Now we will restrict access so that only the user `nestorw@contoso.com` can make changes to the hub site associations. -- Run the [Grant-PnPHubSiteRights](https://docs.microsoft.com/powershell/module/sharepoint-pnp/grant-pnphubsiterights) cmdlet to grant a user rights to the marketing hub site. We'll use `nestorw@contoso` in this example, but you can use any valid user on your tenant (you can specify multiple users by separating them with a comma): +- Run the [Grant-PnPHubSiteRights](https://pnp.github.io/powershell/cmdlets/Grant-PnPHubSiteRights.html) cmdlet to grant a user rights to the marketing hub site. We'll use `nestorw@contoso` in this example, but you can use any valid user on your tenant (you can specify multiple users by separating them with a comma): - ```powershell - Grant-PnPHubSiteRights -Identity https://contoso.sharepoint.com/sites/marketing -Principals "nestorw@contoso" -Rights Join - ``` + ```powershell + Grant-PnPHubSiteRights -Identity https://contoso.sharepoint.com/sites/marketing -Principals "nestorw@contoso" + ``` ## Create and associate a new site The final step is to create the site we want to associate with the hub. You can repeat these steps for as many sites as you want to join to the hub. -1. Provision the site by using the [New-PnPSite](https://docs.microsoft.com/powershell/module/sharepoint-pnp/new-pnpsite) cmdlet: - - ```powershell - New-PnPSite -Type TeamSite -Title "Online advertising team" -Alias "online-advertising" -Description "For collaboration on online advertising resources" - ``` - - The cmdlet returns the URL of the new site similar to the following: - - ``` +1. Provision the site by using the [New-PnPSite](https://pnp.github.io/powershell/cmdlets/New-PnPSite.html) cmdlet: + + ```powershell + New-PnPSite -Type TeamSite -Title "Online advertising team" -Alias "online-advertising" -Description "For collaboration on online advertising resources" + ``` + + The cmdlet returns the URL of the new site similar to the following: + + ```http: https://contoso.sharepoint.com/sites/online-advertising - ``` - -2. Associate this site with the hub site by using the [Add-PnPHubSiteAssociation](https://docs.microsoft.com/powershell/module/sharepoint-pnp/add-pnphubsiteassociation) cmdlet: - - ```powershell - Add-PnPHubSiteAssociation - -Site https://contoso.sharepoint.com/sites/online-advertising - -HubSite https://contoso.sharepoint.com/sites/marketing - ``` + ``` + +1. Associate this site with the hub site by using the [Add-PnPHubSiteAssociation](https://pnp.github.io/powershell/cmdlets/Add-PnPHubSiteAssociation.html) cmdlet: + + ```powershell + Add-PnPHubSiteAssociation + -Site https://contoso.sharepoint.com/sites/online-advertising + -HubSite https://contoso.sharepoint.com/sites/marketing + ``` ## Confirm the hub site is working To confirm, you can either: -- Run the [Get-PnPHubSite](https://docs.microsoft.com/powershell/module/sharepoint-pnp/get-pnphubsite) cmdlet. - -- Sign in to SharePoint Online and view the hub site directly at `https://contoso.sharepoint.com/sites/marketing`. +- Run the [Get-PnPHubSite](https://pnp.github.io/powershell/cmdlets/Get-PnPHubSite.html) cmdlet. +- Sign in to SharePoint Online and view the hub site directly at `https://contoso.sharepoint.com/sites/marketing`. The hub site navigation appears at the top of the site. If you go to the `https://contoso.sharepoint.com/sites/online-advertising` site, it shows the same hub site navigation at the top. diff --git a/docs/features/hub-site/hub-site-o365cli.md b/docs/features/hub-site/hub-site-o365cli.md index 6dd2830a2..2ecea1787 100644 --- a/docs/features/hub-site/hub-site-o365cli.md +++ b/docs/features/hub-site/hub-site-o365cli.md @@ -1,8 +1,8 @@ --- title: CLI for Microsoft 365 commands for SharePoint hub sites description: Use CLI for Microsoft 365 to create and manage SharePoint hub sites. -ms.date: 06/05/2020 -localization_priority: Priority +ms.date: 06/27/2024 +ms.localizationpriority: high --- # CLI for Microsoft 365 commands for SharePoint hub sites @@ -16,10 +16,8 @@ Use the CLI for Microsoft 365 commands to create and manage SharePoint hub sites To run the CLI for Microsoft 365 commands, you'll need to do the following: 1. Download and install [NodeJS LTS version](https://nodejs.org/en/) - -2. Follow the instructions at [Installing the CLI](https://pnp.github.io/cli-microsoft365/user-guide/installing-cli/) to install the CLI for Microsoft 365 on your machine - -3. Follow the instructions at [Logging in to Office 365](https://pnp.github.io/cli-microsoft365/user-guide/connecting-office-365/) to connect to your SharePoint tenant. +1. Follow the instructions at [Installing the CLI](https://pnp.github.io/cli-microsoft365/user-guide/installing-cli/) to install the CLI for Microsoft 365 on your machine +1. Follow the instructions at [Logging in to Office 365](https://pnp.github.io/cli-microsoft365/user-guide/connecting-microsoft-365) to connect to your SharePoint tenant. To verify your setup and connection, try using the [hubsite list](https://pnp.github.io/cli-microsoft365/cmd/spo/hubsite/hubsite-list/) command to list the current hub sites. If the cmdlet runs and returns with no errors, you're ready to proceed. @@ -38,7 +36,7 @@ The following commands are available for managing hub sites: |[hubsite rights grant](https://pnp.github.io/cli-microsoft365/cmd/spo/hubsite/hubsite-rights-grant)| Grants permissions to join the hub site for one or more principals | |[hubsite rights revoke](https://pnp.github.io/cli-microsoft365/cmd/spo/hubsite/hubsite-rights-revoke)| Revokes rights to join sites to the specified hub site for one or more principals | |[hubsite set](https://pnp.github.io/cli-microsoft365/cmd/spo/hubsite/hubsite-set)| Updates properties of the specified hub site | -|[hubsite theme sync](https://pnp.github.io/cli-microsoft365/cmd/spo/hubsite/hubsite-theme-sync)| Applies any theme updates from the parent hub site. | +|[hubsite theme sync](https://pnp.github.io/cli-microsoft365/cmd/spo/site/site-hubsite-theme-sync)| Applies any theme updates from the parent hub site. | |[hubsite unregister](https://pnp.github.io/cli-microsoft365/cmd/spo/hubsite/hubsite-unregister)| Unregisters the specifies site collection as a hub site | ## See also diff --git a/docs/features/hub-site/hub-site-overview.md b/docs/features/hub-site/hub-site-overview.md index 78f7c00ad..dff8662cc 100644 --- a/docs/features/hub-site/hub-site-overview.md +++ b/docs/features/hub-site/hub-site-overview.md @@ -1,8 +1,8 @@ --- title: SharePoint hub sites overview description: SharePoint hub sites connect and organize sites based on organizational attributes such as project, department, division, or region. -ms.date: 4/20/2018 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # SharePoint hub sites overview @@ -17,7 +17,7 @@ For more information about creating hub sites, see [Create SharePoint hub sites - We recommend that you select a communication site or a team site that uses the modern template. If you use a classic team site, the hub site navigation will only appear on modern pages, including document libraries, lists, and site contents. Hub site settings will only appear on modern pages. -- You can create up to 2000 hub sites for an organization. +- You can create up to 2000 hub sites for an organization. - If you set up [SharePoint Multi-Geo](../../solution-guidance/multigeo-introduction.md) for your organization, any geo location where the SharePoint workload is available can be associated with a hub site. diff --git a/docs/features/hub-site/hub-site-powershell.md b/docs/features/hub-site/hub-site-powershell.md index fc59f998c..58fa78c4d 100644 --- a/docs/features/hub-site/hub-site-powershell.md +++ b/docs/features/hub-site/hub-site-powershell.md @@ -1,8 +1,8 @@ --- title: PowerShell cmdlets for SharePoint hub sites description: Use PowerShell cmdlets to create and manage SharePoint hub sites. -ms.date: 6/18/2019 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # PowerShell cmdlets for SharePoint hub sites @@ -14,8 +14,7 @@ Use PowerShell cmdlets to create and manage SharePoint hub sites. To run the PowerShell cmdlets: 1. Download and install the [SharePoint Online Management Shell](https://www.microsoft.com/download/details.aspx?id=35588). If you already have a previous version of the shell installed, uninstall it first, and then install the latest version. - -2. Follow the instructions at [Connect to SharePoint Online PowerShell](https://technet.microsoft.com/library/fp161372.aspx) to connect to your SharePoint tenant. +1. Follow the instructions at [Connect to SharePoint Online PowerShell](https://technet.microsoft.com/library/fp161372.aspx) to connect to your SharePoint tenant. To verify your setup, try using the **Get-SPOHubSite** cmdlet to read the current list of hub sites. If the cmdlet runs and returns with no errors, you're ready to proceed. @@ -25,14 +24,14 @@ The following PowerShell cmdlets are available for managing hub sites: |cmdlet|Description| |------|-----------| -|[Add-SPOHubSiteAssociation](https://docs.microsoft.com/powershell/module/sharepoint-online/add-spohubsiteassociation?view=sharepoint-ps)|Adds a new association between a site and a hub site.| -|[Remove-SPOHubSiteAssociation](https://docs.microsoft.com/powershell/module/sharepoint-online/remove-spohubsiteassociation?view=sharepoint-ps)|Removes an association between a site and a hub site.| -|[Get-SPOHubSite](https://docs.microsoft.com/powershell/module/sharepoint-online/get-spohubsite?view=sharepoint-ps)|Lists hub sites or hub site information.| -|[Grant-SPOHubSiteRights](https://docs.microsoft.com/powershell/module/sharepoint-online/grant-spohubsiterights?view=sharepoint-ps)|Grants rights to users or security groups to access the hub site.| -|[Register-SPOHubSite](https://docs.microsoft.com/powershell/module/sharepoint-online/register-spohubsite?view=sharepoint-ps)|Enables the hub site feature on a site to make it a hub site.| -|[Revoke-SPOHubSiteRights](https://docs.microsoft.com/powershell/module/sharepoint-online/revoke-spohubsiterights?view=sharepoint-ps)|Revokes rights for specified principals to a hub site.| -|[Set-SPOHubSite](https://docs.microsoft.com/powershell/module/sharepoint-online/set-spohubsite?view=sharepoint-ps)|Sets the hub site information such as name, logo, and description.| -|[Unregister-SPOHubSite](https://docs.microsoft.com/powershell/module/sharepoint-online/unregister-spohubsite?view=sharepoint-ps)|Disables the hub site feature on a site.| +|[Add-SPOHubSiteAssociation](/powershell/module/sharepoint-online/add-spohubsiteassociation)|Adds a new association between a site and a hub site.| +|[Remove-SPOHubSiteAssociation](/powershell/module/sharepoint-online/remove-spohubsiteassociation)|Removes an association between a site and a hub site.| +|[Get-SPOHubSite](/powershell/module/sharepoint-online/get-spohubsite)|Lists hub sites or hub site information.| +|[Grant-SPOHubSiteRights](/powershell/module/sharepoint-online/grant-spohubsiterights)|Grants rights to users or security groups to access the hub site.| +|[Register-SPOHubSite](/powershell/module/sharepoint-online/register-spohubsite)|Enables the hub site feature on a site to make it a hub site.| +|[Revoke-SPOHubSiteRights](/powershell/module/sharepoint-online/revoke-spohubsiterights)|Revokes rights for specified principals to a hub site.| +|[Set-SPOHubSite](/powershell/module/sharepoint-online/set-spohubsite)|Sets the hub site information such as name, logo, and description.| +|[Unregister-SPOHubSite](/powershell/module/sharepoint-online/unregister-spohubsite)|Disables the hub site feature on a site.| ## See also diff --git a/docs/features/hub-site/hub-site-rest-api.md b/docs/features/hub-site/hub-site-rest-api.md index d2aa1606d..5f22dbf4b 100644 --- a/docs/features/hub-site/hub-site-rest-api.md +++ b/docs/features/hub-site/hub-site-rest-api.md @@ -1,15 +1,15 @@ --- title: Hub site REST API description: Overview of hub site REST API for creating hub sites and associating existing sites with hub sites. -ms.date: 4/20/2018 -localization_priority: Priority +ms.date: 06/28/2022 +ms.localizationpriority: high --- # Hub site REST API -You can use the SharePoint REST interface to register sites as hub sites, associate existing sites with hub sites, and obtain or update information about hub sites. +You can use the SharePoint REST interface to register sites as hub sites, associate existing sites with hub sites, and obtain or update information about hub sites. -The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option. +The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option. For details and links to code samples, see [Make batch requests with the REST APIs](../../sp-add-ins/make-batch-requests-with-the-rest-apis.md). @@ -17,7 +17,7 @@ For details and links to code samples, see [Make batch requests with the REST AP Before you get started, make sure that you're familiar with the following: -- [Get to know the SharePoint REST service](../../sp-add-ins/get-to-know-the-sharepoint-rest-service.md) +- [Get to know the SharePoint REST service](../../sp-add-ins/get-to-know-the-sharepoint-rest-service.md) - [Complete basic operations using SharePoint REST endpoints](../../sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints.md) ## REST commands @@ -50,4 +50,3 @@ To remove, or disassociate a site from a hub site, call [JoinHubSite](REST-joinh ## See also - [SharePoint hub sites overview](hub-site-overview.md) - diff --git a/docs/features/site-footer.md b/docs/features/site-footer.md index 2377244eb..eb1d37583 100644 --- a/docs/features/site-footer.md +++ b/docs/features/site-footer.md @@ -1,8 +1,8 @@ --- title: Overview of the SharePoint Site footer description: SharePoint Site footers can be used to show a logo or set of links/labels in a modern SharePoint site. They can be configured using the UI settings or by using APIs. -ms.date: 06/06/2020 -localization_priority: Priority +ms.date: 09/24/2023 +ms.localizationpriority: high --- # SharePoint Site Footer @@ -10,13 +10,15 @@ localization_priority: Priority Footers are a common branding / navigation control in websites and portals. SharePoint Communication sites will have an out-of-the box footer control, which can be controlled either using UI elements or by using APIs. This control supports following elements - 8 links or labels -- Footer logo +- Footer logo - Footer name > [!IMPORTANT] -> Footer will be enabled by default for all new communication sites after the feature is rolled out. Along with this update, the content bar (also referred to as the “social bar”) - which contains the Like, Comment, View and Save for Later icons - will be docked permanently on top of the Comments section on all modern pages and news posts. +> Footer will be enabled by default for all new communication sites after the feature is rolled out. Along with this update, the content bar (also referred to as the “social bar”) - which contains the Like, Comment, View and Save for Later icons - will be docked permanently on top of the Comments section on all modern pages and news posts. +> +> Footers don't appear in sites on mobile devices or apps. -## Sample footer +## Sample footer Following picture demonstrates a footer with a logo, footer name and labels and links. @@ -24,15 +26,16 @@ Following picture demonstrates a footer with a logo, footer name and labels and ## Controlling footer rendering using code or PowerShell -You can control the footer existence with a `FooterEnabled` property in the `Web` object. Following PowerShell scripts shows how this can be done using [PnP PowerShell cmdlets](https://docs.microsoft.com/powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets?view=sharepoint-ps): +You can control the footer existence with a `FooterEnabled` property in the `Web` object. Following PowerShell scripts shows how this can be done using [PnP PowerShell cmdlets](/powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets): ```powershell -Connect-PnPOnline -Url "" –Credentials (Get-Credential) -Set-PnPFooter -Enabled:$false +Connect-PnPOnline -Url "" –Credentials (Get-Credential) +Set-PnPFooter -Enabled:$false # for disabling the footer +Set-PnPFooter -Enabled:$true # for enabling the footer ``` > [!NOTE] -> Above PowerShell scripts assumes that you have already installed PnP PowerShell cmdlets for your environment and you are not using multi-factor authentication. You can install PnP PowerShell cmdlets to your computer by opening PowerShell console in administrative mode and executing following command: `Install-Module SharePointPnPPowerShellOnline`. If you are using multi-factor authentication, you can enable MFA login by updating the `Connect-PnPOnline` line as follows: `Connect-PnPOnline -Url "" -UseWebLogin`. +> Above PowerShell scripts assumes that you have already installed PnP PowerShell cmdlets for your environment and you are not using multi-factor authentication. You can install PnP PowerShell cmdlets to your computer by opening PowerShell console in administrative mode and executing following command: `Install-Module PnP.PowerShell -Scope CurrentUser`. If you are using multi-factor authentication, you can enable MFA login by updating the `Connect-PnPOnline` line as follows: `Connect-PnPOnline -Url "" -Interactive`. [!INCLUDE [pnp-powershell](../../includes/snippets/open-source/pnp-powershell.md)] diff --git a/docs/general-development/access-sharepoint-from-mobile-and-native-device-apps.md b/docs/general-development/access-sharepoint-from-mobile-and-native-device-apps.md index f255dbbfb..bc4e82403 100644 --- a/docs/general-development/access-sharepoint-from-mobile-and-native-device-apps.md +++ b/docs/general-development/access-sharepoint-from-mobile-and-native-device-apps.md @@ -1,9 +1,9 @@ --- title: Access SharePoint from mobile and native device apps -ms.date: 05/01/2020 -ms.prod: sharepoint +description: Describes how to access Sharepoint from mobile apps and other native device apps, and from external web applications. +ms.date: 06/10/2022 ms.assetid: 42014171-5ee5-421d-9cde-413efc3aecef -localization_priority: Priority +ms.localizationpriority: high --- @@ -16,7 +16,7 @@ SharePoint Add-ins, farm solutions, and "no code" sandboxed solutions are all ru > [!IMPORTANT] -> To test and debug on any platform, you need a **developer account on Office 365**. More info: [Set up a development environment for SharePoint Add-ins on Office 365](https://msdn.microsoft.com/library/b22ce52a-ae9e-4831-9b68-c9210af6dc54%28Office.15%29.aspx) or [Create a developer site on an existing Office 365 subscription](https://msdn.microsoft.com/library/2ec857d5-dc6f-4cf6-ba45-adc845ef2a25%28Office.15%29.aspx). +> To test and debug on any platform, you need a **developer account on Office 365**. More info: [Set up a development environment for SharePoint Add-ins on Office 365](/sharepoint/dev/sp-add-ins/set-up-a-development-environment-for-sharepoint-add-ins-on-office-365) or [Create a developer site on an existing Office 365 subscription](https://msdn.microsoft.com/library/2ec857d5-dc6f-4cf6-ba45-adc845ef2a25%28Office.15%29.aspx). @@ -76,5 +76,4 @@ You can build these apps on the ASP.NET platform or a non-Microsoft stack. If yo These apps **gain authorized access to SharePoint data by using access tokens** that are issued by the Azure Control Service (ACS) in compliance with the OAuth Authentication Code flow. For more, see [Authorization Code OAuth flow for SharePoint Add-ins](https://msdn.microsoft.com/library/e89e91c7-ea39-49b9-af5a-7f047a7e2ab7%28Office.15%29.aspx). -> [!IMPORTANT] -> Azure Access Control (ACS), a service of Azure Active Directory (Azure AD), will be retired on November 7, 2018. This retirement does not impact the SharePoint Add-in model, which uses the `https://accounts.accesscontrol.windows.net` hostname (which is not impacted by this retirement). For more information, see [Impact of Azure Access Control retirement for SharePoint Add-ins](https://developer.microsoft.com/office/blogs/impact-of-azure-access-control-deprecation-for-sharepoint-add-ins). +[!INCLUDE [azure-acs-retirement](../../includes/snippets/azure-acs-deprecation.md)] diff --git a/docs/general-development/accessibility-in-sharepoint.md b/docs/general-development/accessibility-in-sharepoint.md index 190af8800..ea9313596 100644 --- a/docs/general-development/accessibility-in-sharepoint.md +++ b/docs/general-development/accessibility-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Accessibility in SharePoint +description: Learn about the features, products, and services that make SharePoint accessible for people with disabilities, and find developer resources that can help you design and build apps and websites that support key accessibility scenarios. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: c9106d47-c523-49c1-b9f1-cdd7420abd5e -localization_priority: Normal +ms.localizationpriority: medium --- @@ -37,7 +37,7 @@ Users who have site administrator responsibilities typically use the SharePoint -Users who have devices that support touch can use gestures to complete operations. For more information, see [Touch](https://docs.microsoft.com/windows/desktop/uxguide/inter-touch) on MSDN, and the [Office Touch Guide](https://office.microsoft.com/support/office-touch-guide-HA102823845.aspx) on Office.com. +Users who have devices that support touch can use gestures to complete operations. For more information, see [Touch](/windows/desktop/uxguide/inter-touch) on MSDN, and the [Office Touch Guide](https://office.microsoft.com/support/office-touch-guide-HA102823845.aspx) on Office.com. diff --git a/docs/general-development/accessing-a-schema.md b/docs/general-development/accessing-a-schema.md index 817750de0..09e945d3b 100644 --- a/docs/general-development/accessing-a-schema.md +++ b/docs/general-development/accessing-a-schema.md @@ -1,9 +1,9 @@ --- title: Accessing a Schema -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This topic shows one example of how you can access and look at a schema for the REST service in Excel Services. +ms.date: 06/03/2022 ms.assetid: 02613912-36f6-4edc-a915-165d12e60bc8 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/accessing-the-soap-api.md b/docs/general-development/accessing-the-soap-api.md index bf09a3c35..5486a00fe 100644 --- a/docs/general-development/accessing-the-soap-api.md +++ b/docs/general-development/accessing-the-soap-api.md @@ -1,12 +1,12 @@ --- title: Accessing the SOAP API -ms.date: 09/25/2017 +description: The SOAP API consists of methods and a set of complex type objects that you can use to access the complete functionality of Excel Web Services. +ms.date: 06/03/2022 keywords: soap f1_keywords: - soap -ms.prod: sharepoint ms.assetid: 36e8e3d5-83ac-4bd3-b556-1af132add3eb -localization_priority: Priority +ms.localizationpriority: high --- @@ -58,7 +58,7 @@ The following table describes each element in the URL. |:-----|:-----| | _server_
|The name of the server on which Microsoft SharePoint Server 2010 is deployed.
| | _customsite_
|A custom SharePoint Server 2010 site that the server administrator creates.
| -| _.asmx_
|The name of the Web service endpoint. For Excel Web Services, it is `ExcelService.asmx`.
| +| _\.asmx_
|The name of the Web service endpoint. For Excel Web Services, it is `ExcelService.asmx`.
| For more information about the WSDL format, see the World Wide Web Consortium (W3C) WSDL specification at http://www.w3.org/TR/wsdl. diff --git a/docs/general-development/add-in-scoped-external-content-types-in-sharepoint.md b/docs/general-development/add-in-scoped-external-content-types-in-sharepoint.md index a34523ee4..9530e038b 100644 --- a/docs/general-development/add-in-scoped-external-content-types-in-sharepoint.md +++ b/docs/general-development/add-in-scoped-external-content-types-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Add-in-scoped external content types in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes external content types that are installed or scoped at the add-in level in SharePoint and enable you to create data-rich SharePoint Add-ins using external data sources. +ms.date: 06/10/2022 ms.assetid: a34cbbba-dc38-4d3d-b796-d54b5848bdfb -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/add-sharepoint-capabilities.md b/docs/general-development/add-sharepoint-capabilities.md index 04de43627..8e62f2328 100644 --- a/docs/general-development/add-sharepoint-capabilities.md +++ b/docs/general-development/add-sharepoint-capabilities.md @@ -1,9 +1,9 @@ --- title: Add SharePoint capabilities -ms.date: 09/25/2017 -ms.prod: sharepoint +ms.date: 06/13/2022 +description: Describes how-to information about adding SharePoint features and capabilities to custom apps. ms.assetid: 11ecb65e-6dc5-4cf1-80ca-3c16418697b6 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/advanced-scenarios-and-additional-samples.md b/docs/general-development/advanced-scenarios-and-additional-samples.md index 87098e3c4..e24df89fa 100644 --- a/docs/general-development/advanced-scenarios-and-additional-samples.md +++ b/docs/general-development/advanced-scenarios-and-additional-samples.md @@ -1,9 +1,9 @@ --- title: Advanced Scenarios and Additional Samples +description: This topic describes some advanced REST scenarios and additional samples. It provides links to webpages where you can get more detailed information. ms.date: 01/14/2021 -ms.prod: sharepoint ms.assetid: 110bcc88-2b55-4d80-ab5c-dc3b9658e48d -localization_priority: Normal +ms.localizationpriority: medium --- # Advanced Scenarios and Additional Samples @@ -22,12 +22,12 @@ The [Using Advanced REST Functionality with the Excel Services Gadget](https:// ## Embedding Workbook Data -The [Excel Services REST API Examples](https://www.microsoft.com/en-us/microsoft-365/blog/2009/11/09/excel-services-in-sharepoint-2010-rest-api-examples/) sample shows you how to use the REST API to embed workbook data in interesting ways. +The [Excel Services REST API Examples](https://www.microsoft.com/microsoft-365/blog/2009/11/09/excel-services-in-sharepoint-2010-rest-api-examples/) sample shows you how to use the REST API to embed workbook data in interesting ways. ## More REST API Syntax Examples -The [Excel Services REST API Syntax](https://www.microsoft.com/en-us/microsoft-365/blog/2009/11/05/excel-services-in-sharepoint-2010-rest-api-syntax/) blog entry provides additional Excel Services REST API syntax examples. +The [Excel Services REST API Syntax](https://www.microsoft.com/microsoft-365/blog/2009/11/05/excel-services-in-sharepoint-2010-rest-api-syntax/) blog entry provides additional Excel Services REST API syntax examples. ## Ideas About How to Take Advantage of the REST API -The [Excel Services REST API Examples](https://www.microsoft.com/en-us/microsoft-365/blog/2009/11/04/simple-access-to-spreadsheet-data-using-the-excel-services-2010-rest-api/) blog entry provides additional ideas about what you can do with the REST API in Excel Services. +The [Excel Services REST API Examples](https://www.microsoft.com/microsoft-365/blog/2009/11/04/simple-access-to-spreadsheet-data-using-the-excel-services-2010-rest-api/) blog entry provides additional ideas about what you can do with the REST API in Excel Services. diff --git a/docs/general-development/architecture-of-the-windows-phone-sharepoint-list-application-template.md b/docs/general-development/architecture-of-the-windows-phone-sharepoint-list-application-template.md index a97807e2e..dde454c5d 100644 --- a/docs/general-development/architecture-of-the-windows-phone-sharepoint-list-application-template.md +++ b/docs/general-development/architecture-of-the-windows-phone-sharepoint-list-application-template.md @@ -1,9 +1,9 @@ --- title: Architecture of the Windows Phone SharePoint List Application template -ms.date: 09/25/2017 -ms.prod: sharepoint +ms.date: 06/13/2022 +description: Describes the design pattern of projects created from the Windows Phone SharePoint List Application template. ms.assetid: 2c09bd02-bed0-4293-a4d4-1778692e246a -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/authentication-authorization-and-security-in-sharepoint.md b/docs/general-development/authentication-authorization-and-security-in-sharepoint.md index a1c2076f8..c4459f33b 100644 --- a/docs/general-development/authentication-authorization-and-security-in-sharepoint.md +++ b/docs/general-development/authentication-authorization-and-security-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Authentication, authorization, and security in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +ms.date: 06/13/2022 +description: Describes some of the enhancements added to SharePoint including updates in authentication, authorization, and security. ms.assetid: 8734790c-eb75-4d78-9604-7cc23b33b693 -localization_priority: Priority +ms.localizationpriority: high --- @@ -22,7 +22,7 @@ The following are some of the enhancements added to SharePoint: - SharePoint continues to offer support for both claims and classic authentication modes. Claims authentication is the default authentication option in SharePoint. Classic-mode authentication is deprecated and can be managed only by using Windows PowerShell. A lot of features in SharePoint require claims-mode. - - The **MigrateUsers** method from SharePoint 2010 is now deprecated, it's no longer the correct way to migrate accounts. To migrate accounts, use the new Windows PowerShell cmdlet called `Convert-SPWebApplication`. For more information see [Migrate from classic-mode to claims-based authentication in SharePoint](https://docs.microsoft.com/sharepoint/upgrade-and-update/migrate-from-classic-mode-to-claims-based-authentication-in-sharepoint-2013). + - The **MigrateUsers** method from SharePoint 2010 is now deprecated, it's no longer the correct way to migrate accounts. To migrate accounts, use the new Windows PowerShell cmdlet called `Convert-SPWebApplication`. For more information see [Migrate from classic-mode to claims-based authentication in SharePoint](/sharepoint/upgrade-and-update/migrate-from-classic-mode-to-claims-based-authentication-in-sharepoint-2013). - Requirement to register claims providers is eliminated. However, you do have to pre-configure claims type. You can choose the characters for the claim type and there is no enforcement on the ordering of claim types. diff --git a/docs/general-development/authorization-users-groups-and-the-object-model-in-sharepoint.md b/docs/general-development/authorization-users-groups-and-the-object-model-in-sharepoint.md index ad2a82133..c18a7e6da 100644 --- a/docs/general-development/authorization-users-groups-and-the-object-model-in-sharepoint.md +++ b/docs/general-development/authorization-users-groups-and-the-object-model-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Authorization, users, groups, and the object model in SharePoint -ms.date: 11/15/2018 -ms.prod: sharepoint +ms.date: 06/13/2022 +description: Describes authorization, users, groups, and the object model in SharePoint. ms.assetid: aacf3398-f0b5-48cb-9071-440b4c3a9dd1 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/basic-uri-structure-and-path.md b/docs/general-development/basic-uri-structure-and-path.md index 119f42f09..86c10a404 100644 --- a/docs/general-development/basic-uri-structure-and-path.md +++ b/docs/general-development/basic-uri-structure-and-path.md @@ -1,179 +1,92 @@ --- title: Basic URI Structure and Path -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This article provides a link explaining how to construct the URI structure and path for REST service commands in Excel Services. +ms.date: 06/07/2022 ms.assetid: d73cf6c2-0677-4726-8a3e-2ad130e1a12c -localization_priority: Priority +ms.localizationpriority: high --- # Basic URI Structure and Path This topic explains how to construct the URI structure and path for REST service commands in Excel Services. - + > [!NOTE] -> -> The Excel Services REST API applies to SharePoint and SharePoint 2016 on-premises. For Office 365 Education, Business, and Enterprise accounts, use the Excel REST APIs that are part of the [Microsoft Graph](http://graph.microsoft.io/docs/api-reference/v1.0/resources/excel +> +> The Excel Services REST API applies to SharePoint and SharePoint 2016 on-premises. For Office 365 Education, Business, and Enterprise accounts, use the Excel REST APIs that are part of the [Microsoft Graph](https://graph.microsoft.io/docs/api-reference/v1.0/resources/excel ) endpoint. - - - - ## Basic URL Structure and Path -The REST API in Excel Services gives you the ability to access resources like charts, PivotTables, tables, and named ranges in a workbook directly through a URL. Each REST URL in Excel Services is built of three parts. Following is the basic structure of the URL to access the resources in a workbook: - - - +The REST API in Excel Services gives you the ability to access resources like charts, PivotTables, tables, and named ranges in a workbook directly through a URL. Each REST URL in Excel Services is built of three parts. Following is the basic structure of the URL to access the resources in a workbook: 1. **REST aspx Page URI** The entry point to an .aspx page - - -2. **Workbook Location** The path to the workbook - - -3. **Resource Location** The path to the requested resource inside the workbook - - -Following is the construct for the REST URL to a specific element in a workbook: - - - - +1. **Workbook Location** The path to the workbook +1. **Resource Location** The path to the requested resource inside the workbook +Following is the construct for the REST URL to a specific element in a workbook: -``` - +```http http:///_vti_bin/ExcelRest.aspx/// ``` Following is an example of how a REST URL in Excel Services looks with all three parts combined. In this example, the REST URL is accessing a workbook called "sampleWorkbook.xlsx" that contains a chart called "SampleChart": - - - - - -``` +```http http:///_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart') ``` -The workbook is stored in a document library. The full path to the workbook is `http://` __ `/Docs/Documents/sampleWorkbook.xlsx`. - - - +The workbook is stored in a document library. The full path to the workbook is `http://` _\_ `/Docs/Documents/sampleWorkbook.xlsx`. + The three parts of the REST URL are: - - - - -1. **REST aspx Page URI**: `http://` __ `/_vti_bin/ExcelRest.aspx` - - -2. **Workbook Location**: `/Docs/Documents/sampleWorkbook.xlsx` - - -3. **Resource Location**: `/model/Ranges('nameOfTheNamedRange')` - - + +1. **REST aspx Page URI**: `http://` _\_ `/_vti_bin/ExcelRest.aspx` +1. **Workbook Location**: `/Docs/Documents/sampleWorkbook.xlsx` +1. **Resource Location**: `/model/Ranges('nameOfTheNamedRange')` ### Accessing by Using the Discovery User Interface You can also access the chart by using the discovery user interface. To learn how access resources like charts, tables, PivotTables, and ranges by using the discovery mechanism shown in the following screen shot, see [Discovery in Excel Services REST API](discovery-in-excel-services-rest-api.md). - - - - - - ![Excel Services REST model URL](../images/SharePointServer14Con_XLSvcs_RESTModel.gif) - - - - - - - - - - - - - - - ### Marker Path Following is the aspx page for the REST service in Excel Services: - - - -``` +```http http:///_vti_bin/ExcelRest.aspx ``` -To access the REST service in Excel Services, you must preface the URL with `http://` __ `/_vti_bin/ExcelRest.aspx`. - - - +To access the REST service in Excel Services, you must preface the URL with `http://` _\_ `/_vti_bin/ExcelRest.aspx`. ### Workbook Location -The workbook location is the relative path to the workbook that has resources that you are interested in accessing. For example, assume that you have a workbook named sampleWorkbook.xlsx, saved to a trusted SharePoint document library. In this example, following is the path to the location of sampleWorkbook.xlsx: - - - +The workbook location is the relative path to the workbook that has resources that you are interested in accessing. For example, assume that you have a workbook named sampleWorkbook.xlsx, saved to a trusted SharePoint document library. In this example, following is the path to the location of sampleWorkbook.xlsx: -``` +```http http:///Docs/Documents/sampleWorkbook.xlsx ``` You take the relative path to the workbook ( `Docs/Documents/sampleWorkbook.xlsx`) and append it to the marker path. Following is the URL with the marker path and workbook location appended: - - - - - -``` +```http http:///_vti_bin/ExcelRest.aspx ``` - ### Resource Location The resource location is the path inside the workbook to the element that you request. For example, if you want to get a chart, the resource location would be similar to `/model/Charts('Chart 1')`. - - - -For the full URL, you append this to the marker path and the relative path to the workbook. Following is the full example URL: - - - - +For the full URL, you append this to the marker path and the relative path to the workbook. Following is the full example URL: -``` +```http http:///_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart 1') - ``` - ## See also +### Concepts -#### Concepts - - - - - - [Resources URI for Excel Services REST API](resources-uri-for-excel-services-rest-api.md) - - - - [Discovery in Excel Services REST API](discovery-in-excel-services-rest-api.md) +- [Resources URI for Excel Services REST API](resources-uri-for-excel-services-rest-api.md) +- [Discovery in Excel Services REST API](discovery-in-excel-services-rest-api.md) diff --git a/docs/general-development/bcs-client-object-model-reference-for-sharepoint.md b/docs/general-development/bcs-client-object-model-reference-for-sharepoint.md index 79242e367..802acb419 100644 --- a/docs/general-development/bcs-client-object-model-reference-for-sharepoint.md +++ b/docs/general-development/bcs-client-object-model-reference-for-sharepoint.md @@ -1,9 +1,9 @@ --- title: BCS client object model reference for SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Guidelines explaining what objects are available to create client-side scripts using the SharePoint client object model. +ms.date: 06/07/2022 ms.assetid: fe7d12a3-6ea9-47f9-b69e-f66da9e661dc -localization_priority: Normal +ms.localizationpriority: medium --- @@ -480,7 +480,7 @@ The namespace is **Microsoft.BusinessData.MetadataModel**. -- **Does the tag need to be included in a CAML query when querying an external list** +- **Does the \ tag need to be included in a CAML query when querying an external list** No. diff --git a/docs/general-development/bcs-rest-api-reference-for-sharepoint.md b/docs/general-development/bcs-rest-api-reference-for-sharepoint.md index a8469ece0..3306bb260 100644 --- a/docs/general-development/bcs-rest-api-reference-for-sharepoint.md +++ b/docs/general-development/bcs-rest-api-reference-for-sharepoint.md @@ -1,9 +1,9 @@ --- title: BCS REST API reference for SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Reference for constructing Representational State Transfer (REST) URLs using Business Connectivity Services (BCS) in SharePoint. +ms.date: 06/07/2022 ms.assetid: 364fb8d7-87d9-4be7-affd-90caba3cd0c0 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/bdc-model-schema-reference-for-sharepoint.md b/docs/general-development/bdc-model-schema-reference-for-sharepoint.md index c1629a120..f1bdccae9 100644 --- a/docs/general-development/bdc-model-schema-reference-for-sharepoint.md +++ b/docs/general-development/bdc-model-schema-reference-for-sharepoint.md @@ -1,9 +1,9 @@ --- title: BDC model schema reference for SharePoint +description: Contains reference documentation for the BDC model schema (BDCMetadata.xsd), which you can use to create external content types in SharePoint. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: 979a5ffc-f033-4e72-b2d1-11d8cb1b294a -localization_priority: Normal +ms.localizationpriority: medium --- @@ -2235,7 +2235,7 @@ The following sections describe attributes, child elements, and parent elements. |:-----|:-----| | [LocalizedDisplayNames Element in MetadataObject (BDCMetadata Schema)](https://msdn.microsoft.com/library/3202aecf-f98f-20cb-1fdd-f3a054cb24aa%28Office.15%29.aspx)
|The localized names of the parameter.
| | [Properties Element in MetadataObject (BDCMetadata Schema)](https://msdn.microsoft.com/library/9901904f-96ee-0cbb-64a9-c2aad9d72128%28Office.15%29.aspx)
|The properties of the parameter.
| -| [TypeDescriptor](https://docs.microsoft.com/dotnet/api/system.componentmodel.typedescriptor)
|The root type descriptor of the parameter.
| +| [TypeDescriptor](/dotnet/api/system.componentmodel.typedescriptor)
|The root type descriptor of the parameter.
| **Parent element** @@ -2367,7 +2367,7 @@ None | [Method Element in Methods (BDCMetadata Schema)](https://msdn.microsoft.com/library/70e87a9e-4959-0a7b-3f37-ddec36473ff4%28Office.15%29.aspx)
|| | [FilterDescriptor Element in FilterDescriptors (BDCMetadata Schema)](https://msdn.microsoft.com/library/8ce0a852-38f9-75d2-8258-27c57418f53c%28Office.15%29.aspx)
|| | [Parameter Element in Parameters (BDCMetadata Schema)](https://msdn.microsoft.com/library/811cad0b-ba71-8be0-0765-3e0dec18a0d3%28Office.15%29.aspx)
|| -| [TypeDescriptor](https://docs.microsoft.com/dotnet/api/system.componentmodel.typedescriptor)
|| +| [TypeDescriptor](/dotnet/api/system.componentmodel.typedescriptor)
|| | [TypeDescriptor Element (BDCMetadata Schema)](https://msdn.microsoft.com/library/ae423de8-c13b-aea5-d47b-17ef786fb5a7%28Office.15%29.aspx)
|| | [Association Element in MethodInstances (BDCMetadata Schema)](https://msdn.microsoft.com/library/9659a1f5-1b12-03ef-f9e3-5c9904cc5dd0%28Office.15%29.aspx)
|| | [MethodInstance Element in MethodInstances (BDCMetadata Schema)](https://msdn.microsoft.com/library/577ff9d0-706b-be7d-af5b-883e137cada8%28Office.15%29.aspx)
|| @@ -2728,7 +2728,7 @@ None |**Element**|**Description**| |:-----|:-----| | [TypeDescriptor Element (BDCMetadata Schema)](https://msdn.microsoft.com/library/ae423de8-c13b-aea5-d47b-17ef786fb5a7%28Office.15%29.aspx)
|| -| [TypeDescriptor](https://docs.microsoft.com/dotnet/api/system.componentmodel.typedescriptor)
|| +| [TypeDescriptor](/dotnet/api/system.componentmodel.typedescriptor)
|| ## See also diff --git a/docs/general-development/build-farm-solutions-in-sharepoint.md b/docs/general-development/build-farm-solutions-in-sharepoint.md index 15c1d6cc0..a0892c7e9 100644 --- a/docs/general-development/build-farm-solutions-in-sharepoint.md +++ b/docs/general-development/build-farm-solutions-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Build farm solutions in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This is an article providing links for documentation about developing, packaging and deploying build farm solutions in SharePoint. +ms.date: 06/07/2022 ms.assetid: 96c32f08-ad93-49af-b8d0-9d194a48cc79 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/build-localized-applications-for-windows-phone-based-on-the-sharepoint-templates.md b/docs/general-development/build-localized-applications-for-windows-phone-based-on-the-sharepoint-templates.md index c4c97c933..3b6e71d05 100644 --- a/docs/general-development/build-localized-applications-for-windows-phone-based-on-the-sharepoint-templates.md +++ b/docs/general-development/build-localized-applications-for-windows-phone-based-on-the-sharepoint-templates.md @@ -1,9 +1,9 @@ --- title: Build localized applications for Windows Phone based on the SharePoint templates -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Article with links to learn how to build a localizable Windows Phone app using SharePoint templates. +ms.date: 06/07/2022 ms.assetid: c12d7fd4-8c6b-446b-970b-1eb0e5d0a9b2 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/build-mobile-apps-for-other-platforms-using-sharepoint.md b/docs/general-development/build-mobile-apps-for-other-platforms-using-sharepoint.md index f85a4e682..276d2d87d 100644 --- a/docs/general-development/build-mobile-apps-for-other-platforms-using-sharepoint.md +++ b/docs/general-development/build-mobile-apps-for-other-platforms-using-sharepoint.md @@ -1,106 +1,107 @@ --- title: Build mobile apps for other platforms using SharePoint +description: Learn how to use Representational State Transfer (REST) to create a SharePoint mobile app for any platform. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: 017df869-44fb-4ffe-82fb-4654e01329ad -localization_priority: Priority +ms.localizationpriority: high --- # Build mobile apps for other platforms using SharePoint Learn how to use Representational State Transfer (REST) to create a SharePoint mobile app for any platform. + Mobile devices have become more powerful and easy to use nowadays. Laptops, netbooks, tablet PCs, and mobile phones provide workers access to the information and applications that they need to do their jobs. And developing applications for mobile devices is now easier than ever. As a result, more and more business scenarios demand integrating client applications together with their business processes. This article describes how to integrate mobile client apps together with SharePoint. You can create a mobile app to browse SharePoint content from any location and connect with SharePoint lists and libraries to access data. - - - + + + To develop a mobile app that interacts with SharePoint, you can use common services that can be accessed using open protocols. SharePoint Foundation 2010 introduced the client object models, which enabled developers to perform remote communication with SharePoint by using the web programming technology of their choice: .NET Framework, Microsoft Silverlight, or JavaScript. SharePoint introduces a Representational State Transfer (REST) service that is fully comparable to the client object models. In SharePoint, nearly every API in the client object models will have a corresponding REST endpoint. Now, developers can interact remotely with the SharePoint object model by using any technology that supports REST web requests. REST can be consumed by any programming language that you want to use for your mobile application development. You can perform basic create, read, update, and delete (CRUD) operations by using the REST interface provided by SharePoint. REST exposes all of the SharePoint entities and operations that are available in the other SharePoint client APIs. One advantage of using REST is that you don't have to add references to any SharePoint libraries or client assemblies. Instead, you make HTTP requests to the appropriate endpoints to retrieve or update SharePoint entities, such as webs, lists, and list items. For a thorough introduction to the SharePoint REST interface and its architecture, see [Use OData query operations in SharePoint REST requests](https://msdn.microsoft.com/library/d4b5c277-ed50-420c-8a9b-860342284b72%28Office.15%29.aspx). - - - + + + ## REST endpoints in SharePoint To use the REST capabilities that are built into SharePoint, you can construct a RESTful HTTP request using the Open Data Protocol (OData) standard that corresponds to the desired client object model API. The client.svc web service handles the HTTP request and serves the appropriate response, in either Atom or JavaScript Object Notation (JSON) format. The client application must then parse that response. Figure 1 shows a high-level view of the SharePoint REST architecture. - - - + + + **Figure 1. SharePoint REST architecture** - - - - - - + + + + + + ![SharePoint REST architecture](../images/SP15Con_BuildSharePointAppsForMobileDevices_Fig2.png) - - - + + + The endpoints in the SharePoint REST service correspond to the types and members in the SharePoint client object models. By using HTTP requests, you can use these REST endpoints to perform typical CRUD operations against SharePoint artifacts, such as lists and sites. - - - + + + In general: - - - + + + - Endpoints that represent read operations map to HTTP **GET** commands. - - + + - Endpoints that represent update operations map to HTTP **POST** commands. - - + + - Endpoints that represent update or insert operations map to HTTP **PUT** commands. - - + + In choosing an HTTP request to use, you should also consider the following: - - - + + + - Use **POST** to create artifacts such as lists and sites. The SharePoint REST service supports sending **POST** commands that include object definitions to endpoints that represent collections. - - + + - For **POST** operations, any properties that are not required are set to their default values. If you try to set a read-only property as part of a **POST** operation, the service returns an exception. - - + + - Use **PUT**, **PATCH**, and **MERGE** operations to update existing SharePoint objects. Any service endpoint that represents an object property **set** operation supports both **PUT** requests and **MERGE** requests. For **MERGE** requests, setting properties is optional; any properties that you do not explicitly set retain their current property. But for **PUT** commands, any properties you do not explicitly set are set to their default properties. In addition, if you do not specify all settable properties in object updates when you use HTTP **PUT** commands, the REST service returns an exception. - - + + - Use the HTTP **DELETE** command against the specific endpoint URL to delete the SharePoint object represented by that endpoint. For recyclable objects, such as lists, files, and list items, this results in a **Recycle** operation. For more information, see [Get to know the SharePoint REST service](https://msdn.microsoft.com/library/2de035a0-ac75-43bd-9665-5c5a59c4c590%28Office.15%29.aspx). - - + + ## Authenticate users to SharePoint To authenticate your mobile app with SharePoint, you can use the MS-OFBA protocol. For more information, see [[MS-OFBA]: Office Forms Based Authentication Protocol Specification](https://msdn.microsoft.com/library/30c7bbe9-b284-421f-b866-4e7ed4866027%28Office.15%29.aspx). The protocol client is configured to store and transmit cookies. The protocol client relies on the remote protocol server to set the user's identity as one or more HTTP cookies. After the user's identity is established, the client then sends each cookie with each subsequent HHT request. - - - + + + When a user signs in to SharePoint, the user's token is validated and then used to sign in to SharePoint. The user's token is a security token that is issued by an identity provider. SharePoint supports several kinds of authentication. For more information, see [Authentication, authorization, and security in SharePoint](authentication-authorization-and-security-in-sharepoint.md). To authenticate a user, you can use the REST interface. The authorization process verifies that an authenticated subject (an app or a user the app is acting on behalf of.md) has permission to perform certain operations or to access specific resources (for example, a list or a SharePoint document folder.md). - - - + + + OData lets you access a data source, such as a database, by browsing to a specially constructed URL. This allows for a simplified approach for connecting to, and working with, data sources that are hosted within an organization. OData is a protocol that uses HTTP, Atom, and JavaScript Object Notation (JSON) to enable developers to write applications that communicate with an ever-growing number of data sources. Microsoft supports the creation of this standard as a way to enable the exchange of data between applications and data stores that can be accessed from the web. The new OData connector enables SharePoint to communicate with OData providers. For more information, see [Open Data Protocol](http://www.odata.org). - - - + + + The following code demonstrates how to authenticate your app to SharePoint using REST endpoints for basic or forms-based authentication. The following code example is written in C#, but any other programming language can be used to create the Http request, as per the requirement of the platform. - - - -```cs + + + +```csharp string SharePointUrl = "https://Target SharePoint site"; @@ -118,7 +119,7 @@ void odataAt_AuthenticationCompleted(object sender, AuthenticationCompletedEvent endpointRequest.Method = "GET"; endpointRequest.Accept = "application/json;odata=verbose"; endpointRequest.CookieContainer = (sender as ODataAuthenticator).CookieContainer; - + endpointRequest.BeginGetResponse(new AsyncCallback((IAsyncResult res) => { HttpWebRequest webReq = res.AsyncState as HttpWebRequest; @@ -136,21 +137,21 @@ void odataAt_AuthenticationCompleted(object sender, AuthenticationCompletedEvent ``` To authenticate an **HttpWebrequest** to the endpoint, you should first authenticate to SharePoint with the **ODataAuthenticator** class. Before calling the **Authenticate** method, register the **ODataAuthenticator** object to the **AuthenticationCompleted** event. - - - + + + After authentication is done inside the **OnAuthenticationCompleted** event, you can use the **CookieContainer** property on the **ODataAuthenticator** object, which can be attached to the **HttpWebRequest** object to authenticate the REST calls to SharePoint. - - - + + + ## Work with SharePoint list items using REST The following example shows how to **retrieve** all of a list's items. - - - + + + ``` @@ -166,9 +167,9 @@ headers: ``` The following example shows how to **retrieve** a specific list item. - - - + + + @@ -177,7 +178,7 @@ The following example shows how to **retrieve** a specific list item. url: http://site url/_api/web/lists/GetByTitle('Test')/items(item id) method: GET headers: - + // MS-OFBA protocol return a cookie. Cookie: cookie accept: "application/json;odata=verbose" or "application/atom+xml" @@ -185,9 +186,9 @@ headers: ``` The following XML shows an example of the list item properties that are returned when you request the XML content type. - - - + + + @@ -212,13 +213,13 @@ The following XML shows an example of the list item properties that are returned ``` The following example shows how to **create** a list item. - + > [!NOTE] -> +> > To do this operation, you must know the **ListItemEntityTypeFullName** property of the list and pass that as the value of **type** in the HTTP request body. - - - + + + @@ -229,7 +230,7 @@ url: http://site url/_api/web/lists/GetByTitle('Test')/items method: POST body: { '__metadata': { 'type': 'SP.Data.TestListItem' }, 'Title': 'Test'} headers: - + // MS-OFBA protocol returns a cookie. Cookie: cookie X-RequestDigest = form digest value @@ -239,12 +240,12 @@ headers: ``` The following example shows how to **update** a list item. - + > [!NOTE] > To do this operation, you must know the **ListItemEntityTypeFullName** property of the list and pass that as the value of **type** in the HTTP request body. - - - + + + @@ -266,9 +267,9 @@ headers: ``` The following example shows how to **delete** a list item. - - - + + + @@ -286,42 +287,19 @@ headers: ``` For more information, see [Complete basic operations using SharePoint REST endpoints](https://msdn.microsoft.com/library/e3000415-50a0-426e-b304-b7de18f2f7d9%28Office.15%29.aspx). - - - + + + ## See also - - - -- [Build Windows Phone apps that access SharePoint](build-windows-phone-apps-that-access-sharepoint.md) - - -- [Using the SharePoint REST service](https://docs.microsoft.com/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service) - - -- [Build Windows Phone apps that access SharePoint](build-windows-phone-apps-that-access-sharepoint.md) - - -- [Choose the right API set in SharePoint](choose-the-right-api-set-in-sharepoint.md) - - -- [Use OData query operations in SharePoint REST requests](https://msdn.microsoft.com/library/d4b5c277-ed50-420c-8a9b-860342284b72%28Office.15%29.aspx) - - -- [Get to know the SharePoint REST service](https://msdn.microsoft.com/library/2de035a0-ac75-43bd-9665-5c5a59c4c590%28Office.15%29.aspx) - - -- [Open Data Protocol](http://www.odata.org/) - - -- [Authorization and authentication of SharePoint Add-ins](https://msdn.microsoft.com/library/bde5647a-fff1-4b51-b67b-2139de79ce4a%28Office.15%29.aspx) - - -- [Windows Phone SDK 8.0](https://www.microsoft.com/download/details.aspx?id=35471) - - -- [Microsoft SharePoint SDK for Windows Phone 8](https://www.microsoft.com/download/details.aspx?id=36818) - - +- [Build Windows Phone apps that access SharePoint](build-windows-phone-apps-that-access-sharepoint.md) +- [Get to know the SharePoint REST service](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md) +- [Build Windows Phone apps that access SharePoint](build-windows-phone-apps-that-access-sharepoint.md) +- [Choose the right API set in SharePoint](choose-the-right-api-set-in-sharepoint.md) +- [Use OData query operations in SharePoint REST requests](https://msdn.microsoft.com/library/d4b5c277-ed50-420c-8a9b-860342284b72%28Office.15%29.aspx) +- [Get to know the SharePoint REST service](https://msdn.microsoft.com/library/2de035a0-ac75-43bd-9665-5c5a59c4c590%28Office.15%29.aspx) +- [Open Data Protocol](http://www.odata.org/) +- [Authorization and authentication of SharePoint Add-ins](https://msdn.microsoft.com/library/bde5647a-fff1-4b51-b67b-2139de79ce4a%28Office.15%29.aspx) +- [Windows Phone SDK 8.0](https://www.microsoft.com/download/details.aspx?id=35471) +- [Microsoft SharePoint SDK for Windows Phone 8](https://www.microsoft.com/download/details.aspx?id=36818) diff --git a/docs/general-development/build-reusable-components-for-sharepoint.md b/docs/general-development/build-reusable-components-for-sharepoint.md index 7ff1b3bf8..2245e988a 100644 --- a/docs/general-development/build-reusable-components-for-sharepoint.md +++ b/docs/general-development/build-reusable-components-for-sharepoint.md @@ -1,9 +1,9 @@ --- title: Build reusable components for SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Article with links summarizing the most common reusable components you can build in SharePoint. +ms.date: 06/07/2022 ms.assetid: bb4467e2-57f0-4cf1-91b8-4d3d8d2358cb -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/build-sites-for-sharepoint.md b/docs/general-development/build-sites-for-sharepoint.md index 1f583c9ff..32222ca2f 100644 --- a/docs/general-development/build-sites-for-sharepoint.md +++ b/docs/general-development/build-sites-for-sharepoint.md @@ -1,9 +1,9 @@ --- title: Build sites for SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Article with links to learn about the new site authoring and publishing model for websites in SharePoint. +ms.date: 06/07/2022 ms.assetid: 3b372a63-7cdf-462a-abb4-750e611e967d -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/build-windows-phone-apps-that-access-sharepoint.md b/docs/general-development/build-windows-phone-apps-that-access-sharepoint.md index 0d46df6f8..0bcd5d7b8 100644 --- a/docs/general-development/build-windows-phone-apps-that-access-sharepoint.md +++ b/docs/general-development/build-windows-phone-apps-that-access-sharepoint.md @@ -1,38 +1,28 @@ --- title: Build Windows Phone apps that access SharePoint -ms.date: 12/22/2020 -ms.prod: sharepoint +ms.date: 06/09/2022 ms.assetid: 36681335-f772-4499-8445-f94481bc18e7 description: Create SharePoint Add-ins that integrate SharePoint and mobile devices such as Windows Phone 8 and Windows Phone 7. -localization_priority: Normal +ms.localizationpriority: medium --- - # Build Windows Phone apps that access SharePoint SharePoint provides an exciting opportunity for developers to build mobile apps that travel with users, are interactive and attractive, and are available whenever and wherever users want to work with them. You can combine Windows Phone 8 and Windows Phone 7 applications with on-premises SharePoint services and applications, or with remote SharePoint services and applications that run in the cloud (such as those that use SharePoint Online) to create powerful applications that extend the functionality beyond the traditional desktop or laptop and into a truly portable and much more accessible environment. - + The new mobility features offered by SharePoint are built on existing Microsoft tools and technologies, such as SharePoint, Windows Phone, Visual Studio, and Silverlight. Developers who are already familiar with those technologies and their related tools will be able to create SharePoint-powered mobile apps for Windows Phone without a steep learning curve. In this section, we explore some of the types of SharePoint-powered mobile apps you can build for Windows Phone 8 and Windows Phone 7 and the most common ways to customize those applications. SharePoint provides a framework and tools for developers, including Visual Studio 2010 project templates, to create mobile solutions that interact with SharePoint data both in on-premises SharePoint installations and in the cloud by using SharePoint Online. Figure 1 shows how a simple list application could look on Windows Phone. - - + **Figure 1. SharePoint list items in a Windows Phone app** ![SharePoint list items in a Windows Phone app](../images/9159345c-ce12-41a6-8994-fc2e9aa26fd6.gif) - - ## What skills do you need to create mobile apps? In this section, we assume that you're familiar with SharePoint, the .NET Framework, the Visual Studio development system, and Visual C#. It's also good to have some experience with Windows Phone 8 or Windows Phone 7 application development using Silverlight, and it helps to be familiar with XAML, the StackPanel and Pivot controls for Windows Phone, and concepts such as tombstoning, Silverlight data binding, and so on. If you are new to Windows Phone application development using Silverlight, we recommend that you check out the following resources. -- [Developing a Windows Phone Application from Start to Finish](https://msdn.microsoft.com/library/gg680270%28v=pandp.11%29.aspx) - -- [User interface for Windows Phone](https://msdn.microsoft.com/library/windowsphone/develop/ff967556%28v=vs.105%29.aspx) - -- [Quickstart: Creating a user interface with XAML for Windows Phone](https://msdn.microsoft.com/library/windowsphone/develop/jj207025%28v=vs.105%29.aspx) - -- [Pivot control architecture for Windows Phone](https://msdn.microsoft.com/library/windowsphone/develop/ff941097%28v=vs.105%29.aspx) - - +- [Developing a Windows Phone Application from Start to Finish](https://msdn.microsoft.com/library/gg680270%28v=pandp.11%29.aspx) +- [User interface for Windows Phone](https://msdn.microsoft.com/library/windowsphone/develop/ff967556%28v=vs.105%29.aspx) +- [Quickstart: Creating a user interface with XAML for Windows Phone](https://msdn.microsoft.com/library/windowsphone/develop/jj207025%28v=vs.105%29.aspx) +- [Pivot control architecture for Windows Phone](https://msdn.microsoft.com/library/windowsphone/develop/ff941097%28v=vs.105%29.aspx) ## Development overview for mobile apps using SharePoint @@ -40,34 +30,34 @@ You can build a wide variety of mobile apps using SharePoint. This section descr ### Windows Phone SharePoint Application template -This is the simplest type of mobile app you can build to bring a regular list to the phone. SharePoint offers a Visual Studio template to enable you to quickly and easily create SharePoint list applications for the Windows Phone. For example, you can build a "To Do List"-type Windows Phone application that brings your task list from SharePoint into the Windows Phone and enables the you to use your phone to update the status of a task on the go. Another example is having the product catalog for an inventory list in SharePoint available on the phone for the sales people. +This is the simplest type of mobile app you can build to bring a regular list to the phone. SharePoint offers a Visual Studio template to enable you to quickly and easily create SharePoint list applications for the Windows Phone. For example, you can build a "To Do List"-type Windows Phone application that brings your task list from SharePoint into the Windows Phone and enables the you to use your phone to update the status of a task on the go. Another example is having the product catalog for an inventory list in SharePoint available on the phone for the sales people. -Installing the Windows Phone SharePoint SDK makes two Windows Phone SharePoint Application templates available to you in Visual Studio 2010 or Visual Studio 2010 Express for Windows Phone (see [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md)). +Installing the Windows Phone SharePoint SDK makes two Windows Phone SharePoint Application templates available to you in Visual Studio 2010 or Visual Studio 2010 Express for Windows Phone (see [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md)). Using the Windows Phone SharePoint List Application template, you can follow the steps of a wizard to create a functional Windows Phone app that can access and manipulate data in a SharePoint list. ### New and enhanced mobility object model in SharePoint SharePoint adds several new classes to both the server and client object models to enable the SharePoint mobility scenarios that we described earlier in this article. - -To enable location-aware apps, there is a new native field type class, **SPFieldGeoLocation**, along with several associated classes for structuring the value of location fields and rendering them. These classes are also callable in the SharePoint client object model for Silverlight. The new field type also has a definition added to the standard SharePoint fldtypes.xml file and new user controls for rendering the field on the Display, Edit, and New forms. For an overview, see [Integrating location and map functionality in SharePoint](integrating-location-and-map-functionality-in-sharepoint.md). + +To enable location-aware apps, there is a new native field type class, **SPFieldGeoLocation**, along with several associated classes for structuring the value of location fields and rendering them. These classes are also callable in the SharePoint client object model for Silverlight. The new field type also has a definition added to the standard SharePoint fldtypes.xml file and new user controls for rendering the field on the Display, Edit, and New forms. For an overview, see [Integrating location and map functionality in SharePoint](integrating-location-and-map-functionality-in-sharepoint.md). To enable SharePoint authentication for Windows Phone users, the client object model includes a new **Authenticator** class and several associated classes. For an overview, see [Overview of the SharePoint mobile client authentication object model](overview-of-the-sharepoint-mobile-client-authentication-object-model.md). - + To enable automatic notifications to Windows Phone users of events on a SharePoint farm, the server object model includes several new classes, each of which is also callable from the client object model. These classes include methods that enable phone apps to register with SharePoint server apps for notifications about specified types of events. There are also methods that the server apps use to send notifications to registered subscribers. For an overview, see [Create a Windows Phone SharePoint list app to receive push notifications](how-to-configure-and-use-push-notifications-in-sharepoint-apps-for-windows.md#create-a-windows-phone-sharepoint-list-app-to-receive-push-notifications). - + With SharePoint, you're not limited to mobile app development just for Windows Phone 8 and Windows Phone 7. With the JavaScript programming interface and the new Representational State Transfer (REST) programming interface provided by SharePoint, you can create applications for non-Windows Phone mobile devices; you can interact with SharePoint sites by using JavaScript that executes as scripts in the browser, or remotely by using any technology that supports standard REST capabilities. The following section provides an overview of the REST and JavaScript programming interfaces. #### ECMAScript (JavaScript, JScript) object model architecture SharePoint Foundation 2010 introduced the client object models, which enabled developers to perform remote communication with SharePoint by using the web programming technology of their choice: the .NET Framework, Silverlight, or JavaScript. - + In SharePoint Foundation 2010, the client object models provide APIs that enable developers to interact with SharePoint sites from script that executes in the browser, from code (based on the .NET Framework 3.5 or later) that executes in a .NET Framework-managed application, or from code that executes in a Silverlight 2.0 application. The proxy .js and managed .dll files that compose the client object models are built on the client.svc web service, and handle the effective batching, serialization of requests, and parsing of replies. Figure 2 shows a high-level view of the SharePoint client object model architecture. **Figure 2. SharePoint client object model architecture** - + ![SharePoint client object model architecture](../images/SP15Con_BuildSharePointAppsForMobileDevices_Fig3.png) - + To learn how to use the JavaScript client object model against SharePoint data, see the [ECMAScript Client Object Model video](https://msdn.microsoft.com/SP2010DevTrainingCourse_ECMAScriptClientObjectModel.aspx). #### REST endpoints in SharePoint @@ -75,65 +65,44 @@ To learn how to use the JavaScript client object model against SharePoint data, To use the REST capabilities that are built into SharePoint, you can construct a RESTful HTTP request using the Open Data Protocol (OData) standard that corresponds to the desired client object model API. The client.svc web service handles the HTTP request and serves the appropriate response, in either Atom or JavaScript Object Notation (JSON) format. The client application must then parse that response. Figure 3 shows a high-level view of the SharePoint REST architecture. **Figure 3. SharePoint REST architecture** - + ![SharePoint REST architecture](../images/SP15Con_BuildSharePointAppsForMobileDevices_Fig2.png) - + Currently, the REST service in SharePoint is read-only. That is, only REST endpoints that represent an HTTP GET operation are available - + By default, the SharePoint REST service responses are formatted using the Atom protocol, according to the OData specification. In addition, the REST service supports HTTP Accept headers that enable developers to specify that the response is returned in JSON format. To learn more about REST services in SharePoint, see [Use OData query operations in SharePoint REST requests](https://msdn.microsoft.com/library/d4b5c277-ed50-420c-8a9b-860342284b72%28Office.15%29.aspx). - + The SharePoint REST service supports the following OData query operators: - Filter - Take - Expand - - ## Start developing mobile apps for SharePoint The following how-tos and overviews delve into the specific information you need to start your mobile app development: -- [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md) - -- [Overview of Windows Phone SharePoint application templates in Visual Studio](overview-of-windows-phone-sharepoint-application-templates-in-visual-studio.md) - -- [Architecture of the Windows Phone SharePoint List Application template](architecture-of-the-windows-phone-sharepoint-list-application-template.md) - -- [How to: Create a Windows Phone SharePoint list app](how-to-create-a-windows-phone-sharepoint-list-app.md) - -- [How to: Store and retrieve SharePoint list items on a Windows Phone](how-to-store-and-retrieve-sharepoint-list-items-on-a-windows-phone.md) - -- [How to: Implement business logic and data validation in a Windows Phone app for SharePoint](how-to-implement-business-logic-and-data-validation-in-a-windows-phone-app-for-s.md) - -- [How to: Support and convert SharePoint field types for Windows Phone apps](how-to-support-and-convert-sharepoint-field-types-for-windows-phone-apps.md) +- [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md) +- [Overview of Windows Phone SharePoint application templates in Visual Studio](overview-of-windows-phone-sharepoint-application-templates-in-visual-studio.md) +- [Architecture of the Windows Phone SharePoint List Application template](architecture-of-the-windows-phone-sharepoint-list-application-template.md) +- [How to: Create a Windows Phone SharePoint list app](how-to-create-a-windows-phone-sharepoint-list-app.md) +- [How to: Store and retrieve SharePoint list items on a Windows Phone](how-to-store-and-retrieve-sharepoint-list-items-on-a-windows-phone.md) +- [How to: Implement business logic and data validation in a Windows Phone app for SharePoint](how-to-implement-business-logic-and-data-validation-in-a-windows-phone-app-for-s.md) +- [How to: Support and convert SharePoint field types for Windows Phone apps](how-to-support-and-convert-sharepoint-field-types-for-windows-phone-apps.md) +- [How to: Customize list item queries and filter data for Windows Phone apps](how-to-customize-list-item-queries-and-filter-data-for-windows-phone-apps.md) +- [How to: Customize the user interface of a SharePoint list app for Windows Phone](how-to-customize-the-user-interface-of-a-sharepoint-list-app-for-windows-ph.md) +- [How to: Use multiple SharePoint lists in a Windows Phone app](how-to-use-multiple-sharepoint-lists-in-a-windows-phone-app.md) +- [How to: Configure and use push notifications in SharePoint apps for Windows Phone](how-to-configure-and-use-push-notifications-in-sharepoint-apps-for-windows.md) +- [Integrating location and map functionality in SharePoint](integrating-location-and-map-functionality-in-sharepoint.md) +- [How to: Create a mobile app in SharePoint that contains data from an external data source](how-to-create-a-mobile-app-in-sharepoint-that-contains-data-from-an-externa.md) +- [How to: Integrate maps with Windows Phone apps and SharePoint lists](how-to-integrate-maps-with-windows-phone-apps-and-sharepoint-lists.md) +- [How to: Build search-driven mobile apps with the Navigation and Event Logging REST interfaces](how-to-build-search-driven-mobile-apps-with-the-navigation-and-event-logging-res.md) -- [How to: Customize list item queries and filter data for Windows Phone apps](how-to-customize-list-item-queries-and-filter-data-for-windows-phone-apps.md) - -- [How to: Customize the user interface of a SharePoint list app for Windows Phone](how-to-customize-the-user-interface-of-a-sharepoint-list-app-for-windows-ph.md) - -- [How to: Use multiple SharePoint lists in a Windows Phone app](how-to-use-multiple-sharepoint-lists-in-a-windows-phone-app.md) - -- [How to: Configure and use push notifications in SharePoint apps for Windows Phone](how-to-configure-and-use-push-notifications-in-sharepoint-apps-for-windows.md) - -- [Integrating location and map functionality in SharePoint](integrating-location-and-map-functionality-in-sharepoint.md) - -- [How to: Create a mobile app in SharePoint that contains data from an external data source](how-to-create-a-mobile-app-in-sharepoint-that-contains-data-from-an-externa.md) - -- [How to: Integrate maps with Windows Phone apps and SharePoint lists](how-to-integrate-maps-with-windows-phone-apps-and-sharepoint-lists.md) - -- [How to: Build search-driven mobile apps with the Navigation and Event Logging REST interfaces](how-to-build-search-driven-mobile-apps-with-the-navigation-and-event-logging-res.md) - ## See also -- [Programming models in SharePoint](programming-models-in-sharepoint.md) -- [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md) -- [Windows Phone SDK 8.0](https://www.microsoft.com/download/details.aspx?id=35471) -- [Microsoft SharePoint SDK for Windows Phone 8](https://www.microsoft.com/download/details.aspx?id=36818) -- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=27570) -- [Microsoft SharePoint SDK for Windows Phone 7.1](https://www.microsoft.com/download/details.aspx?id=30476) -- [About Expression Blend](https://msdn.microsoft.com/library/cc296376%28Expression.40%29.aspx) - - - +- [Programming models in SharePoint](programming-models-in-sharepoint.md) +- [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md) +- [Windows Phone SDK 8.0](https://www.microsoft.com/download/details.aspx?id=35471) +- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=29233) +- [About Expression Blend](https://msdn.microsoft.com/library/cc296376%28Expression.40%29.aspx) diff --git a/docs/general-development/building-search-queries-in-sharepoint.md b/docs/general-development/building-search-queries-in-sharepoint.md index 346b021ba..d95fc24dd 100644 --- a/docs/general-development/building-search-queries-in-sharepoint.md +++ b/docs/general-development/building-search-queries-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Building search queries in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Article with links about the search syntax supported in SharePoint for building query rules and search queries. +ms.date: 06/07/2022 ms.assetid: c4372fcc-4574-4c81-a345-a1bb282ca8f7 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/business-connectivity-services-in-sharepoint.md b/docs/general-development/business-connectivity-services-in-sharepoint.md index 09679533a..fa6d231e3 100644 --- a/docs/general-development/business-connectivity-services-in-sharepoint.md +++ b/docs/general-development/business-connectivity-services-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Business Connectivity Services in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Article with links to learn about Business Connectivity Services (BCS) and get started developing BCS applications in SharePoint. +ms.date: 06/07/2022 ms.assetid: 64b7d032-4b83-4e9e-bc08-f0a161af5457 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/business-connectivity-services-programmers-reference-for-sharepoint.md b/docs/general-development/business-connectivity-services-programmers-reference-for-sharepoint.md index 39e8fe2c1..2350e05c9 100644 --- a/docs/general-development/business-connectivity-services-programmers-reference-for-sharepoint.md +++ b/docs/general-development/business-connectivity-services-programmers-reference-for-sharepoint.md @@ -1,9 +1,9 @@ --- title: Business Connectivity Services programmers reference for SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Article with links to find reference information to create solutions using Business Connectivity Services (BCS) in SharePoint. +ms.date: 06/07/2022 ms.assetid: cfc9bdf8-ddf3-40e1-83d9-dbd304cebd57 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/changes-in-the-bdc-model-schema-for-sharepoint.md b/docs/general-development/changes-in-the-bdc-model-schema-for-sharepoint.md index 26792b791..ceb41318b 100644 --- a/docs/general-development/changes-in-the-bdc-model-schema-for-sharepoint.md +++ b/docs/general-development/changes-in-the-bdc-model-schema-for-sharepoint.md @@ -1,9 +1,9 @@ --- title: Changes in the BDC model schema for SharePoint +description: Learn what has changed in SharePoint for the BDC model schema. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: 882ea867-9acb-4313-99c9-865a523b72fd -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/choose-the-right-api-set-in-sharepoint.md b/docs/general-development/choose-the-right-api-set-in-sharepoint.md index 19978dc84..8734f8b1b 100644 --- a/docs/general-development/choose-the-right-api-set-in-sharepoint.md +++ b/docs/general-development/choose-the-right-api-set-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Choose the right API set in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Article with links to learn about SharePoint APIs including the server object model, various client object models and the REST/OData web service. +ms.date: 06/07/2022 ms.assetid: f36645da-77c5-47f1-a2ca-13d4b62b320d -localization_priority: Priority +ms.localizationpriority: high --- # Choose the right API set in SharePoint diff --git a/docs/general-development/claims-based-identity-and-concepts-in-sharepoint.md b/docs/general-development/claims-based-identity-and-concepts-in-sharepoint.md index e664823bb..171dc84f4 100644 --- a/docs/general-development/claims-based-identity-and-concepts-in-sharepoint.md +++ b/docs/general-development/claims-based-identity-and-concepts-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Claims-based identity and concepts in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Article with links to learn about the claims-based identity model and concepts in SharePoint. +ms.date: 06/07/2022 ms.assetid: d96c7cf4-2e48-4223-a3c0-42368d079b74 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/claims-based-identity-in-sharepoint.md b/docs/general-development/claims-based-identity-in-sharepoint.md index 9934beb0e..49a81f2c7 100644 --- a/docs/general-development/claims-based-identity-in-sharepoint.md +++ b/docs/general-development/claims-based-identity-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Claims-based identity in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This is an article with links to learn about the fundamentals of claims-based identity architecture in SharePoint. +ms.date: 06/07/2022 ms.assetid: 32b6af2a-72f3-4302-a6af-5f00143cbf67 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/claims-based-identity-term-definitions.md b/docs/general-development/claims-based-identity-term-definitions.md index e7cb54d44..8fcf7b8d0 100644 --- a/docs/general-development/claims-based-identity-term-definitions.md +++ b/docs/general-development/claims-based-identity-term-definitions.md @@ -1,9 +1,9 @@ --- title: Claims-based identity term definitions -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Definitions of key terms related to claims-based identity. +ms.date: 06/07/2022 ms.assetid: 0f3decb5-dcd8-432f-9bb8-533f2d01bef7 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/claims-provider-in-sharepoint.md b/docs/general-development/claims-provider-in-sharepoint.md index ed648e69c..6c27c9da2 100644 --- a/docs/general-development/claims-provider-in-sharepoint.md +++ b/docs/general-development/claims-provider-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Claims provider in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This is an article with links to learn about the claims provider in SharePoint. +ms.date: 06/07/2022 ms.assetid: 5918d5b6-5fd6-4f41-9473-a15b1491d056 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/client-side-web-parts-maintenance-mode.md b/docs/general-development/client-side-web-parts-maintenance-mode.md index 21a5d9929..7a9543bcd 100644 --- a/docs/general-development/client-side-web-parts-maintenance-mode.md +++ b/docs/general-development/client-side-web-parts-maintenance-mode.md @@ -1,9 +1,9 @@ --- title: Maintenance mode for client-side web parts -ms.date: 10/21/2020 -ms.prod: sharepoint +description: When working with client-side web parts, you can load them in maintenance mode. The maintenance mode can be helpful when trying to debug issues related to web parts placed on the page. +ms.date: 04/28/2023 ms.assetid: 3ebd2a11-8291-4228-add0-9e0cd899dd3c -localization_priority: Normal +ms.localizationpriority: medium --- # Maintenance mode for client-side web parts @@ -76,6 +76,16 @@ If the web part [integrates its properties with SharePoint](../spfx/web-parts/gu - The maintenance mode shows only information about web parts. You can't use it to show information about SharePoint Framework extensions that are executed on the page. - Switching to maintenance mode only disables executing web part code. Any SharePoint Framework extensions registered on the page will still execute. +## Disable SPFx web parts and extensions + +If you need to troubleshoot a SharePoint page to see if there is a SharePoint Framework extension or web part causing issues you can append **?disable3PCode** to the URL to disable loading of SPFx components, for example: + +```text +https://contoso.sharepoint.com/sites/team?disable3PCode +``` + +This will prevent loading of any third party SPFx components on the page. + ## See also - [Open and use the web part maintenance page](https://support.office.com/article/Open-and-use-the-web-part-maintenance-page-eff9ce22-d04a-44dd-ae83-ac29a5e396c2) diff --git a/docs/general-development/code-samples-for-sharepoint.md b/docs/general-development/code-samples-for-sharepoint.md index ba84eb344..dae9dde63 100644 --- a/docs/general-development/code-samples-for-sharepoint.md +++ b/docs/general-development/code-samples-for-sharepoint.md @@ -1,27 +1,23 @@ --- title: Code samples for SharePoint +description: Find and download code samples for SharePoint, including samples that demonstrate SharePoint Framework, SharePoint Add-ins, user experience design, metadata management, workflows, mobile application development, REST, and other areas of SharePoint development. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: e6b52c6c-32f8-4689-8c1a-7b50039dcbe8 -localization_priority: Priority +ms.localizationpriority: high --- - - # Code samples for SharePoint Find and download code samples for SharePoint, including samples that demonstrate SharePoint Framework, SharePoint Add-ins, user experience design, metadata management, workflows, mobile application development, REST, and other areas of SharePoint development. -- [SharePoint Code Samples](https://developer.microsoft.com/SharePoint/gallery?filterBy=SharePoint,Samples) +- [SharePoint Code Samples](https://developer.microsoft.com/SharePoint/gallery?filterBy=SharePoint,Samples) > [!NOTE] > Code sample catalog has been moved to Office Dev portal, which provides you great filtering and search capabilities to find what's relevant for you. - ## See also - -- [SharePoint development](https://docs.microsoft.com/sharepoint/dev/) -- [How-tos for SharePoint](how-tos-for-sharepoint.md) -- [SharePoint Dev Center](https://developer.microsoft.com/sharepoint) -- [SharePoint Code Samples](https://developer.microsoft.com/SharePoint/gallery?filterBy=SharePoint,Samples) -- [Microsoft SharePoint Team Blog](https://developer.microsoft.com/en-us/office/blogs/) +- [SharePoint development](/sharepoint/dev/) +- [How-tos for SharePoint](how-tos-for-sharepoint.md) +- [SharePoint Dev Center](https://developer.microsoft.com/sharepoint) +- [SharePoint Code Samples](https://developer.microsoft.com/SharePoint/gallery?filterBy=SharePoint,Samples) +- [Microsoft SharePoint Team Blog](https://developer.microsoft.com/office/blogs/) diff --git a/docs/general-development/color-palettes-and-fonts-in-sharepoint.md b/docs/general-development/color-palettes-and-fonts-in-sharepoint.md index 44b576f76..8d613a05d 100644 --- a/docs/general-development/color-palettes-and-fonts-in-sharepoint.md +++ b/docs/general-development/color-palettes-and-fonts-in-sharepoint.md @@ -1,28 +1,30 @@ --- title: Color palettes and fonts in SharePoint -ms.date: 05/20/2020 -ms.prod: sharepoint +description: Use this reference to define the color palette or font scheme that is used in a SharePoint site. +ms.date: 06/09/2022 ms.assetid: c17d375b-151f-48ae-ac32-f2ce9e68d63f -localization_priority: Priority +ms.localizationpriority: high --- - - # Color palettes and fonts in SharePoint + Use this reference to define the color palette or font scheme that is used in a SharePoint site. + +[!IMPORTANT] This extensibility option is only available for classic SharePoint experiences. You cannot use this option with modern experiences in SharePoint Online, like with communication sites. + ## Color palettes A color palette is the combination of colors that are used in a SharePoint site. The color palette for a SharePoint site is defined in a color palette file. Color slots are also used by the master page preview file to generate thumbnail and preview images of a site. The following describes the structure of the color palette file and the master page preview file: - - - + + + - **Color palette file (.spcolor)** - + Color palette files are used in the **Change the look** wizard, which enables users to change the look and feel of their site by using the SharePoint themes user interface. By default, 32 color palette files are installed with SharePoint. You can also create additional color palette files. The following example shows the format of a color palette file. - -```xml + +```xml @@ -31,71 +33,64 @@ A color palette is the combination of colors that are used in a SharePoint site. In a color palette file, the following placeholders are replaced: - + - _InvertedSetting_ is a Boolean value. **true** if the color palette is generally light text on a dark background. **false** if the color palette is generally dark text on a light background. - - + + - _Slot1_ is the annotation name of the color slot to use as the first block of the palette icon in the color palette picker of the theming experience. - - + + - _Slot2_ is the annotation name of the color slot to use as the second block of the palette icon in the color palette picker of the theming experience. - - + + - _Slot3_ is the annotation name of the color slot to use as the third block of the palette icon in the color palette picker of the theming experience. - - + + - _ColorSlot_ is the annotation name of the color slot that you are defining (for example, SiteTitle). - - + + - _Color_ is the hexadecimal value of the color to use for the specified color slot. This may be in 6 digits (RRGGBB) or 8 digits (AARRGGBB). If the hexadecimal value is 8 digits, the first two digits represent the opacity level (00-FF, which maps to 0-255). If the hexadecimal value is 6 digits, the default opacity is 100% or FF. - - + + The color palette files are located in the Theme Gallery of the root site, in the site collection in the **15** folder (http:// _SiteCollectionName_/_catalogs/theme/15/). To access the Theme Gallery from the SharePoint user interface, on the **Site Settings** page, under **Web Designer Galleries**, select **Themes**, and then select **15**. - - + + - **Master page preview file (.preview)** - + Master page preview files are used to generate thumbnail images and preview images when you use the **Change the look** wizard. A master page must have a corresponding preview file to be used in the **Change the look** wizard. A preview file is a specially formatted file that has sections for the default color palette, default font scheme, tokenized CSS, and tokenized HTML. It uses string tokens to get the value of color slots, font names, and localized UI strings. The following example shows color slots being used in the master page preview file. - + ```HTML - + [ID] #dgp-pageContainer { background-color: [T_THEME_COLOR_PAGEBACKGROUND]; color: [T_THEME_COLOR_BODYTEXT]; width: 100%; - height:100%; - background-image: url('[T_IMAGE]'); + height:100%; + background-image: url('[T_IMAGE]'); background-size: cover; - font-family: [T_BODY_FONT]; + font-family: [T_BODY_FONT]; } ``` For more information, see [How to: Create a master page preview file in SharePoint](how-to-create-a-master-page-preview-file-in-sharepoint.md) - - -> **Tip:** -> You can use the SharePoint color palette tool to help you create SharePoint designs. You can [download the SharePoint color palette tool](https://www.microsoft.com/download/details.aspx?id=38182) from the Microsoft Download Center. - - - ### Color slot mapping Table 1 describes the color slots that are available and where color slots are used in a SharePoint site. - + > [!NOTE] > When discussing navigation items,pressed applies to when a user clicks or touches a navigation item.Selected applies to when a user is navigated to the page.> The following summarizes a normal flow of actions and the color slot that applies to the navigation item link at each step:> The base text of a navigation item link: HeaderNavigationText> A user hovers the cursor over the navigation item link: HeaderNavigationHoverText> A user clicks, touches, or chooses the navigation item link: HeaderNavigationPressedText> The user is navigated to the chosen page. The color slot that applies to the navigation item for the page the user is now on: HeaderNavigationSelectedText - - - + + + **Table 1. Color slots** @@ -192,19 +187,19 @@ Table 1 describes the color slots that are available and where color slots are u |ContentAccent4
|The fourth accent color that a user can select from the Rich Text Editor color picker.
|[T_THEME_COLOR_CONTENTACCENT4]
| |ContentAccent5
|The fifth accent color that a user can select from the Rich Text Editor color picker.
|[T_THEME_COLOR_CONTENTACCENT5]
| |ContentAccent6
|The sixth accent color that a user can select from the Rich Text Editor color picker.
|[T_THEME_COLOR_CONTENTACCENT6]
| - + ## Font schemes Fonts are defined in the font scheme (.spfont file) and the master page preview (.preview file) for a given SharePoint site. The font scheme defines the fonts that are used in four areas: title, navigation, heading, and body. Seven font schemes are included in SharePoint. You can create additional font schemes. The font scheme files are located in the **15** subfolder of the Theme Gallery of the root site of the site collection (http:// _SiteCollectionName_/_catalogs/theme/15/). To access the Theme Gallery from the SharePoint user interface, on the **Site Settings** page, under **Web Designer Galleries**, select **Themes**, and then select **15**. - - - + + + The following example describes the format for an .spfont file. - - - + + + @@ -225,42 +220,42 @@ The following example describes the format for an .spfont file. ``` In an .spfont file, the following placeholders are replaced: - - - + + + - _FontSchemeName_ is the name of the font scheme. - - + + - _Slot1_ is the name of the font slot that you want to use as the first block of the font icon in the font scheme picker in the **Change the look** wizard. - - + + - _Slot2_ is the name of the font slot that you want to use as the second block of the font icon in the font scheme picker in the **Change the look** wizard. - - + + - _FontSlotName_ is the name of the font slot that you are defining (for example, title). - - + + - _LatinScriptFont_ is the font to use for Latin scripts. This font is also the fallback font. That is, this is the font that is used for a language that does not have a script that is explicitly set in the font scheme. - + > [!NOTE] > You must provide additional information to use web fonts in your font scheme. For more information, see the [Web fonts](#webFont) section in this article. - _EAScriptFont_ is the font to use for East Asia scripts. The **** element is not currently used by SharePoint. But, the **** element is still required in the font scheme. - - + + - _CSFont_ is the font to use for complex scripts. The **** element is not currently used by SharePoint. But, the **** element is still required in the font scheme. - - + + - _Language_ is the language script. - - + + - _ScriptFont_ is the font to use for the specified language script. - - + + The following example shows a portion of an .spfont file. - - - + + + @@ -306,17 +301,17 @@ The following example shows a portion of an .spfont file. ``` SharePoint includes support for web fonts. You must provide additional information to use web fonts in your font scheme. For more information, see the [Web fonts](#webFont) section in this article. - - - + + + ### Web-safe fonts Web-safe fonts are a set of fonts that are widely used and available on most devices by default. To specify a web-safe font in the font scheme, include the name of the font in the **typeface** attribute of the font slot. The following example shows a web-safe font used in a font scheme. - - - + + + ```xml @@ -331,13 +326,13 @@ Web-safe fonts are a set of fonts that are widely used and available on most dev Web fonts are fonts that are available on the Internet. When a user views a site that uses web fonts, the web browser downloads the necessary font files along with the rest of the page. To specify a web font, you must provide the URL to your web font files in four font formats (for support across browsers), and a small and large thumbnail image to use to render the font names in the font scheme picker. - - - + + + The following example describes the information that is required to use a web font in an **** element. - - - + + + @@ -354,41 +349,41 @@ The following example describes the information that is required to use a web fo ``` In this example of using a web font, the following placeholders would be replaced: - - - + + + - _FontName_ is the name of the web font. - - + + - _EotFile_ is the relative URL to the Embedded Open Type font file. - - + + - _WoffFile_ is the relative URL to the Web Open Font Format font file. - - + + - _TtfFile_ is the relative URL to the TrueType font file. - - + + - _SvgFile_ is the relative URL to the Scalable Vector Graphics font file. - - + + - _LargeImgFile_ is the relative URL to the large thumbnail image that you want to use in the font scheme picker. - - + + - _SmallImgFile_ is the relative URL to the small thumbnail image that you want to use in the font scheme picker. - + > [!NOTE] - > The paths to the files have to be the full URL (i.e. https://tenant.sharepoint.com/sites/sitename/_catalogs/theme/15/fontfile.wof) + > The paths to the files have to be the full URL (i.e. `https://tenant.sharepoint.com/sites/sitename/_catalogs/theme/15/fontfile.wof`) > The LargeImgFile and SmallImgFile attributes have to be present in the Latin tag even if given empty values. ### Font slots Table 1 describes the available font slots and where they are used in a page. - - - + + + **Table 1. Font slots** @@ -402,32 +397,32 @@ Table 1 describes the available font slots and where they are used in a page. |small-heading
|Used for H4 headings.
| |large-body
|Used for large body text (15 pixels and 19 pixels).
| |body
|The base font that is used everywhere else on the page.
| - + ## See also - [Themes overview for SharePoint](themes-overview-for-sharepoint.md) - - + + - [How to: Deploy a custom theme in SharePoint](how-to-deploy-a-custom-theme-in-sharepoint.md) - - + + - [Upgrade custom themes and CSS to SharePoint](upgrade-custom-themes-and-css-to-sharepoint.md) - - + + - [How to: Create a master page preview file in SharePoint](how-to-create-a-master-page-preview-file-in-sharepoint.md) - - -- [SharePoint Team Blog: Show off your style with SharePoint theming](https://www.microsoft.com/en-us/microsoft-365/blog/2012/10/29/show-off-your-style-with-sharepoint-theming) - - + + +- [SharePoint Team Blog: Show off your style with SharePoint theming](https://www.microsoft.com/microsoft-365/blog/2012/10/29/show-off-your-style-with-sharepoint-theming) + + - [SharePoint Design Manager branding and design capabilities](sharepoint-design-manager-branding-and-design-capabilities.md) - - - - - + + + + + diff --git a/docs/general-development/common-error-messages-in-sharepoint-workflow-development.md b/docs/general-development/common-error-messages-in-sharepoint-workflow-development.md index 4bdc0c194..a0766bcf6 100644 --- a/docs/general-development/common-error-messages-in-sharepoint-workflow-development.md +++ b/docs/general-development/common-error-messages-in-sharepoint-workflow-development.md @@ -1,9 +1,9 @@ --- title: Common error messages in SharePoint workflow development +description: A listing of common error messages that you might encounter while developing SharePoint workflows and guidance for solving the underlying problem. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: e9bf6878-c722-4b1f-b5b5-b302ae0ea4da -localization_priority: Priority +ms.localizationpriority: high --- @@ -41,7 +41,7 @@ Although this list doesn't cover every possible error you may encounter when dev - [The e-mail message cannot be sent. Make sure the outgoing e-mail settings for the server are configured correctly](#bkmk_error07) -- [The e-mail message cannot be sent. Email non-delivery reports in Exchange Online](https://docs.microsoft.com/Exchange/mail-flow-best-practices/non-delivery-reports-in-exchange-online/non-delivery-reports-in-exchange-online) +- [The e-mail message cannot be sent. Email non-delivery reports in Exchange Online](/exchange/mail-flow-best-practices/non-delivery-reports-in-exchange-online/non-delivery-reports-in-exchange-online) - [The workflow could not update the item, possibly because one or more columns for the item require a different type of information](#bkmk_error08) @@ -151,7 +151,7 @@ Errors sending e-mail can also happen because of Exchange non-delivery. Review -- [Email non-delivery reports in Exchange Online](https://docs.microsoft.com/Exchange/mail-flow-best-practices/non-delivery-reports-in-exchange-online/non-delivery-reports-in-exchange-online) +- [Email non-delivery reports in Exchange Online](/exchange/mail-flow-best-practices/non-delivery-reports-in-exchange-online/non-delivery-reports-in-exchange-online) ### The workflow could not update the item, possibly because one or more columns for the item require a different type of information diff --git a/docs/general-development/configuration-administration-and-resources-in-sharepoint.md b/docs/general-development/configuration-administration-and-resources-in-sharepoint.md index bae6b0c9b..c35d5e9ad 100644 --- a/docs/general-development/configuration-administration-and-resources-in-sharepoint.md +++ b/docs/general-development/configuration-administration-and-resources-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Configuration, administration, and resources in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Article with links to learn about the configuration, administration and resources in SharePoint. +ms.date: 06/07/2022 ms.assetid: e7d8c919-7aa6-466a-acb0-27366129061c -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/configure-search-in-sharepoint.md b/docs/general-development/configure-search-in-sharepoint.md index 12365e657..08992c761 100644 --- a/docs/general-development/configure-search-in-sharepoint.md +++ b/docs/general-development/configure-search-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Configure search in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This is an article about configuring search in SharePoint. +ms.date: 06/07/2022 ms.assetid: e447127c-2b11-4d65-b46e-01a18cdcdee5 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/content-management-interoperability-services-cmis-in-sharepoint.md b/docs/general-development/content-management-interoperability-services-cmis-in-sharepoint.md index 3035ba961..c3d42c9d5 100644 --- a/docs/general-development/content-management-interoperability-services-cmis-in-sharepoint.md +++ b/docs/general-development/content-management-interoperability-services-cmis-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Content Management Interoperability Services (CMIS) in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This is an article with links to learn about the SharePoint implementation of version 1.0 of the OASIS Content Management Interoperability Services (CMIS) standard. +ms.date: 06/07/2022 ms.assetid: a1def24c-b2db-4bf9-8d2c-02f5628832f8 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/content-search-web-part-in-sharepoint.md b/docs/general-development/content-search-web-part-in-sharepoint.md index c90d8bd9a..3d8aa8b79 100644 --- a/docs/general-development/content-search-web-part-in-sharepoint.md +++ b/docs/general-development/content-search-web-part-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Content Search web part in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This is an article with links to learn about the Content Search web part (CSWP) in SharePoint. +ms.date: 06/07/2022 ms.assetid: 6fb4bf41-0846-4dca-ad9e-906afdfd3d2b -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/create-a-map-view-for-the-geolocation-field-in-sharepoint.md b/docs/general-development/create-a-map-view-for-the-geolocation-field-in-sharepoint.md index 622c209ee..1b6f5da34 100644 --- a/docs/general-development/create-a-map-view-for-the-geolocation-field-in-sharepoint.md +++ b/docs/general-development/create-a-map-view-for-the-geolocation-field-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Create a map view for the Geolocation field in SharePoint -ms.date: 05/09/2020 -ms.prod: sharepoint +description: Learn how to display location information by using a map view in SharePoint lists. +ms.date: 06/09/2022 ms.assetid: 0cd8ba27-3326-4b60-a2d0-d289a94f11bb -localization_priority: Priority +ms.localizationpriority: high --- # Create a map view for the Geolocation field in SharePoint @@ -15,7 +15,7 @@ To display a map view in a SharePoint list, you must use the Bing Maps services. The **Geolocation** field and the map view enable you to give spatial context to any information by integrating data from SharePoint into a mapping experience in web and mobile apps. This article does not explain how to render the **Geolocation** field or provide developer guidance for creating a location-based mobile application; it does provide instruction for creating map views programmatically and from the SharePoint UI by using Bing Maps. -An MSI package named SQLSysClrTypes.msi must be installed on every SharePoint front-end web server to view the **Geolocation** field value or data in a list. This package installs components that implement the new geometry, geography, and hierarchy ID types in SQL Server 2008. By default, this file is installed for SharePoint Online. However, it is not installed for an on-premises deployment of SharePoint. You must be a member of the Farm Administrators group to perform this operation. To download SQLSysClrTypes.msi, see [Microsoft SQL Server 2008 R2 SP1 Feature Pack](https://www.microsoft.com/download/details.aspx?id=26728) for SQL Server 2008, or [Microsoft SQL Server 2012 Feature Pack](https://www.microsoft.com/download/details.aspx?id=29065) for SQL Server 2012 in the Microsoft Download Center. +An MSI package named SQLSysClrTypes.msi must be installed on every SharePoint front-end web server to view the **Geolocation** field value or data in a list. This package installs components that implement the new geometry, geography, and hierarchy ID types in SQL Server 2008. By default, this file is installed for SharePoint Online. However, it is not installed for an on-premises deployment of SharePoint. You must be a member of the Farm Administrators group to perform this operation. To download SQLSysClrTypes.msi, see [Microsoft SQL Server 2008 R2 SP1 Feature Pack](https://www.microsoft.com/download/details.aspx?id=30437) for SQL Server 2008, or [Microsoft SQL Server 2012 Feature Pack](https://www.microsoft.com/download/details.aspx?id=29065) for SQL Server 2012 in the Microsoft Download Center. ## Prerequisites for creating a map view @@ -91,7 +91,7 @@ Follow these steps to create a map view for a SharePoint list programmatically. > [!NOTE] > The JSLink property is not supported on Survey or Events lists. A SharePoint calendar is an Events list. - ```cs + ```csharp class Program { static void Main(string[] args) diff --git a/docs/general-development/create-a-sharepoint-workflow-app-using-visual-studio-2012.md b/docs/general-development/create-a-sharepoint-workflow-app-using-visual-studio-2012.md index 26423c63a..6e650bcf0 100644 --- a/docs/general-development/create-a-sharepoint-workflow-app-using-visual-studio-2012.md +++ b/docs/general-development/create-a-sharepoint-workflow-app-using-visual-studio-2012.md @@ -2,9 +2,8 @@ title: Create a SharePoint workflow app using Visual Studio 2012 description: Walk through the process of creating a workflow SharePoint Add-in using Microsoft Visual Studio 2012. ms.date: 12/22/2020 -ms.prod: sharepoint ms.assetid: 7923d60d-84b9-44d6-8185-e5236efaf502 -localization_priority: Priority +ms.localizationpriority: high --- # Create a SharePoint workflow app using Visual Studio 2012 diff --git a/docs/general-development/create-a-workflow-with-elevated-permissions-by-using-the-sharepoint-workflo.md b/docs/general-development/create-a-workflow-with-elevated-permissions-by-using-the-sharepoint-workflo.md index 1822928ed..cf9ffd1c1 100644 --- a/docs/general-development/create-a-workflow-with-elevated-permissions-by-using-the-sharepoint-workflo.md +++ b/docs/general-development/create-a-workflow-with-elevated-permissions-by-using-the-sharepoint-workflo.md @@ -1,43 +1,36 @@ --- title: Create a workflow with elevated permissions by using the SharePoint Workflow platform description: Create SharePoint workflows that access objects in SharePoint that require elevated permissions. These solutions grant permissions to the workflow app and wrap actions with the App Step. -ms.date: 12/29/2017 -ms.prod: sharepoint +ms.date: 05/18/2023 ms.assetid: 4656f6a0-36fd-4b7d-898e-8cd4bdbbda57 -localization_priority: Priority +ms.localizationpriority: high --- - # Create a workflow with elevated permissions by using the SharePoint Workflow platform - - This article describes how to create SharePoint workflows that access objects in SharePoint that require elevated permissions. These solutions use two features: granting permissions to the workflow app and wrapping actions with the App Step. > [!NOTE] > SharePoint 2010 workflows have been retired since August 1, 2020 for new tenants and removed from existing tenants on November 1, 2020. If you’re using SharePoint 2010 workflows, we recommend migrating to Power Automate or other supported solutions. For more info, see [SharePoint 2010 workflow retirement](https://support.microsoft.com/office/sharepoint-2010-workflow-retirement-1ca3fff8-9985-410a-85aa-8120f626965f). - -> [!IMPORTANT] -> This article assumes that the SharePoint Workflow platform has been installed and configured and that SharePoint has been configured for add-ins. For more information about SharePoint Workflows and SharePoint Add-ins, including installation and configuration, see [Workflows in SharePoint](workflows-in-sharepoint.md) and [Install and manage SharePoint Add-ins](../sp-add-ins/sharepoint-add-ins.md). +> [!IMPORTANT] +> This article assumes that the SharePoint Workflow platform has been installed and configured and that SharePoint has been configured for add-ins. For more information about SharePoint Workflows and SharePoint Add-ins, including installation and configuration, see [Workflows in SharePoint](workflows-in-sharepoint.md) and [Install and manage SharePoint Add-ins](../sp-add-ins/sharepoint-add-ins.md). Imagine that as a SharePoint administrator, you would like to define some processes for managing user requests for purchases of add-ins from the Office Store. In the simplest case, you want to send an acknowledgment email when a user requests an add-in. In addition, you might also want to add structure to the request approval process. - -By default, workflow does not have permissions to access the app catalog. Catalog lists in SharePoint require owner (full control) permissions. Workflows generally run at a permission level equivalent to write. - + +By default, workflow does not have permissions to access the app catalog. Catalog lists in SharePoint require owner (full control) permissions. Workflows generally run at a permission level equivalent to write. + To solve this, you have to create a workflow with elevated permissions by doing the following in the Site Collection site: 1. Allow the workflow to use add-in permissions. - -2. Grant full control permission to the workflow. - -3. Develop the workflow to wrap actions inside an App Step. +1. Grant full control permission to the workflow. +1. Develop the workflow to wrap actions inside an App Step. ## Allow a workflow to use add-in permissions on a SharePoint site The first step is to allow the workflow to use add-in permissions. You configure a workflow to use add-in permissions on the **Site settings** page of the SharePoint site where the workflow runs. The following procedure configures the SharePoint site to allow the workflow to use add-in permissions. - -> [!IMPORTANT] + +> [!IMPORTANT] > The procedure must be completed by a user that has **Site Administrator** permissions. ### To allow workflow to use add-in permissions @@ -46,79 +39,71 @@ The first step is to allow the workflow to use add-in permissions. You configure ![Settings menu](../images/SPD15-WFAppPermissions1.png) -2. Go to **Site settings**. - -3. In the **Site Actions** section, select **Manage site features**. +1. Go to **Site settings**. +1. In the **Site Actions** section, select **Manage site features**. +1. Locate the feature called **Workflows can use app permissions**, as shown in the figure, and then select **Activate**. -4. Locate the feature called **Workflows can use app permissions**, as shown in the figure, and then select **Activate**. - - > [!WARNING] - > This feature will not activate unless you have properly configured the SharePoint Workflow platform and SharePoint Add-ins. + > [!WARNING] + > This feature will not activate unless you have properly configured the SharePoint Workflow platform and SharePoint Add-ins. - ![Workflow can use app permissions feature](../images/SPD15-WFAppPermissions2.png) - + ![Workflow can use app permissions feature](../images/SPD15-WFAppPermissions2.png) ## Grant full control permission to a workflow For the workflow to function properly, it must be granted full control on the site. The following procedure grants full control permission to the workflow. - -> [!IMPORTANT] + +> [!IMPORTANT] > The procedure must be completed by a user that has **Site Owner** permissions. The workflow must already be published to the SharePoint site. ### To grant full control permission to a workflow 1. Select the **Settings** icon. - + ![Settings menu](../images/SPD15-WFAppPermissions1.png) -2. Go to **Site settings**. - -3. In the **Users and Permissions** section, select **Site app permissions**. - -> [!IMPORTANT] -> In SharePoint Online, select **Site collection app permissions**. This option is only visible to **Site Collection Administrators**. - -4. Copy the **client** section of the **App Identifier**. This is the identifier between the last "|" and the "@" sign, as shown in the figure. - - ![Selecting App Identifier](../images/SPD15-WFAppPermissions3.png) - -5. Go to the **Grant permission to an app** page. This must be done by browsing to the appinv.aspx page of the site. - - Example: `http://{hostname}/{the Site Collection}/_layouts/15/appinv.aspx`. - - > [!NOTE] - > The 'app' in this step refers to the workflow add-in in general and not just a specific workflow. Individual workflows cannot be access controlled. When you enable add-in permissions, you are enabling for all workflows within the Site Collection. - - For more information about setting up a workflow, see the [Blog article from Sympraxis Consulting: Looping Through Content in a SharePoint Site Workflow](http://sympmarc.com/series/looping-through-content-in-a-sharepoint-2013-site-workflow/) - - The following figure shows an example. - - ![The appinv.aspx URL example and page.](../images/SPD15-WFAppPermissions4.png) - -6. Paste the client ID in the **App Id** field, and then select **Lookup**, as shown in the previous figure. - -7. Paste the following code in the **Permission Request XML** field to grant full control permission *(note: this code block was updated on 12/29/17 to include the `AllowAppOnlyPolicy`)*. - - ```XML +1. Go to **Site settings**. +1. In the **Users and Permissions** section, select **Site app permissions**. + + > [!IMPORTANT] + > In SharePoint Online, select **Site collection app permissions**. This option is only visible to **Site Collection Administrators**. + +1. Copy the **client** section of the **App Identifier**. This is the identifier between the last "|" and the "@" sign, as shown in the figure. + + ![Selecting App Identifier](../images/SPD15-WFAppPermissions3.png) + +1. Go to the **Grant permission to an app** page. This must be done by browsing to the appinv.aspx page of the site. + + Example: `http://{hostname}/{the Site Collection}/_layouts/15/appinv.aspx`. + + > [!NOTE] + > The 'app' in this step refers to the workflow add-in in general and not just a specific workflow. Individual workflows cannot be access controlled. When you enable add-in permissions, you are enabling for all workflows within the Site Collection. + + For more information about setting up a workflow, see the [Blog article from Sympraxis Consulting: Looping Through Content in a SharePoint Site Workflow](http://sympmarc.com/series/looping-through-content-in-a-sharepoint-2013-site-workflow/) + + The following figure shows an example. + + ![The appinv.aspx URL example and page.](../images/SPD15-WFAppPermissions4.png) + +1. Paste the client ID in the **App Id** field, and then select **Lookup**, as shown in the previous figure. +1. Paste the following code in the **Permission Request XML** field to grant full control permission *(note: this code block was updated on 12/29/17 to include the `AllowAppOnlyPolicy`)*. + + ```XML + ``` + + > [!WARNING] + > There are no placeholders in the **Scope** value. It is a literal value. Enter it exactly as it appears here. - ``` + The following figure shows an example of the completed page _(note that the code in the **Permission Request XML** area does not reflect the recent update to the code in Step 7)_. - > [!WARNING] - > There are no placeholders in the **Scope** value. It is a literal value. Enter it exactly as it appears here. + ![Looking up an App Id.](../images/SPD15-WFAppPermissions5.png) - The following figure shows an example of the completed page _(note that the code in the **Permission Request XML** area does not reflect the recent update to the code in Step 7)_. - - ![Looking up an App Id.](../images/SPD15-WFAppPermissions5.png) +1. Select **Create**. +1. You are then asked to trust the workflow add-in, as shown in the following figure. Select **Trust It**. -8. Select **Create**. - -9. You are then asked to trust the workflow add-in, as shown in the following figure. Select **Trust It**. - - ![Trust the Workflow app.](../images/SPD15-WFAppPermissions6.png) - + ![Trust the Workflow app.](../images/SPD15-WFAppPermissions6.png) ## Wrap actions inside an App Step @@ -126,73 +111,60 @@ Finally, you need to wrap the workflow actions inside an App Step. The following ### To wrap actions inside an App Step -1. Open the app catalog site in SharePoint Designer. - -2. Create a new Custom List on which to run the workflow. In this example, the list name is **App Demo**. - -3. Select **Workflows** in the navigation window. - -4. Create a new **List Workflow** for the **App Demo** list, as shown in the figure. +1. Open the app catalog site in SharePoint Designer. +1. Create a new Custom List on which to run the workflow. In this example, the list name is **App Demo**. +1. Select **Workflows** in the navigation window. +1. Create a new **List Workflow** for the **App Demo** list, as shown in the figure. + + ![Create a new List Workflow.](../images/SPD15-WFAppPermissions7.png) + +1. Insert an **App Step**, as shown in the figure. + + ![Adding an App Step.](../images/SPD15-WFAppPermissions8.png) + +1. Insert a **Send an Email** action in the **App Step**. +1. Select the **Address book** button. In the **To** field, select **Workflow Lookup for a User**, and then select **Add** as shown in the figure. - ![Create a new List Workflow.](../images/SPD15-WFAppPermissions7.png) + ![Select Workflow lookup for a user.](../images/SPD15-WFAppPermissions9.png) -5. Insert an **App Step**, as shown in the figure. - - ![Adding an App Step.](../images/SPD15-WFAppPermissions8.png) +1. Enter the **Created By** field as the lookup value, as shown in the figure. -6. Insert a **Send an Email** action in the **App Step**. - -7. Select the **Address book** button. In the **To** field, select **Workflow Lookup for a User**, and then select **Add** as shown in the figure. + ![Lookup for Person dialog.](../images/SPD15-WFAppPermissions10.png) - ![Select Workflow lookup for a user.](../images/SPD15-WFAppPermissions9.png) - -8. Enter the **Created By** field as the lookup value, as shown in the figure. +1. Enter **Email** from the **App Demo** list in the email message body. +1. Select **OK** to return to the workflow. The completed workflow is shown in the figure. - ![Lookup for Person dialog.](../images/SPD15-WFAppPermissions10.png) - -9. Enter **Email** from the **App Demo** list in the email message body. - -10. Select **OK** to return to the workflow. The completed workflow is shown in the figure. + ![Email action in App Step.](../images/SPD15-WFAppPermissions11.png) - ![Email action in App Step.](../images/SPD15-WFAppPermissions11.png) - -11. Select the **Workflow Settings** icon in the ribbon, as shown in the figure. - - ![Workflow Settings icon in ribbon.](../images/SPD15-WFAppPermissions12.png) +1. Select the **Workflow Settings** icon in the ribbon, as shown in the figure. -12. Clear the check box next to **Automatically update the workflow status to the current stage name**, and then select **Publish**. - - ![Clear automatic updates check mark and publish.](../images/SPD15-WFAppPermissions13.png) - + ![Workflow Settings icon in ribbon.](../images/SPD15-WFAppPermissions12.png) - +1. Clear the check box next to **Automatically update the workflow status to the current stage name**, and then select **Publish**. + + ![Clear automatic updates check mark and publish.](../images/SPD15-WFAppPermissions13.png) ## Understand how it works To understand why elevating permissions for a workflow is required, consider that workflows are fundamentally add-ins for SharePoint, and they follow the same authorization rules of the add-in model. The default configuration for workflow is that the effective permissions of the workflow are an intersection of user permissions and the add-in permissions, as shown in the figure. - + ![Permissions diagram.](../images/SPD15-WFAppPermissions14.png) - + Two reasons why it is necessary to elevate permissions to create a workflow in the App Request list are: - By default, workflow only has write permission. - - The user has no permissions. - -The first step to solve this problem is to allow the application to authorize by using only its identity and ignoring that of the user. This is done by enabling the App Step feature. The second step grants full control permission to the workflow. - + +The first step to solve this problem is to allow the application to authorize by using only its identity and ignoring that of the user. This is done by enabling the App Step feature. The second step grants full control permission to the workflow. + The following diagram illustrates the change in permissions. - + ![Permissions matrix.](../images/SPD15-WFAppPermissions15.png) - - ## See also - [Blog article from the SharePoint Designer team: Workflow package and deploy scenario](https://blogs.msdn.microsoft.com/sharepointdesigner/2012/08/29/packaging-sharepoint-2013-list-site-and-reusable-workflow-and-how-to-deploy-the-package/) - [What's new in workflow in SharePoint](what-s-new-in-workflows-for-sharepoint.md) -- [Getting started with SharePoint workflow](get-started-with-workflows-in-sharepoint.md) +- [Getting started with SharePoint workflow](get-started-with-workflows-in-sharepoint.md) - [Workflow actions and activities reference for SharePoint](workflow-actions-and-activities-reference-for-sharepoint.md) - [Workflow development in SharePoint Designer and Visio](workflow-development-in-sharepoint-designer-and-visio.md) - - diff --git a/docs/general-development/create-associations-in-sharepoint.md b/docs/general-development/create-associations-in-sharepoint.md index eecc62841..77deedd3e 100644 --- a/docs/general-development/create-associations-in-sharepoint.md +++ b/docs/general-development/create-associations-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Create associations in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This article contains links to create associations in SharePoint. +ms.date: 06/07/2022 ms.assetid: 202599e3-232e-4b3a-9da5-c11f6e972283 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/create-hybrid-connectivity-apps-for-sharepoint.md b/docs/general-development/create-hybrid-connectivity-apps-for-sharepoint.md index 45c8a3f3c..f88e805a7 100644 --- a/docs/general-development/create-hybrid-connectivity-apps-for-sharepoint.md +++ b/docs/general-development/create-hybrid-connectivity-apps-for-sharepoint.md @@ -1,231 +1,111 @@ --- title: Create hybrid connectivity apps for SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This is an article with links to learn about the process of developing and deploying apps for SharePoint hybrid connectivity solutions. +ms.date: 05/18/2023 ms.assetid: 311f036e-3442-4497-b35e-442b665462d3 -localization_priority: Normal +ms.localizationpriority: medium --- - # Create hybrid connectivity apps for SharePoint + Learn about the process of developing and deploying apps for SharePoint hybrid connectivity solutions. + ## Hybrid connectivity in SharePoint and SharePoint Online - As businesses move to using SharePoint Online, they need a way to expose large amounts of proprietary data safely and securely. To help solve this challenge, SharePoint introduced hybrid connectivity. - - - + The Business Connectivity Services (BCS) hybrid connectivity capability lets SharePoint consume data housed on-premises, inside corporate firewalls, and secured by various forms of authentication. With hybrid connectivity functionality, SharePoint Online can access this data securely over the web as if it was on the same internal network. Once hybrid connectivity is configured, users can work with data that is secured within the business' infrastructure. They can access and manipulate the data according to the permissions that they have been granted in SharePoint. - - - + For a complete description of how to configure a working hybrid solution, see [Hybrid for SharePoint](https://technet.microsoft.com/library/jj838715.aspx). This series of articles walks you through all the requirements of configuring data sources, reverse proxies, search, security, networking, and everything else needed to set up the end-to-end scenario. - - - -> **Caution:** -> To configure a hybrid SharePoint environment, you need a combination of expert skills and significant hands-on experience with SharePoint, SharePoint Online, and related products and technologies. We recommend that you engage Microsoft Consulting Services to provide technical guidance and support during the design and deployment of your hybrid environment. > For more information, see [Microsoft Services](https://www.microsoft.com/microsoftservices/deploy.aspx). - - - +> [!CAUTION] +> To configure a hybrid SharePoint environment, you need a combination of expert skills and significant hands-on experience with SharePoint, SharePoint Online, and related products and technologies. We recommend that you engage Microsoft Consulting Services to provide technical guidance and support during the design and deployment of your hybrid environment. > For more information, see [Microsoft Services](https://www.microsoft.com/en-us/microsoft-365/products-apps-services). For you to be able to create an app that consumes data from an internal data source through BCS and the hybrid connection, this article assumes that you have already followed the procedures to configure your hybrid environment. - - - ## Create hybrid connectivity apps - Creating a hybrid SharePoint Add-in is essentially the same as creating any SharePoint Add-in. - - - -Follow these steps to create a hybrid app: - - - - -- [Prepare the data source](#bkmk_PrepareDataSource) - - -- [Create an SharePoint Add-in](#bkmk_CreateAnApp) - - -- [Create an external content type](#bkmk_CreateECT) - - -- [Deploy the hybrid app](#bkmk_DeployHybridApp) - - + +Follow these steps to create a hybrid app + +- [Prepare the data source](#prepare-the-data-source) +- [Create an SharePoint Add-in](#create-an-sharepoint-add-in) +- [To add an external content ty](#to-add-an-external-content-type) +- [Deploy the hybrid app](#deploy-the-hybrid-app) ### Prepare the data source - - -Most of the time, the data source is already in place and is servicing any number of business applications. However, that data may only be available from inside the corporate security infrastructure. If your data does exist on a server located on the inside of a corporate firewall, or is secured by some other means, the next step is to expose that data to BCS, which is also housed inside the firewall. A network device is configured to translate calls from SharePoint Online to the internal SharePoint farm. This device is referred to as a "reverse proxy" and allows the SharePoint Add-in located in the cloud to call into BCS located inside the firewall. BCS handles all the data connectivity from there. - - - -To make this data available to BCS, you should expose it as an OData source. You do this by creating an Internet Information Services (IIS) website that will host the service and allow BCS to talk to the data source through OData and Representational State Transfer (REST) endpoints. - - - -To create an OData endpoint, you will need to follow these steps for creating a Windows Communication Foundation (WCF) data service. - - - -### To create a WCF data service +Most of the time, the data source is already in place and is servicing any number of business applications. However, that data may only be available from inside the corporate security infrastructure. If your data does exist on a server located on the inside of a corporate firewall, or is secured by some other means, the next step is to expose that data to BCS, which is also housed inside the firewall. A network device is configured to translate calls from SharePoint Online to the internal ShePoint farm. This device is referred to as a "reverse proxy" and allows the SharePoint Add-in located in the cloud to call into BCS located inside the firewall. BCS handles all the data connectivity from there. + +To make this data available to BCS, you should expose it as an OData source. You do this by creating an Internet Information Services (IIS) website that will host the service and allow BCS to talk to the data source through OData and Representational State Transfer (REST) endpoints +To create an OData endpoint, you will need to follow these steps for creating a Windows Communication Foundation (WCF) data service. 1. Create an IIS website running at least Microsoft .NET Framework 4. Secure the site using basic authentication. - + > [!NOTE] - > It's not necessary for SharePoint to be installed on this server. In fact, for the sake of simplicity and performance, it's better if SharePoint is not installed on the server that hosts the WCF data service. - -2. Create a new project in Visual Studio 2012 using the **ASP.NET Empty Web Application** template. - - -3. In **Solution Explorer** add a new **ADO.NET Entity Data Model**. - - -4. Choose the **Generate from database** option in the **Entity Data Model Wizard**. - - -5. Select an existing connection, or create a new one. - - -6. Provide the URL and connection security information. - - -7. Select the items that you want to include in the model, and choose **Finish**. - - -8. Again in **Solution Explorer**, add a new **WCF Data Service** using the Visual Studio template. - - -9. Name the data service, and choose **Next**. - + > It's not necessary for SharePoint to be installed on this server. In fact, for the sake of simplicity and performance, it's better if SharePoint is not installed on the server thathosts the WCF data service + +1. Create a new project in Visual Studio 2012 using the **ASP.NET Empty Web Application** template. +1. In **Solution Explorer** add a new **ADO.NET Entity Data Model**. +1. Choose the **Generate from database** option in the **Entity Data Model Wizard**. +1. Select an existing connection, or create a new one. +1. Provide the URL and connection security information. +1. Select the items that you want to include in the model, and choose **Finish**. +1. Again in **Solution Explorer**, add a new **WCF Data Service** using the Visual Studio template. +1. Name the data service, and choose **Next**. + At this point, the entity model will be created and the resulting classes will be included in your project. - - -10. Set the security to the entities created by replacing the `/* TODO: put your data source class name here */` with the class name of the entity model you just created and specifying which entities you want to grant permissions to. - - -For a complete tutorial of how to set this up, see the following: - - - - -- [Getting Started With OData Part 1: Building an OData Service](https://msdn.microsoft.com/data/gg601462) - - -- [Quickstart (WCF Data Services)](https://msdn.microsoft.com/library/cc668796.aspx) - - -### Create an SharePoint Add-in - +1. Set the security to the entities created by replacing the `/* TODO: put your data source class name here */` with the class name of the entity model you just created and specifying which entities you want to grant permissions to. -One of the assumptions we are making here is that you are developing your app inside the corporate firewall. This represents a scenario where a developer working for a company would have a computer located behind the protection of the security infrastructure, developing and testing the app until it is ready to be deployed. This simplifies the process of connecting to the data source from Visual Studio, and uses Office Developer Tools for Visual Studio 2013 to automatically generate the external content type in the next step. - - - +For a complete tutorial of how to set this up, see the following: -### To create a new app +- [Getting Started With OData Part 1: Building an OData Service](https://msdn.microsoft.com/data/gg601462) +- [Quickstart (WCF Data Services)](https://msdn.microsoft.com/library/cc668796.aspx) +### Create an SharePoint Add-in -1. Open Visual Studio 2012 on your development computer that has Office Developer Tools for Visual Studio 2013 and SharePoint installed. - - -2. Create a new app for SharePoint. - - -3. Specify the name of the app, the local SharePoint URL that will host your site for testing, and how you want the app to be hosted. Choose **Finish**. - - +One of the assumptions we are making here is that you are developing your app inside the corporate firewall. This represents a scenario where a developer working for a company would have a computer located behind the protection of the security infrastructure, developing and testing the app until it is ready to be deployed. This simplifies the process of connecting to the data source from Visual Studio, and uses Office Developer Tools for Visual Studio 2013 to automatically generate the external content type in e next step. -### Create an external content type - +### To create a new app + +1. Open Visual Studio 2012 on your development computer that has Office Developer Tools for Visual Studio 2013 and SharePoint stalled. +1. Create a new app for SharePoint. +1. Specify the name of the app, the local SharePoint URL that will host your site for testing, and ### Create an external content type To add a BDC model or external content type to your project, do the following. - - - ### To add an external content type - 1. With your new project still open, open the shortcut menu for the solution, and choose **Add**, **Content types for an External Data source**. - - -2. The first page of the wizard is used to specify the URL of the data service. On the **Specify OData Source** page, enter the URL of the OData service that you want to connect to. The URL should resemble the following: **http://services.odata.org/Northwind/Northwind.svc/**. - - -3. Choose a name for your OData source, and then choose **Next**. - - -4. A list of data entities that are being exposed by the OData service appears. Make sure that the **Create list instances for the selected data entities** check box is selected. - - -5. Select one or more of the entities, and choose **Finish**. - - -6. The last thing you have to do before deployment is modify the URL in your newly created external content type file. - - Open the .ect file in an XML editor. - - -7. Modify the `ODataServiceMetadataUrl` property to point to the URL that allows access through the reverse proxy. - - -8. Modify the `ODataServiceUrl` property with the URL that allows access through the reverse proxy. - - +1. The first page of the wizard is used to specify the URL of the data service. On the **Specify OData Source** page, enter the URL of the OData service that you want to connect to. The URL should resemble the following: `http://services.odata.org/Northwind/Northwind.svc/`. +1. Choose a name for your OData source, and then choose **Next**. +1. A list of data entities that are being exposed by the OData service appears. Make sure that the +1. The last thing you have to do before deployment is modify the URL in your newly created external content type file. + + Open the **\*.ect** file in an XML editor. + +1. Modify the `ODataServiceMetadataUrl` property to point to the URL that allows access through the reverse proxy. +1. Modify the `ODataServiceUrl` property with the URL that allows access through the reverse proxy. + For information about how to add an OData-based external content type, see [How to: Create an external content type from an OData source in SharePoint](how-to-create-an-external-content-type-from-an-odata-source-in-sharepoint.md). - - - ### Deploy the hybrid app - When it is time to deploy your app, you have a couple of choices. You can deploy it directly to a tenancy using F5 deployment, or you can package it using the publishing features of Visual Studio to create an .app file. This file can then be given to the SharePoint Online tenant administrator and uploaded. - - - -For information about deploying SharePoint Add-ins, see the following: - - - - -- [Deploying and installing SharePoint Add-ins: methods and options](https://msdn.microsoft.com/library/d15a74a7-3c10-485a-9885-7ef11aaa0d90%28Office.15%29.aspx) - - -- [Publish SharePoint Add-ins by using Visual Studio](https://msdn.microsoft.com/library/8137d0fa-52e2-4771-8639-60af80f693bb%28Office.15%29.aspx) - - -You can also take the BDCM file created for the external content type and extract that to be used at any level above the app. This is demonstrated in [How to: Convert an add-in-scoped external content type to tenant-scoped](how-to-convert-an-add-in-scoped-external-content-type-to-tenant-scoped.md). - - - + +For information about deploying SharePoint Add-ins, see the following: + +- [Deploying and installing SharePoint Add-ins: methods and options](https://msdn.microsoft.com/library/d15a74a7-3c10-485a-9885-7ef11aaa0d90%28Office.15%29.aspx + +- [Publish SharePoint Add-ins by using Visual Studio](https://msdn.microsoft.com/library/8137d0fa-52e2-4771-8639-60af80f693bb%28Office.15%29.aspx) + +You can also take the BDCM file created for the external content type and extract that to be used at any level above the app. This is demonstrated in [How to: Convert an add-in-scoped external ## See also - - - -- [Hybrid for SharePoint](https://technet.microsoft.com/library/jj838715.aspx) - - -- [Business Connectivity Services in SharePoint](business-connectivity-services-in-sharepoint.md) - - -- [How to: Create an external content type from an OData source in SharePoint](how-to-create-an-external-content-type-from-an-odata-source-in-sharepoint.md) - - -- [Publish SharePoint Add-ins by using Visual Studio](https://msdn.microsoft.com/library/8137d0fa-52e2-4771-8639-60af80f693bb%28Office.15%29.aspx) - - +- [Hybrid for SharePoint](https://technet.microsoft.com/library/jj838715.aspx) +- [Business Connectivity Services in SharePoint](business-connectivity-services-in-sharepoint.md) +- [How to: Create an external content type from an OData source in SharePoint](how-to-create-an-external-content-type-from-an-odata-source-in-sharepoint.md) diff --git a/docs/general-development/create-sharepoint-no-code-solutions.md b/docs/general-development/create-sharepoint-no-code-solutions.md index 09cf487fc..746ba7d28 100644 --- a/docs/general-development/create-sharepoint-no-code-solutions.md +++ b/docs/general-development/create-sharepoint-no-code-solutions.md @@ -1,9 +1,9 @@ --- title: Create SharePoint no-code solutions -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This is an article with links to learn about SharePoint Composites and creating no-code solutions. +ms.date: 06/07/2022 ms.assetid: 9511846c-d2c6-4f23-b5de-24be4749598a -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/creating-a-workflow-by-using-sharepoint-designer-and-the-sharepoint-wo.md b/docs/general-development/creating-a-workflow-by-using-sharepoint-designer-and-the-sharepoint-wo.md index f56cd518e..2a41cd9e9 100644 --- a/docs/general-development/creating-a-workflow-by-using-sharepoint-designer-and-the-sharepoint-wo.md +++ b/docs/general-development/creating-a-workflow-by-using-sharepoint-designer-and-the-sharepoint-wo.md @@ -1,212 +1,86 @@ --- title: Creating a workflow by using SharePoint Designer 2013 and the SharePoint Workflow platform -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This is an article with links to learn about creating a workflow by using SharePoint Designer 2013 and the SharePoint Workflow platform. +ms.date: 05/09/2023 ms.assetid: c05e0127-c6f5-48b8-b8f2-cbcc30149c8b -localization_priority: Priority +ms.localizationpriority: high --- +# Creating a workflow by using SharePoint Designer 2013 and the SharePoint Workflow platform +Learn how to install, open, and create a workflow by using SharePoint Designer 2013 and the SharePoint Workflow platform. -# Creating a workflow by using SharePoint Designer 2013 and the SharePoint Workflow platform -Learn how to install, open, and create a workflow by using SharePoint Designer 2013 and the SharePoint Workflow platform. - -> [!NOTE] -> SharePoint 2010 workflows have been retired since August 1, 2020 for new tenants and removed from existing tenants on November 1, 2020. If you’re using SharePoint 2010 workflows, we recommend migrating to Power Automate or other supported solutions. For more info, see [SharePoint 2010 workflow retirement](https://support.microsoft.com/office/sharepoint-2010-workflow-retirement-1ca3fff8-9985-410a-85aa-8120f626965f). +> [!CAUTION] +> SharePoint 2010 workflows have been retired since August 1, 2020 for new tenants and removed from existing tenants on November 1, 2020. If you’re using SharePoint 2010 workflows, we recommend migrating to Power Automate or other supported solutions. For more information, see [SharePoint 2010 workflow retirement](https://support.microsoft.com/office/sharepoint-2010-workflow-retirement-1ca3fff8-9985-410a-85aa-8120f626965f). +> [!CAUTION] +> SharePoint 2013 workflows are scheduled for retirement in April 2024. For more information, see: [SharePoint 2013 workflow retirement](https://support.microsoft.com/office/sharepoint-2013-workflow-retirement-4613d9cf-69aa-40f7-b6bf-6e7831c9691e). ## Install SharePoint Designer 2013 - -SharePoint Designer 2013 is a free download. To download and install SharePoint Designer 2013 follow these steps: - - - +SharePoint Designer 2013 is a free download. To download and install SharePoint Designer 2013 follow these steps: ### To install SharePoint Designer 2013 - -1. Open your web browser and navigate to the Microsoft Download Center: [https://www.microsoft.com/download](https://www.microsoft.com/download). - - -2. Type SharePoint Designer 2013 in the search field. - - -3. Click the link for "SharePoint Designer 2013". - - -4. Read the overview, system requirements, and installation instructions. Make sure your system is compatible. - - -5. Select your platform type: 64-bit ( **x64**) or 32-bit ( **x86**) as shown in the figure. - - -6. Follow the instructions to install SharePoint Designer 2013. - - +1. Open your web browser and navigate to the Microsoft Download Center: [https://www.microsoft.com/download](https://www.microsoft.com/download). +1. Type SharePoint Designer 2013 in the search field. +1. Click the link for "SharePoint Designer 2013". +1. Read the overview, system requirements, and installation instructions. Make sure your system is compatible. +1. Select your platform type: 64-bit ( **x64**) or 32-bit ( **x86**) as shown in the figure. +1. Follow the instructions to install SharePoint Designer 2013. **Figure: SharePoint Designer 2013 download page** - - - - - - - ![The SharePoint Designer 2013 Download page.](../images/SPD15-install-connect-1.png) - - - - - - - - - - - ## Open SharePoint Designer 2013 and connect to a SharePoint site - -SharePoint Designer 2013 installs as an Office 2013 application. To open SharePoint Designer 2013 and connect to a SharePoint site follow these steps: - - - -2013 -### To open SharePoint Designer 2013 and connect to a SharePoint site +SharePoint Designer 2013 installs as an Office 2013 application. To open SharePoint Designer 2013 and connect to a SharePoint site follow these steps: +### To open SharePoint Designer 2013 and connect to a SharePoint site -1. Open SharePoint Designer 2013 by selecting it on the **Start** menu. Click **Start** icon, click **All Programs**, click **Microsoft Office 2013**, and then click **SharePoint Designer 2013**. - - -2. Click **Open Site** on the SharePoint Designer 2013 start page. - - -3. Enter the SharePoint site that you want to connect to. For example, http://www.contoso.com/sites/a-sharepoint-site. - - -4. Click **Open** to open the site. - - -5. Enter your credentials, if prompted. (If security is not integrated with the computer you signed in on then you are prompted to enter your credentials.) Make sure to use credentials that have access to the SharePoint site. - - +1. Open SharePoint Designer 2013 by selecting it on the **Start** menu. Click **Start** icon, click **All Programs**, click **Microsoft Office 2013**, and then click **SharePoint Designer 2013**. +1. Click **Open Site** on the SharePoint Designer 2013 start page. +1. Enter the SharePoint site that you want to connect to. For example, `https://www.contoso.com/sites/a-sharepoint-site`. +1. Click **Open** to open the site. +1. Enter your credentials, if prompted. (If security is not integrated with the computer you signed in on then you are prompted to enter your credentials.) Make sure to use credentials that have access to the SharePoint site. ## Create a List workflow based on the SharePoint Workflow platform - SharePoint Designer 2013 can be used for many important tasks. The navigational pane is used to switch between different aspects of SharePoint Designer 2013. To create a new List workflow based on the SharePoint Workflow platform, follow these steps: - - - ### To create a workflow based on the SharePoint Workflow platform - 1. Click the Workflows node in the Navigation pane. - - -2. Click the **List Workflow** drop-down in the **New** section of the ribbon, as shown in the figure. - - -3. Select the list that you want to associate with the new workflow. - - -4. On the **Create List Workflow** dialog box, enter a name and description for the workflow and then make sure that the **Platform Type** is set to **SharePoint 2013 Workflow**, as shown in the figure. - +1. Click the **List Workflow** drop-down in the **New** section of the ribbon, as shown in the figure. +1. Select the list that you want to associate with the new workflow. +1. On the **Create List Workflow** dialog box, enter a name and description for the workflow and then make sure that the **Platform Type** is set to **SharePoint 2013 Workflow**, as shown in the figure. + > [!NOTE] - > If you do not see SharePoint Workflow as an available platform type then Workflow Manager is not configured to work with the SharePoint farm. See [Configure Workflow Manager to work with the SharePoint Server 2013 Farm](https://technet.microsoft.com/library/jj658588.aspx#section5). + > If you do not see SharePoint Workflow as an available platform type then Workflow Manager is not configured to work with the SharePoint farm. See [Configure Workflow Manager to work with the SharePoint Server 2013 Farm](https://technet.microsoft.com/library/jj658588.aspx#section5). -5. Click **OK** to create the workflow. - - +1. Click **OK** to create the workflow. **Figure: The ribbon button for creating a new list workflow** - - - - - - - ![SharePoint Designer 2013 - New List Workflow](../images/SPD15-install-connect-2.png) - - - - - - - - - - - **Figure: Create List Workflow dialog box** - - - - - - - ![Workflow Creation Dialog](../images/SPD15-install-connect-3.png) - - - - - - - - - - - -Now that the workflow is created, you can add Actions, Conditions, Stages, Steps, and Loops to build your workflow. These workflow components are available in the ribbon of SharePoint Designer 2013, as shown in the figure. - - - -**Figure: Workflow items for the SharePoint Workflow platform** +Now that the workflow is created, you can add Actions, Conditions, Stages, Steps, and Loops to build your workflow. These workflow components are available in the ribbon of SharePoint Designer 2013, as shown in the figure. - - - +**Figure: Workflow items for the SharePoint Workflow platform** - - - ![Workflow items in the ribbon.](../images/SPD15-install-connect-4.png) - + > [!NOTE] > The previous procedure is used to create a List workflow. A Reusable workflow or Site workflow can be created using the same procedure with the following modification. Instead of selecting the List Workflow button in the ribbon select the **Reusable Workflow** or **Site Workflow** button when creating the workflow. - - - To learn more about the available components of workflow development, see [Workflow actions quick reference (SharePoint Workflow platform)](workflow-actions-quick-reference-sharepoint-workflow-platform.md). - - - ## See also - - - -- [What's new in workflow in SharePoint](https://msdn.microsoft.com/library/6ab8a28b-fa2f-4530-8b55-a7f663bf15ea.aspx) - - -- [Getting started with SharePoint workflow](https://msdn.microsoft.com/library/cc73be76-a329-449f-90ab-86822b1c2ee8.aspx) - - -- [Workflow development in SharePoint Designer and Visio](workflow-development-in-sharepoint-designer-and-visio.md) - - - - - - +- [What's new in workflow in SharePoint](https://msdn.microsoft.com/library/6ab8a28b-fa2f-4530-8b55-a7f663bf15ea.aspx) +- [Getting started with SharePoint workflow](https://msdn.microsoft.com/library/cc73be76-a329-449f-90ab-86822b1c2ee8.aspx) +- [Workflow development in SharePoint Designer and Visio](workflow-development-in-sharepoint-designer-and-visio.md) diff --git a/docs/general-development/cross-site-publishing-in-sharepoint.md b/docs/general-development/cross-site-publishing-in-sharepoint.md index d19f8e005..bb0aac128 100644 --- a/docs/general-development/cross-site-publishing-in-sharepoint.md +++ b/docs/general-development/cross-site-publishing-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Cross-site publishing in SharePoint +description: SharePoint introduces a cross-site publishing feature that enables you to reuse content across multiple site collections. It uses built-in search capabilities to enable publishing scenarios and architectures. For the first time, you can design sites that cross SharePoint farms—enabling your sites to span the boundary between intranets and the Internet. ms.date: 06/18/2019 -ms.prod: sharepoint ms.assetid: 33f49e69-c1d3-4a6e-8887-5df683cba022 -localization_priority: Normal +ms.localizationpriority: medium --- # Cross-site publishing in SharePoint @@ -11,29 +11,29 @@ localization_priority: Normal SharePoint introduces a cross-site publishing feature that enables you to reuse content across multiple site collections. It uses built-in search capabilities to enable publishing scenarios and architectures. For the first time, you can design sites that cross SharePoint farms—enabling your sites to span the boundary between intranets and the Internet. > [!IMPORTANT] -> This capability is not available in SharePoint Online. Cross-site publishing capability is only available in on-premises deployments. +> This capability is not available in SharePoint Online. Cross-site publishing capability is only available in on-premises deployments. Consider a site with one authoring site collection that feeds multiple publishing site collections, with different domains, all crawled by public search engines and optimized for search engine optimization (SEO). Cross-site publishing enables this scenario and others like it, without requiring you to use content deployment. Cross-site publishing was designed with some common scenarios in mind, including: - + - Share an item list or a page library as a publishing catalog - Consume a catalog from search - Combine cross-site publishing with the variations feature to enable authoring multilingual sites from a common authoring site collection - + ## Catalogs Catalogs, introduced in SharePoint, include a list or library that is shared out to search for consumption on publishing sites. Catalogs enable content to be published across site collections—the cross-site publishing features depend on catalogs. You can use catalogs to really reuse content across your sites and across the boundary between your intranet sites, extranet sites, and Internet sites. For predefined search queries, catalogs are flagged in search. You can surface content stored in catalogs across site collections by using the [Content Search web part in SharePoint](content-search-web-part-in-sharepoint.md). - + ## When should I use cross-site publishing? There are some cases where cross-site publishing is not efficient or appropriate. Whether you have external data sources and how you connect to them, variations, site type, search database implementation, and use of the product catalog are all factors that should influence your decision. Table 1 provides more information about these design considerations. - - - + + + **Table 1. Design considerations for cross-site publishing** @@ -45,126 +45,126 @@ There are some cases where cross-site publishing is not efficient or appropriate |**Variations implementation**
|If you are implementing a basic variations site that makes a pages library, document library, and general lists available in a few languages, cross-site publishing makes sense. The same is true if you choose to implement managed navigation or structured navigation on a variations site.
Cross-site publishing works for some architectures but not others. For example, you can use cross-site publishing to publish content from a variations **SPSite** to a publishing site with variations enabled if the source **SPSite** is not consuming data from another variations site or site collection.
| |**Catalog implementation**
|Whether you implement the product catalog into your site architecture and how you implement it may affect whether cross-site publishing is the most effective or appropriate choice. If you are using the product catalog to support a multilingual variations site configuration and are publishing to an Internet site, you can implement cross-site publishing.
| |**Managed navigation**
|Cross-site publishing works with most implementations of managed navigation and the term store. In some implementations, navigation metadata transfer may not work as expected. For example, when one variations site depends on metadata from another variations site to drive site navigation, and you use cross-site publishing to publish content to the target site, navigation metadata transfer may not work as expected.
| - + ## How can I set up a catalog? -Category pages and catalog item pages are page layouts that you can use to show structured catalog content consistently across a site. SharePoint enables you to create and customize page layouts for SharePoint and above. For more information, see [Customize page layouts for a catalog-based site in SharePoint](https://msdn.microsoft.com/library/office/dn144674.aspx +Category pages and catalog item pages are page layouts that you can use to show structured catalog content consistently across a site. SharePoint enables you to create and customize page layouts for SharePoint and above. For more information, see [Customize page layouts for a catalog-based site in SharePoint](https://msdn.microsoft.com/library/office/dn144674.aspx ). - - - + + + ## Cross-site publishing APIs SharePoint introduces classes that you can use to support cross-site publishing implementation in your code. These APIs are available in the .NET server publishing library. Use them to customize how SharePoint shares lists as catalogs for content reuse or consumes a catalog from search. You can use the members of the following classes in custom code to support cross-site publishing tasks: - - - + + + - Use the **PublishingCatalogUtility** class to retrieve a list of available catalogs, get information about catalogs and their statuses, get information about lists and libraries that can be connected to catalogs, and start or stop sharing catalogs. - - - -```cs - + + + +```csharp + /// Retrieve available catalogs. public static List GetPublishingCatalogs(SPSite site, int startRow, int numberOfRows, string filterText, out int totalNumberOfCatalogs) ``` - - -```cs - + + +```csharp + ///Get catalog information that is saved for a list. public static bool GetCatalogConfiguration(SPList list, out CatalogShareSettings catalogSettings, out string selectedTaxonomyField) ``` - - -```cs - + + +```csharp + ///Stop sharing a list or library as a publishing catalog for cross-publishing content reuse. public static void UnPublishCatalog(SPList list) ``` - Use the **CatalogCollectionManager** class to consume catalogs from search. Learn about the connection that a catalog has to search, and get information about it. Add or remove a catalog from the internal collection of catalogs, and queue an operation to queue up a connection that is configured to rewrite URLs when the **Update** method is called. - - - -```cs - + + + +```csharp + /// Add catalog or site source into the internal CatalogInfo collection, but the source is not persisted into the property bag. public void AddCatalogConnection(CatalogConnectionSettings catalogInfo) ``` - - -```cs - + + +```csharp + /// Queues an Add operation to add a connection configured to rewrite URLs. The connection is added to the store when the Update method is called. -public void AddCatalogConnection(CatalogConnectionSettings catalogInfo, +public void AddCatalogConnection(CatalogConnectionSettings catalogInfo, string[] orderedPropertiesForUrlRewrite, -string webUrl, +string webUrl, string catalogTaxonomyManagedProperty, bool isManualRule) ``` - - -```cs - + + +```csharp + /// Update existing catalog/site source in the internal CatalogInfo collection. Edits are not committed until the Update method is called. public void UpdateCatalogConnection(CatalogConnectionSettings catalogInfo) ``` - - -```cs - + + +```csharp + /// Remove a catalog or site source. Deletion is not committed until the Update method is called. public void DeleteCatalogConnection(string catalogPath) ``` - - -```cs - + + +```csharp + /// Determine whether a connection exists to this source from the site. public bool Contains(string catalogPath) ``` - - -```cs - + + +```csharp + /// Get the settings for a catalog connected to this site. public CatalogConnectionSettings GetCatalogConnectionSettings(string catalogPath) ``` diff --git a/docs/general-development/custom-content-processing-with-the-content-enrichment-web-service-callout.md b/docs/general-development/custom-content-processing-with-the-content-enrichment-web-service-callout.md index e97ef5e14..7c4275829 100644 --- a/docs/general-development/custom-content-processing-with-the-content-enrichment-web-service-callout.md +++ b/docs/general-development/custom-content-processing-with-the-content-enrichment-web-service-callout.md @@ -1,177 +1,96 @@ --- title: Custom content processing with the Content Enrichment web service callout -ms.date: 09/25/2017 -ms.prod: sharepoint +description: This is an article to learn about custom content processing with the Content Enrichment web service callout. +ms.date: 05/18/2023 ms.assetid: bdda92c8-9c8d-416e-9a6b-4a9373686fa0 -localization_priority: Normal +ms.localizationpriority: medium --- - - # Custom content processing with the Content Enrichment web service callout + Learn about the content enrichment web service callout in SharePoint that enables developers to create an external web service to modify managed properties for crawled items during content processing. + Search in SharePoint enables users to modify the managed properties of crawled items before they are indexed by calling out to an external content enrichment web service. The ability to modify managed properties for items during content processing is helpful when performing tasks such as data cleansing, entity extraction, classification, and tagging. - - - +![Content enrichment within content processing](../images/SP15_Content_Enrichment.gif) **Figure 1. Content enrichment within content processing** - - - - - - - -![Content enrichment within content processing](../images/SP15_Content_Enrichment.gif) - - - -Figure 1 shows a part of the process that takes place in the content processing component. The content enrichment web service is a SOAP-based service that you can create to receive a callout from the web service client inside the content processing component. Based on Figure 1, the web service client refers to the Content Enrichment operator inside the content processing component; theweb service refers to the SOAP web service that you implement.The web service receives a configurable payload from the content processing component. Then, the resulting response from the web service is merged into the crawled item before it is added to the search index. The web service client works with managed properties that you can configure as input properties or as output properties. Input properties are sent to the web service; output properties are returned by the web service. Certain managed properties are hidden or are read-only and can't be sent to the web service or received from the web service. See [How to list all read-only managed properties for the Content Enrichment web service](#SP15contentprocess_read-only_managed_properties) for information about how to verify which managed properties are read-only. - -> **Important:** -> The content enrichment callout step can only be configured with a single web service endpoint. Any kind of fault tolerance, or routing capabilities to support multiple implementations must be handled by the developer implementing the web service. In addition, the developer may have various web service implementations hosted at different endpoints; however, at any given time, only one of these endpoints can be used in the configuration. - - - +Figure 1 shows a part of the process that takes place in the content processing component. The content enrichment web service is a SOAP-based service that you can create to receive a callout from the web service client inside the content processing component. Based on Figure 1, the web service client refers to the Content Enrichment operator inside the content processing component; the web service refers to the SOAP web service that you implement.The web service receives a configurable payload from the content processing component. Then, the resulting response from the web service is merged into the crawled item before it is added to the search index. The web service client works with managed properties that you can configure as input properties or as output properties. Input properties are sent to the web service; output properties are returned by the web service. Certain managed properties are hidden or are read-only and can't be sent to the web service or received from the web service. See [How to list all read-only managed properties for the Content Enrichment web service](#how-to-list-all-read-only-managed-properties-for-the-content-enrichment-web-service) for information about how to verify which managed properties are read-only. +> [!IMPORTANT] +> The content enrichment callout step can only be configured with a single web service endpoint. Any kind of fault tolerance, or routing capabilities to support multiple implementations must be handled by the developer implementing the web service. In addition, the developer may have various web service implementations hosted at different endpoints; however, at any given time, only one of these endpoints can be used in the configuration. ## Content enrichment web service contract - The web service client is a SOAP (version 1.1) RPC client with a predefined behavior. The web service contract has the following characteristics: - - - - The content processing component sends a SOAP RPC call to a configurable endpoint over HTTP. - - - The payload contains an array of property objects. - - - The web service performs some custom logic on the array of property objects, and returns an array of modified or new property objects. - - - The web service must send a response to the web service client within a given timeout. - - - No specific authentication or encryption mechanisms are supported as part of the contract. You can, however, apply your own security on the transport mechanism. - - ## Configuring the Content Enrichment web service client - To configure the web service client, you use the following Windows PowerShell cmdlets: - - - - -- [Get-SPEnterpriseSearchContentEnrichmentConfiguration](https://technet.microsoft.com/library/jj219783%28office.15%29.aspx) - - -- [Set-SPEnterpriseSearchContentEnrichmentConfiguration](https://technet.microsoft.com/library/jj219659%28office.15%29.aspx) - - -- [Remove-SPEnterpriseSearchContentEnrichmentConfiguration](https://technet.microsoft.com/library/jj219742%28office.15%29.aspx) - - -- [New-SPEnterpriseSearchContentEnrichmentConfiguration](https://technet.microsoft.com/library/jj219502%28office.15%29.aspx) - - + +- [Get-SPEnterpriseSearchContentEnrichmentConfiguration](https://technet.microsoft.com/library/jj219783%28office.15%29.aspx) +- [Set-SPEnterpriseSearchContentEnrichmentConfiguration](https://technet.microsoft.com/library/jj219659%28office.15%29.aspx) +- [Remove-SPEnterpriseSearchContentEnrichmentConfiguration](https://technet.microsoft.com/library/jj219742%28office.15%29.aspx) +- [New-SPEnterpriseSearchContentEnrichmentConfiguration](https://technet.microsoft.com/library/jj219502%28office.15%29.aspx) + Table 1 lists the properties you can configure through the Windows PowerShell cmdlets mentioned previously. - - - **Table 1. Properties that are configurable for the client by using Windows PowerShell cmdlets** - -|**Configuration property**|**Description**|**Default value**| -|:-----|:-----|:-----| -|**Endpoint**
|Specifies the URL of the external web service.
|Empty.
| -|**InputProperties**
|The managed properties that the external web service receives.
|Empty.
| -|**OutputProperties**
|The managed properties that the external web service returns.
|Empty.
| -|**Timeout**
|The amount of time until the web service times out in milliseconds.
Depending on **FailureMode**, the item fails to be processed or a warning is written to the ULS log.
|5000 milliseconds; Valid range [100, 30000].
| -|**SendRawData**
|Enables or disables sending raw data to the web service.
|False.
| -|**MaxRawDataSize**
|The maximum size of raw data sent to the web service in kilobytes (KB). If the binary data of an item exceeds this limit, the item is not sent. This does not prevent the **InputProperties** from being sent, and the **OutputProperties** from being received.
|5120 kilobytes.
| -|**FailureMode**
|Controls the behavior of the web service client when errors occur. When **FailureMode** is set to **ERROR**, any problems that occur during content enrichment processing send a failed callback for that particular item.
When **FailureMode** is set to **WARNING**, the item is indexed, without any modifications by the web service and a warning is written to the ULS log.
|Error.
| -|**DebugMode**
|A mode that when set to **true** enables the content enrichment client to send all managed properties to the client without expecting any properties in return. Any configured **Trigger** property, **InputProperties** property, and **OutputProperties** property are ignored.
|False.
| -|**Trigger**
|A **Boolean** predicate that is executed on every crawled item. If the predicate evaluates to **true**, the record is sent to the web service. Otherwise, the item is passed through to the search index.
|Empty.
| - +| **Configuration property** | **Description** | **Default value** | +| :------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------- | +| **Endpoint** | Specifies the URL of the external web service. | Empty. | +| **InputProperties** | The managed properties that the external web service receives. | Empty. | +| **OutputProperties** | The managed properties that the external web service returns. | Empty. | +| **Timeout** | The amount of time until the web service times out in milliseconds. Depending on **FailureMode**, the item fails to be processed or a warning is written to the ULS log. | 5000 milliseconds; Valid range [100, 30000]. | +| **SendRawData** | Enables or disables sending raw data to the web service. | False. | +| **MaxRawDataSize** | The maximum size of raw data sent to the web service in kilobytes (KB). If the binary data of an item exceeds this limit, the item is not sent. This does not prevent the **InputProperties** from being sent, and the **OutputProperties** from being received. | 5120 kilobytes. | +| **FailureMode** | Controls the behavior of the web service client when errors occur. When **FailureMode** is set to **ERROR**, any problems that occur during content enrichment processing send a failed callback for that particular item. When **FailureMode** is set to **WARNING**, the item is indexed, without any modifications by the web service and a warning is written to the ULS log. | Error. | +| **DebugMode** | A mode that when set to **true** enables the content enrichment client to send all managed properties to the client without expecting any properties in return. Any configured **Trigger** property, **InputProperties** property, and **OutputProperties** property are ignored. | False. | +| **Trigger** | A **Boolean** predicate that is executed on every crawled item. If the predicate evaluates to **true**, the record is sent to the web service. Otherwise, the item is passed through to the search index. | Empty. | ### How to list all read-only managed properties for the Content Enrichment web service - Certain managed properties are read-only and cannot be output from the web service. These properties can be listed by using the [Get-SPEnterpriseSearchServiceApplication](https://technet.microsoft.com/library/ff608050%28office.15%29.aspx) and [Get-SPEnterpriseSearchMetadataManagedProperty](https://technet.microsoft.com/library/ff607560%28office.15%29.aspx)Windows PowerShell cmdlets, shown in the following example: - - - - -``` +```powershell $ssa = Get-SPEnterpriseSearchServiceApplication Get-SPEnterpriseSearchMetadataManagedProperty -SearchApplication $ssa | ?{$_.IsReadOnly -or $_.MappingDisallowed -or $_.DeleteDisallowed} - ``` - ## About trigger conditions for configuring the web service callout - A trigger condition is an expression that is used to configure the web service callout. If a trigger condition evaluates to **true**, the web service client performs a callout for that record. If a trigger condition evaluates to **false**, the web service client does not perform a callout and passes the crawled item to the search index. Alternatively, if no trigger condition is configured; all items are sent to the web service. - - - -Trigger conditions use an expression language to refer to the values of managed properties. You can use the operators and functions in the expression language to build simple or complex trigger conditions so you can determine when to perform a web service callout. - - - + +Trigger conditions use an expression language to refer to the values of managed properties. You can use the operators and functions in the expression language to build simple or complex trigger conditions so you can determine when to perform a web service callout. + Table 2 lists examples of trigger conditions. - - - **Table 2. Trigger condition examples for configuring the Content Enrichment web service callout** +| **Expression** | **Description** | **Requirements** | +| :-------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------- | +| MP1 > 2 | Returns **true** if the value of the managed property named MP1 is greater than 2. | MP1 must have a numeric type. | +| IsNull(MP2) | Returns **true** if the managed property named MP2 is not present for the crawled item or is empty/null. | MP2 can be of any type. | +| StartsWith(MP1, "sample") AND MP2 != 18 | Returns **true** if the value in the managed property MP1 starts with "sample" and the value of managed property MP2 is not 18. | MP1 must be of type **string** and MP2 must be a numeric type. | +| IsDay(MP1, 2009, 12, 24) | Checks whether the managed property MP1 contains a **DateTime** that falls on December 24, 2009. | MP1 must be of type **DateTime**. | -|**Expression**|**Description**|**Requirements**| -|:-----|:-----|:-----| -|MP1 > 2
|Returns **true** if the value of the managed property named MP1 is greater than 2.
|MP1 must have a numeric type.
| -|IsNull(MP2)
|Returns **true** if the managed property named MP2 is not present for the crawled item or is empty/null.
|MP2 can be of any type.
| -|StartsWith(MP1, "sample") AND MP2 != 18
|Returns **true** if the value in the managed property MP1 starts with "sample" and the value of managed property MP2 is not 18.
|MP1 must be of type **string** and MP2 must be a numeric type.
| -|IsDay(MP1, 2009, 12, 24)
|Checks whether the managed property MP1 contains a **DateTime** that falls on December 24, 2009.
|MP1 must be of type **DateTime**.
| - -See [Trigger expressions syntax in SharePoint](trigger-expressions-syntax-in-sharepoint.md) for the elements that can be used in a trigger expression and a list of supported functions. - - - +See [Trigger expressions syntax in SharePoint](trigger-expressions-syntax-in-sharepoint.md) for the elements that can be used in a trigger expression and a list of supported functions. ## Implementing the Content Enrichment external web service - -For a basic implementation, do the following: - - - +For a basic implementation, do the following: 1. Include the **Microsoft.Office.Server.Search.ContentProcessingEnrichment.dll** located in `C:\\Program Files\\Microsoft Office Servers\\15.0\\Search\\Applications\\External` in your project as a reference. - - -2. Implement **IContentProcessingEnrichmentService** as a web service. - - +1. Implement **IContentProcessingEnrichmentService** as a web service. ## See also - - - -- [Configure search in SharePoint](configure-search-in-sharepoint.md) - - -- [Custom content processing with the Content Enrichment web service callout](custom-content-processing-with-the-content-enrichment-web-service-callout.md) - - +- [Configure search in SharePoint](configure-search-in-sharepoint.md) +- [Custom content processing with the Content Enrichment web service callout](custom-content-processing-with-the-content-enrichment-web-service-callout.md) diff --git a/docs/general-development/custom-security-trimming-for-search-in-sharepoint-server.md b/docs/general-development/custom-security-trimming-for-search-in-sharepoint-server.md index c92b32cfd..dba0ab609 100644 --- a/docs/general-development/custom-security-trimming-for-search-in-sharepoint-server.md +++ b/docs/general-development/custom-security-trimming-for-search-in-sharepoint-server.md @@ -1,9 +1,9 @@ --- title: Custom security trimming for Search in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Learn about the two kinds of custom security trimmer interfaces, ISecurityTrimmerPre and ISecurityTrimmerPost, and the steps you must take to create a custom security trimmer. +ms.date: 06/09/2022 ms.assetid: fbbf0cc4-e135-426a-9996-34eb954dbd5a -localization_priority: Normal +ms.localizationpriority: medium --- @@ -11,192 +11,192 @@ localization_priority: Normal # Custom security trimming for Search in SharePoint Learn about the two kinds of custom security trimmer interfaces, **ISecurityTrimmerPre** and **ISecurityTrimmerPost**, and the steps you must take to create a custom security trimmer. At query time, Search in SharePoint performs security trimming of search results that are based on the identity of the user submitting the query, by using the security information obtained from the crawl component. - - - + + + You might have certain scenarios, however, in which the built-in security trimming results aren't sufficient for your requirements. In such scenarios, you need to implement custom security trimming. Search in SharePoint provides support for custom security trimming through the [ISecurityTrimmerPre](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.ISecurityTrimmerPre.aspx) interface, [ISecurityTrimmerPost](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.ISecurityTrimmerPost.aspx) interface, and [ISecurityTrimmer2](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.ISecurityTrimmer2.aspx) interface (deprecated) in the [Microsoft.Office.Server.Search.Query](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.aspx) namespace. > [!NOTE] > Custom pre-trimmers don't support Windows SIDs in ACLs, only claims. If any of the SID claim types are returned from a custom pre-trimmer, the resulting ACEs in the index will be encoded as a claim, not as SID. Hence they do not match Windows user identities that are based on SIDs. - - - + + + ## Implementing the interfaces for custom security trimming The **ISecurityTrimmerPre** interface carries out pre-trimming, or pre-query evaluation, where the search query is rewritten to add security information before the search query is matched to the search index. The **ISecurityTrimmerPost** interface carries out post-trimming, or post-query evaluation, where the search results are pruned before they are returned to the user. - - - + + + We recommend the use of pre-trimming for performance and general correctness; pre-trimming prevents information leakage for refiner data and hit count instances. Post-trimmers can be used in cases where the security trimming cannot be represented accurately with query filters; for example, if there is a need to filter away documents depending on the local time of the user issuing the query, such as during official business hours only. - - - + + + ### Implementing the ISecurityTrimmerPre interface To create a custom security pre-trimmer for search results, you must create a component that implements the **ISecurityTrimmerPre** interface. - - - + + + The **ISecurityTrimmerPre** interface contains two methods that you must implement: [Initialize(NameValueCollection, SearchServiceApplication)](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.ISecurityTrimmerPre.Initialize.aspx) and [AddAccess(Boolean, Claims)](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.ISecurityTrimmerPre.AddAccess.aspx) . - - - + + + #### Initialize Method The **Initialize** method is executed when the security pre-trimmer is loaded into the worker process, and does not execute again until the worker process is recycled. Two parameters are passed into the method: - - - + + + - _staticProperties_: A [NameValueCollection](https://msdn.microsoft.com/library/System.Collections.Specialized.NameValueCollection.aspx) object containing the configuration properties that are specified for the security trimmer when it is registered with the Search service application. - - + + - _searchApplication_: A [SearchServiceApplication](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.SearchServiceApplication.aspx) object that represents the Search service application. - - + + #### AddAccess Method The **AddAccess** method is executed once per pre-trimmer, for each incoming query before the query is evaluated. - - - -Two parameters are passed into this method: - - - + + + +Two parameters are passed into this method: + + + - _sessionProperties_: A **[T:System.Collections.Generic.IDictionary]** object that contains the properties of the query. - - + + - _userIdentity_: A [IIdentity](https://msdn.microsoft.com/library/System.Security.Principal.IIdentity.aspx) object that contains the user identity. - - + + ### Implementing the ISecurityTrimmerPost interface To create a custom security post-trimmer for search results, you must create a component that implements the **ISecurityTrimmerPost** interface. - - - -The **ISecurityTrimmerPost** interface contains two methods that you must implement: [Initialize(NameValueCollection, SearchServiceApplication)](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.ISecurityTrimmerPost.Initialize.aspx) and **CheckAccess(IList, IList, IDictionary, IIdentity)**. - - - + + + +The **ISecurityTrimmerPost** interface contains two methods that you must implement: [Initialize(NameValueCollection, SearchServiceApplication)](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.ISecurityTrimmerPost.Initialize.aspx) and **CheckAccess(IList\, IList\, IDictionary\, IIdentity)**. + + + #### Initialize method The **Initialize** method is executed when the security trimmer is loaded into the worker process, and does not execute again until the worker process is recycled. Two parameters are passed into the method:and - - - + + + - _staticProperties_: A [NameValueCollection](https://msdn.microsoft.com/library/System.Collections.Specialized.NameValueCollection.aspx) object containing the configuration properties specified for the security trimmer when it is registered with the Search service application. - - + + - _searchApplication_: A [SearchServiceApplication](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.SearchServiceApplication.aspx) object that represents the Search service application. - - + + #### CheckAccess method The **CheckAccess** method is executed once per post-trimmer, for each result set query, after the query is evaluated. - - - + + + Four parameters are passed into this method: - - - + + + - _documentUrls_: A [IList\](https://msdn2.microsoft.com/library/5y536ey6) object that contain the URLs for each content item from the search results that match the crawl rule. - - + + - _documentAcls_: A [IList\](https://msdn2.microsoft.com/library/5y536ey6) object containing item ACLs for each content item whose access is to be determined by the security trimmer implementation. - - + + - _sessionProperties_: A [IDictionary\](https://msdn2.microsoft.com/library/s4ys34ea) object containing the transient property bag. - - + + - _userIdentity_: An [IIdentity](https://msdn.microsoft.com/library/System.Security.Principal.IIdentity.aspx) object from which implementers can retrieve the user's identity. - - + + The **CheckAccess** method returns a [BitArray](https://msdn.microsoft.com/library/System.Collections.BitArray.aspx) object that represents an array of **true** or **false** values, one for each content item URL in the **IList** object that is passed as the first parameter of the method. The query processing component uses these values to perform the security post-trimming of the results. If the array value for a particular content item is **true**, the item is included in the returned results; if the array value is **false**, the item is removed. - - - + + + When implementing the **CheckAccess** method, you can use two pieces of information for each item to determine whether to return **true** or **false** for the item: the identity of the user who submitted the query and the URL of the content item. Alternatively, you can also pass custom document ACL information from the connector to the **CheckAccess** method. - - - + + + #### Retrieving the user identity for your security trimmer You can retrieve the user's identity by accessing the thread's current principal, as shown in the following code example. - - - -```cs + + + +```csharp IIdentity userIdentity = System.Threading.Thread.CurrentPrincipal.Identity; ``` You must also include the following namespace directive. - - - -```cs + + + +```csharp using System.Security.Principal; ``` You can also retrieve the identity of the user from the **CheckAccess** method's **passedUserIdentity** parameter. - - - + + + #### Passing document ACLs from the connector to your security trimmers A connector, as the name implies, is a communication bridge between SharePoint and the external system that hosts the external data. If you are working with custom connectors, you can pass the document's ACL information directly to the post-trimmer by setting the **docaclmeta** document property. As long as the configured connectors and post-trimmers have the same format and interpretation of the field, you are free to use it to pass custom data. - - - + + + The strings stored in **docaclmeta** by the connector will surface in the _documentAcls_ parameter when the **CheckAccess** method of the custom security trimmer is invoked. The regular document ACLs in the **docacl** property are processed by basic security trimming and are not visible to the custom security trimmer. Similarly, the **docaclmeta** property does not have any effect on basic security trimming. - - - + + + #### Post-trimmers and their effect on refiner count for security trimmers When working with post-trimmers, it is important to notice that there are two types of result tables: **RelevantResults** and the **RefinementResults**. Post-trimmers are applied only to the result hits in the **RelevantResults**. Consequently, there may be refiners related to the post-trimmed hits and the **RefinementResults** count may be larger than or equal to the **RelevantResults**. You can address this behavior in two ways: - - - + + + - Exclude the sensitive refiners from the refinement panel in the default web part so that no information is leaked via the refiners. - - + + - Use a custom web part to display results or refiners when using post-trimmers so that the **RefinementResults** may be elegantly hidden in cases where the **RefinementResults** count exceeds the **RelevantResults** count. - - + + ### Retrieving individual configuration properties for your security trimmer You can access an individual configuration property by using the property name that was specified when the security post-trimmer was registered. For example, the following code retrieves the value for a configuration property named **CheckLimit**. - - - -```cs + + + +```csharp public void Initialize(NameValueCollection staticProperties, SearchServiceApplication searchApplication) { if (staticProperties["CheckLimitProperty"] != null) @@ -211,55 +211,55 @@ public void Initialize(NameValueCollection staticProperties, SearchServiceApplic After you create the custom security trimmer, you must deploy it to the global assembly cache on any server in the Query role. Step 2 in [How to: Use a custom security trimmer for SharePoint Server search results](how-to-use-a-custom-security-trimmer-for-sharepoint-server-search-results.md) describes the process for deploying the custom security trimmer to the global assembly cache. - - - + + + ## Registering the custom security trimmer For post-trimmers, you must associate a custom security trimmer registration with a specific Search service application and crawl rule; for pre-trimmers, this is optional. - - - + + + You use the **SPEnterpriseSearchSecurityTrimmer** cmdlet of the SharePoint Management Shell to register a custom security trimmer. - - - + + + The following table describes the parameters that the cmdlet uses. - - - + + + **Table 1. Parameters used by the SPEnterpriseSearchSecurityTrimmer cmdlet** -|**Parameter**|**Description**| +|Parameter|Description| |:-----|:-----| | _SearchApplication_
|Required. The name of the Search service application, for example "Search Service Application".
| | _typeName_
|Required. The strong name of the custom security trimmer assembly.
| | _RulePath_
|Required for post-trimmers; optional for pre-trimmers. The crawl rule for the security trimmer.
**Note**: We recommend using one crawl rule per content source. | | _id_
|Required. The security trimmer identifier (ID). This value is unique; if a security trimmer is registered with an ID that is already registered for another security trimmer, the registration for the first trimmer is overwritten with the registration for the second trimmer.
| | _properties_
|Optional. The name-value pairs specifying the configuration properties. Must be in the following format: `Name1~Value1~Name2~Value~???`
| - + For an example of a basic command for registering a custom security trimmer and a sample that specifies the configuration properties, see [How to: Use a custom security trimmer for SharePoint Server search results](how-to-use-a-custom-security-trimmer-for-sharepoint-server-search-results.md). - - - + + + ## See also - [How to: Use a custom security trimmer for SharePoint Server search results](how-to-use-a-custom-security-trimmer-for-sharepoint-server-search-results.md) - - + + - [ISecurityTrimmerPre](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.ISecurityTrimmerPre.aspx) - - + + - [ISecurityTrimmerPost](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.ISecurityTrimmerPost.aspx) - - + + - [Overview of Business Connectivity Services in SharePoint](https://technet.microsoft.com/library/ee661740.aspx) - - + + diff --git a/docs/general-development/custom-word-breakers-in-sharepoint-server.md b/docs/general-development/custom-word-breakers-in-sharepoint-server.md index 7e2ccff51..c4869dcbb 100644 --- a/docs/general-development/custom-word-breakers-in-sharepoint-server.md +++ b/docs/general-development/custom-word-breakers-in-sharepoint-server.md @@ -1,293 +1,99 @@ --- title: Custom word breakers in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes word breaking in SharePoint and provides steps on how to switch to a custom word breaker in SharePoint. +ms.date: 05/09/2023 ms.assetid: d18b48d4-987c-4228-9932-30d5b30f86a2 -localization_priority: Normal +ms.localizationpriority: medium --- - # Custom word breakers in SharePoint -Learn about word breaking in SharePoint. -Word breaking is one of the key Natural Language Processing (NLP) features that enable search and improve search results (or recall). Word breakers split a stream of text into individual words or tokens on which you can base additional language processing. Word breakers are language-specific. In addition to built-in word breakers, Search in SharePoint enables the use of custom word breakers so that users can tune word breaking behavior according to their needs. See [Supported languages for word breaker customizations in SharePoint](#SP15_SupportedLanguages) for a list languages supported for word breaker customization. - - - -For information on how to write a word breaker refer to the following articles -- [Implementing a Word Breaker](https://msdn.microsoft.com/library/ms693186%28v=vs.85%29.aspx) - - -- [IWordBreaker interface](https://msdn.microsoft.com/library/ms691079%28v=vs.85%29.aspx) - - +Word breaking is one of the key Natural Language Processing (NLP) features that enable search and improve search results (or recall). Word breakers split a stream of text into individual words or tokens on which you can base additional language processing. Word breakers are language-specific. In addition to built-in word breakers, Search in SharePoint enables the use of custom word breakers so that users can tune word breaking behavior according to their needs. See [Supported languages for word breaker customizations in SharePoint](#supported-languages-for-word-breaker-customizations-in-sharepoint) for a list languages supported for word breaker customization. -## How to switch to a custom word breaker in SharePoint - +For information on how to write a word breaker refer to the following articles + +- [Implementing a Word Breaker](https://msdn.microsoft.com/library/ms693186%28v=vs.85%29.aspx) +- [IWordBreaker interface](https://msdn.microsoft.com/library/ms691079%28v=vs.85%29.aspx) +## How to switch to a custom word breaker in SharePoint -> **Caution:** -> When you replace existing word breakers, you modify the registry at your own risk. Serious problems might occur if you modify the registry incorrectly by using Registry Editor or by using another method. These problems might require that you reinstall the operating system. Microsoft cannot ensure that these problems can be solved. Switching to a different word breaker might also cause serious problems during indexing and querying. Before you modify the registry, back up the registry and ensure that you know how to restore the registry if a problem occurs. - - - +> [!CAUTION] +> When you replace existing word breakers, you modify the registry at your own risk. Serious problems might occur if you modify the registry incorrectly by using Registry Editor or by using another method. These problems might require that you reinstall the operating system. Microsoft cannot ensure that these problems can be solved. Switching to a different word breaker might also cause serious problems during indexing and querying. Before you modify the registry, back up the registry and ensure that you know how to restore the registry if a problem occurs. Take the following steps to replace the existing word breaker with a custom word breaker or replace the existing word breaker with a word breaker in another language. - - - 1. Open the Registry Editor, as follows: - 1. Choose **Start**, and then choose **Run**. - - -2. In the **Open** dialog box, type **Regedit**, and then choose **OK**. - - -2. In Registry Editor, select the following registry subkey: - +1. In the **Open** dialog box, type **Regedit**, and then choose **OK**. +1. In Registry Editor, select the following registry subkey: + **HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Office Server\\15.0\\Search\\Setup\\ContentIndexCommon\\LanguageResources\\Default\\** _language from the list below_ - - -3. In the right pane, open the shortcut menu for the **WBDLLPathOverride** registry value, and then choose **Modify**. - - -4. In the **Edit String** dialog box, in the **Value data** box, type the path to your custom word breaker DLL, and then choose **OK**. The new DLL should be located in the same path as the existing DLL that is being replaced. - - -5. In the right pane, open the shortcut menu for the **WBreakerClass** registry value, and then choose **Modify**. - - -6. In the **Edit String** dialog box, in the **Value data** box, type the class ID of your custom word breaker, and then choose **OK**. - - -7. Restart the SharePoint Search Host Controller and SharePoint. - - -8. Do a full re-crawl. - - + +1. In the right pane, open the shortcut menu for the **WBDLLPathOverride** registry value, and then choose **Modify**. +1. In the **Edit String** dialog box, in the **Value data** box, type the path to your custom word breaker DLL, and then choose **OK**. The new DLL should be located in the same path as the existing DLL that is being replaced. +1. In the right pane, open the shortcut menu for the **WBreakerClass** registry value, and then choose **Modify**. +1. In the **Edit String** dialog box, in the **Value data** box, type the class ID of your custom word breaker, and then choose **OK** + + Restart the SharePoint Search Host Controller and SharePoint. + +1. Do a full re-crawl. ## Supported languages for word breaker customizations in SharePoint - The following languages are supported for word breaker customization: - - - -Arabic - - - -Bengali - - - -Bulgarian - - - -Catalan - - - -Chinese (People's Republic of China) - - - -Chinese (Taiwan) - - - -Croatian - - - -Czech - - - -Danish - - - -Dutch (Dutch) - - - -English (United States) - - - -Estonian - - - -Finnish - - - -French (Standard) - - - -German (Standard) - - - -Greek - - - -Gujarati - - - -Hebrew - - - -Hindi - - - -Hungarian - - - -Icelandic - - - -Indonesian - - - -Italian (Default) - - - -Japanese - - - -Kannada - - - -Kazakh - - - -Korean - - - -Latvian - - - -Lithuanian - - - -Malay - - - -Malayalam - - - -Marathi - - - -Norwegian - - - -Polish - - - -Portuguese (Portuguese) - - - -Punjabi - - - -Romanian - - - -Russian - - - -Serbian (Cyrillic) - - - -Slovak - - - -Slovenian - - - -Spanish (Modern Sort) - - - -Swedish - - - -Tamil - - - -Telugu - - - -Thai - - - -Turkish - - - -Ukrainian - - - -Urdu - - - -Vietnamese - - - -## See also - +- Arabic +- Bengali +- Bulgarian +- Catalan +- Chinese (People's Republic of China) +- Chinese (Taiwan) +- Croatian +- Czech +- Danish +- Dutch (Dutch) +- English (United States) +- Estonian +- Finnish +- French (Standard) +- German (Standard) +- Greek +- Gujarati +- Hebrew +- Hindi +- Hungarian +- Icelandic +- Indonesian +- Italian (Default) +- Japanese +- Kannada +- Kazakh +- Korean +- Latvian +- Lithuanian +- Malay +- Malayalam +- Marathi +- Norwegian +- Polish +- Portuguese (Portuguese) +- Punjabi +- Romanian +- Russian +- Serbian (Cyrillic) +- Slovak +- Slovenian +- Spanish (Modern Sort) +- Swedish +- Tamil +- Telugu +- Thai +- Ukrainian +- Urdu +- Vietnamese +## See also -- [Configure search in SharePoint](configure-search-in-sharepoint.md) - - -- [Implementing a Word Breaker](https://msdn.microsoft.com/library/ms693186%28v=vs.85%29.aspx) - - -- [IWordBreaker interface](https://msdn.microsoft.com/library/ms691079%28v=vs.85%29.aspx) - - - +- [Configure search in SharePoint](configure-search-in-sharepoint.md) +- [Implementing a Word Breaker](https://msdn.microsoft.com/library/ms693186%28v=vs.85%29.aspx) +- [IWordBreaker interface](https://msdn.microsoft.com/library/ms691079%28v=vs.85%29.aspx) diff --git a/docs/general-development/customizing-ranking-models-to-improve-relevance-in-sharepoint.md b/docs/general-development/customizing-ranking-models-to-improve-relevance-in-sharepoint.md index 57286c5b2..51c54d1a6 100644 --- a/docs/general-development/customizing-ranking-models-to-improve-relevance-in-sharepoint.md +++ b/docs/general-development/customizing-ranking-models-to-improve-relevance-in-sharepoint.md @@ -1,14 +1,13 @@ --- title: Customizing ranking models to improve relevance in SharePoint description: Improve search relevance by customizing ranking models to calculate rank scores (relevance rank) accurately using rank features in SharePoint. -ms.date: 12/14/2020 -ms.prod: sharepoint +ms.date: 07/15/2022 ms.assetid: c166ecdd-7f93-4bbb-b543-2687992dd2bc -localization_priority: Priority +ms.localizationpriority: high --- # Customizing ranking models to improve relevance in SharePoint -**APPLIES TO:** ![Applies to SharePoint Server 2013](https://docs.microsoft.com/sharepoint/sharepointserver/media/yes.png) 2013 ![Applies to SharePoint Server 2016](https://docs.microsoft.com/sharepoint/sharepointserver/media/yes.png) 2016 ![Applies to SharePoint Server 2019](https://docs.microsoft.com/sharepoint/sharepointserver/media/yes.png) 2019 ![Does not apply to SharePoint Online](https://docs.microsoft.com/sharepoint/sharepointserver/media/no.png) SharePoint Online in Microsoft 365 +**APPLIES TO:** ![Applies to SharePoint Server 2013](/sharepoint/sharepointserver/media/yes.png) 2013 ![Applies to SharePoint Server 2016](/sharepoint/sharepointserver/media/yes.png) 2016 ![Applies to SharePoint Server 2019](/sharepoint/sharepointserver/media/yes.png) 2019 ![Does not apply to SharePoint Online](/sharepoint/sharepointserver/media/no.png) SharePoint Online in Microsoft 365 Improve search relevance by customizing ranking models to calculate rank scores (relevance rank) accurately using rank features in SharePoint. @@ -79,7 +78,7 @@ $twoLinearStagesRankingModel.RankingModelXML > filename.xml ### To deploy a custom ranking model 1. From the list of available ranking models, copy the GUID of the ranking model that you want to use as a template. (See [To list all available ranking models](#to-list-all-available-ranking-models) for the sequence of Windows PowerShell cmdlets to use.) -1. Run the following sequence of Windows PowerShell cmdlets using the GUID copied in step 1 for __. +1. Run the following sequence of Windows PowerShell cmdlets using the GUID copied in step 1 for _\_. ```powershell $ssa = Get-SPEnterpriseSearchServiceApplication @@ -133,7 +132,7 @@ To retrieve the rank detail, you need to be the administrator of the Search serv ### To retrieve the rank detail 1. Open the SharePoint Management Shell as an Administrator. -1. Run the following sequence of Windows PowerShell cmdlets, and substitute __ and __ with actual values. +1. Run the following sequence of Windows PowerShell cmdlets, and substitute _\_ and _\_ with actual values. ```powershell $app = Get-SPEnterpriseSearchServiceApplication @@ -151,7 +150,7 @@ $resultTables[([Microsoft.Office.Server.Search.Query.ResultType]::RelevantResult SharePoint provides the **ExplainRank** page that is located in the layouts folder ( `/_layouts/15/`). This page contains detailed information on the rank score for each rank feature based on a given search query, a document ID, and an optional ranking model ID. The information is obtained and parsed from the rank detail. -You can access the **ExplainRank** page with the following URL: **http:///_layouts/15/ExplainRank.aspx?q={x}&d={y}&rm={z}** +You can access the **ExplainRank** page with the following URL: **http://\/_layouts/15/ExplainRank.aspx?q={x}&d={y}&rm={z}** Where: @@ -264,7 +263,7 @@ Weight groups are also known as context. See [Influencing the ranking of search ### Static -The static rank feature ranks items based on numeric managed properties that are stored in the search index. The numeric managed properties used for relevance rank calculation in static rank features must be of type [Integer](https://docs.microsoft.com/dotnet/api/system.int32) and set to [Refinable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Refinable.aspx) or [Sortable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Sortable.aspx) in the search schema. You can't use multivalued managed properties in combination with the static rank feature. +The static rank feature ranks items based on numeric managed properties that are stored in the search index. The numeric managed properties used for relevance rank calculation in static rank features must be of type [Integer](/dotnet/api/system.int32) and set to [Refinable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Refinable.aspx) or [Sortable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Sortable.aspx) in the search schema. You can't use multivalued managed properties in combination with the static rank feature. Before the static rank feature can be aggregated with other rank features, each static rank feature is preprocessed via a single transformation. Table 1 lists all supported transform functions. @@ -296,7 +295,7 @@ Before the static rank feature can be aggregated with other rank features, each The bucketed static rank feature ranks documents based on their file type and language. The definition of a bucketed static rank feature within a ranking model depends on whether the rank feature is part of a linear model or a neural network. The following examples apply only to linear models. For neural networks, the number of `` attributes for each bucket must match the number of hidden nodes in the neural network. -The managed properties used for relevance rank calculation in bucketed static rank features must be of type [Integer](https://docs.microsoft.com/dotnet/csharp/language-reference/keywords/int) and set to [Refinable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Refinable.aspx) or [Sortable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Sortable.aspx) in the search schema. You can't use multivalued managed properties in combination with the bucketed static rank feature. +The managed properties used for relevance rank calculation in bucketed static rank features must be of type [Integer](/dotnet/csharp/language-reference/keywords/int) and set to [Refinable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Refinable.aspx) or [Sortable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Sortable.aspx) in the search schema. You can't use multivalued managed properties in combination with the bucketed static rank feature. #### Example bucketed static rank feature definition for file type @@ -543,7 +542,7 @@ Query properties is a ranking mechanism that populates additional information us ## Example 1: Basic ranking model with one linear stage containing a single static rank feature -This ranking model assumes that the customer has created a managed property named **CustomRating**. The static rank feature requires **CustomRating** to be of [Integer](https://docs.microsoft.com/dotnet/csharp/language-reference/keywords/int) data type and to be configured as [Sortable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Sortable.aspx) or [Refinable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Refinable.aspx) in the search schema. For each document in the result set, the rank score produced by this ranking model is equal to the value of **CustomRating** for that document. The effect of this model is similar to sorting all search results, descending, with the **CustomRating** managed property. +This ranking model assumes that the customer has created a managed property named **CustomRating**. The static rank feature requires **CustomRating** to be of [Integer](/dotnet/csharp/language-reference/keywords/int) data type and to be configured as [Sortable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Sortable.aspx) or [Refinable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Refinable.aspx) in the search schema. For each document in the result set, the rank score produced by this ranking model is equal to the value of **CustomRating** for that document. The effect of this model is similar to sorting all search results, descending, with the **CustomRating** managed property. ```xml @@ -655,4 +654,4 @@ This ranking model with one linear stage contains these four rank features: - [Keyword Query Language (KQL) syntax reference](keyword-query-language-kql-syntax-reference.md) - [FAST Query Language (FQL) syntax reference](fast-query-language-fql-syntax-reference.md) - [Overview of search result ranking in SharePoint](https://technet.microsoft.com/library/7c8ddec1-c8ff-4a90-afae-387b27a653f1.aspx) -- [Create a custom ranking model by using the Ranking Model Tuning App](https://docs.microsoft.com/sharepoint/search/create-custom-ranking-model) +- [Create a custom ranking model by using the Ranking Model Tuning App](/sharepoint/search/create-custom-ranking-model) diff --git a/docs/general-development/customizing-search-results-in-sharepoint.md b/docs/general-development/customizing-search-results-in-sharepoint.md index 200602632..9fcec7243 100644 --- a/docs/general-development/customizing-search-results-in-sharepoint.md +++ b/docs/general-development/customizing-search-results-in-sharepoint.md @@ -1,150 +1,91 @@ --- title: Customizing search results in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Learn how to group similar items or remove duplicate items in a search result set in SharePoint so you can display these results in a concise, readable way. +ms.date: 06/09/2022 ms.assetid: 1b30f6df-643a-4570-ae5c-d3d8df5609b8 -localization_priority: Priority +ms.localizationpriority: high --- - - # Customizing search results in SharePoint + Learn how to group similar items or remove duplicate items in a search result set in SharePoint so you can display these results in a concise, readable way. + In search results, grouping collapses two or more similar items in a search result set to make their display more readable for a user. Duplicate removal of search results is a part of grouping, where items that are identical or nearly identical are removed from the result set. Depending on the settings set by the SharePoint administrator, the user might be able to expand the search result set later and see the individual results that were collapsed. - - - The following are examples of ways to group search results: + - Duplicate detection, where nearly identical documents are removed from the result set. - - - Site collapsing, where only the most relevant item found in each site is shown in the result set. - - - Document set collapsing, where only one hit is displayed for each document library in SharePoint. - - + You can specify the criteria for collapsing or duplicate trimming programmatically by using the following [KeywordQuery](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.KeywordQuery.aspx) properties within the Query object model: -- [CollapseSpecification](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.KeywordQuery.CollapseSpecification.aspx) - - -- [TrimDuplicates](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.Query.TrimDuplicates.aspx) - - -- [TrimDuplicatesOnProperty](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.KeywordQuery.TrimDuplicatesOnProperty.aspx) - - -- [TrimDuplicatesKeepCount](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.KeywordQuery.TrimDuplicatesKeepCount.aspx) - - -- [TrimDuplicatesIncludeId](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.KeywordQuery.TrimDuplicatesIncludeId.aspx) - - + +- [CollapseSpecification](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.KeywordQuery.CollapseSpecification.aspx) +- [TrimDuplicates](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.Query.TrimDuplicates.aspx) +- [TrimDuplicatesOnProperty](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.KeywordQuery.TrimDuplicatesOnProperty.aspx) +- [TrimDuplicatesKeepCount](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.KeywordQuery.TrimDuplicatesKeepCount.aspx) +- [TrimDuplicatesIncludeId](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.KeywordQuery.TrimDuplicatesIncludeId.aspx) ## Collapse similar search results using the CollapseSpecification property - The **CollapseSpecification** property takes a _Spec_ parameter that can contain multiple fields separated either by a comma or a space, which evaluated together specify a set of criteria used for collapsing. - - - - **Syntax** - - - - `CollapseSpecification = Spec` - - - + +**Syntax** +`CollapseSpecification = Spec` + The following table lists the fields of the _Spec_ parameter. - - - **Table 1. Spec parameter fields** - -|**Element in parameter**|**Description**| +|Element in parameter|Description| |:-----|:-----| -| _Spec_
| `Subspec(Subspec)*`
| -| _Subspec_
| `Prop(','Prop)*[':'Dups]`
| -| _Prop_
|A valid managed property or an alias of a managed property. _Prop_ is case-insensitive. The managed property must be queryable and either sortable or refineable.
| -| _Dups_
|An integer specifying the number of items to retain. The default value is 1.
| -| __
|Properties are combined by using the **OR** operator.
| -| _,_
|Properties are combined by using the **AND** operator.
| -| _*_
|Indicates more items.
| -| _() or []_
|Indicates optional items.
| - +| _Spec_| `Subspec(Subspec)*`| +| _Subspec_| `Prop(','Prop)*[':'Dups]`| +| _Prop_|A valid managed property or an alias of a managed property. _Prop_ is case-insensitive. The managed property must be queryable and either sortable or refineable.| +| _Dups_|An integer specifying the number of items to retain. The default value is 1. | +| _\_|Properties are combined by using the **OR** operator.| +| _,_|Properties are combined by using the **AND** operator.| +| _*_|Indicates more items. | +| _() or []_|Indicates optional items. | + If the fields in _Spec_ are separated by commas, the fields are combined by using the **AND** operator. If all of the specified fields are matched, the items are collapsed. - - - + In contrast, if the fields in _Spec_ are separated by spaces, the fields (or _Subspecs_) are combined by using an expansion that includes both the **AND** operator and **OR** operator. For example, an expression such as `Category:3 Product:2` is internally transformed to the following expression `(Category AND Product) OR (Category)` with a counter for each; hence a maximum of two of the former and three of the latter. Items are collapsed if some of the specified fields are matched. - - - ### Examples of using CollapseSpecification The following table shows a product catalog from the Contoso company. The next set of examples use this catalog to show how the **CollapseSpecification** property works. - - - - -|**Category**|**Product**|**Variant**|**Title**| +|Category|Product|Variant|Title| |:-----|:-----|:-----|:-----| -|Laptops
|WWI
|19W X0196 Black
|Computer 1
| -|Laptops
|Adventure Works
|12 M1201 Red
|Computer 2
| -|Laptops
|Adventure Works
|15.4W M1548 White
|Computer 3
| -|Laptops
|Proseware
|19 X910 Black
|Computer 4
| -|Laptops
|Proseware
|Laptop19 X910 Black
|Computer 5
| -|Desktops
|Adventure Works
|2.33 XD233 Silver
|Computer 6
| -|Desktops
|WWI
|2.33 X2330 Black
|Computer 7
| -|Desktops
|Adventure Works
|1.60 ED160 White
|Computer 8
| -|Desktops
|WWI
|3.0 M0300 Silver
|Computer 9
| - - - - - +|Laptops |WWI |19W X0196 Black |Computer 1 | +|Laptops |Adventure Works |12 M1201 Red |Computer 2 | +|Laptops |Adventure Works |15.4W M1548 White |Computer 3 | +|Laptops |Proseware |19 X910 Black |Computer 4 | +|Laptops |Proseware |Laptop19 X910 Black |Computer 5 | +|Desktops |Adventure Works |2.33 XD233 Silver |Computer 6 | +|Desktops |WWI |2.33 X2330 Black |Computer 7 | +|Desktops |Adventure Works |1.60 ED160 White |Computer 8 | +|Desktops |WWI |3.0 M0300 Silver |Computer 9 | #### Example: group by Category First, group the items based on **Category** and show the top two (hence `"Category:2"`) for each group. Then, for each **Category**, show a corresponding number of unique (hence "Product:1") **Products**. - - - - **Syntax** - - - - `CollapseSpecification="Category:2 Product:1"` - - - -This should return the following results. - - - +**Syntax** +`CollapseSpecification="Category:2 Product:1"` -|**Category**|**Product**|**Variant**|**Title**| -|:-----|:-----|:-----|:-----| -|Laptops
|WWI
|19W X0196 Black
|Computer 1
| -|Laptops
|Adventure
|12 M1201 Red
|Computer 2
| -|Desktops
|Adventure Works
|2.33 XD233 Silver
|Computer 6
| -|Desktops
|WWI
|2.33 X2330 Black
|Computer 7
| - -Use the following code to collapse the search results by using the **CollapseSpecification** property. - - - - +This should return the following results. +|Category|Product|Variant|Title| +|:-----|:-----|:-----|:-----| +|Laptops |WWI |19W X0196 Black |Computer 1 | +|Laptops |Adventure |12 M1201 Red |Computer 2 | +|Desktops |Adventure Works |2.33 XD233 Silver |Computer 6 | +|Desktops |WWI |2.33 X2330 Black |Computer 7 | -```cs +Use the following code to collapse the search results by using the **CollapseSpecification** property. +```csharp using (var context = new ClientContext("http://localhost")) { var query = new KeywordQuery(context) @@ -163,131 +104,64 @@ using (var context = new ClientContext("http://localhost")) Console.WriteLine(result["Title"]); } } - ``` - #### Example: group by Category and Product First, group the items based on both **Category** and **Product**. Then, show each unique combination. - - - - **Syntax** - - - - `CollapseSpecification="Category,Product:1"` - - - -This should return the following results. - - - +**Syntax** +`CollapseSpecification="Category,Product:1"` + +This should return the following results. -|**Category**|**Product**|**Variant**|**Title**| +|Category|Product|Variant|Title| |:-----|:-----|:-----|:-----| -|Laptops
|WWI
|19W X0196 Black
|Computer 1
| -|Laptops
|Adventure Works
|12 M1201 Red
|Computer 2
| -|Laptops
|Proseware
|19 X910 Black
|Computer 4
| -|Desktops
|Adventure Works
|2.33 XD233 Silver
|Computer 6
| -|Desktops
|WWI
|2.33 X2330 Black
|Computer 7
| - +|Laptops |WWI |19W X0196 Black |Computer 1 | +|Laptops |Adventure Works |12 M1201 Red |Computer 2 | +|Laptops |Proseware |19 X910 Black |Computer 4 | +|Desktops |Adventure Works |2.33 XD233 Silver |Computer 6 | +|Desktops |WWI |2.33 X2330 Black |Computer 7 | ## Trim duplicate search results using the TrimDuplicates property - Use **TrimDuplicates** to specify whether to trim away the duplicate search results from the result set. **TrimDuplicates** is **true** by default. - - - + If you use **TrimDuplicates** with either **TrimDuplicatesOnProperty** or preferably **CollapseSpecification**, **TrimDuplicates** is set to **false**. - - - - **Syntax** - - - - `TrimDuplicates = <$true | $false>` - - - + +**Syntax** +`TrimDuplicates = <$true | $false>` ### Trim duplicate search results using the TrimDuplicatesOnProperty property - Use **TrimDuplicatesOnProperty** to specify whether to use a non-default managed property as the basis for duplicate trimming. The default value is the **DocumentSignature** managed property. The managed property must be of type **Integer** or **String**. By using a managed property that represents a grouping of items, you can use this feature for field collapsing. - - - - **Syntax** - - - - `TrimDuplicatesOnProperty = ` - + +**Syntax** +`TrimDuplicatesOnProperty = ` + > [!NOTE] > In SharePoint, use **CollapseSpecification** wherever possible. **TrimDuplicatesOnProperty** is available for backward compatibility only. - - - - ### Trim duplicate search results using the TrimDuplicatesKeepCount property - Use **TrimDuplicatesKeepCount** to specify the number of documents to retain when **TrimDuplicates** is **true**. If **TrimDuplicates** is based on a managed property that can be used as a group identifier, for example a site ID, you can control how many results are returned for each group. The items returned are those with the highest dynamic rank within each group. - - - - **Syntax** - - - - `TrimDuplicatesKeepCount = ` - - - + +**Syntax** +`TrimDuplicatesKeepCount = ` ### Retrieve duplicate search results using the TrimDuplicatesIncludeId property - Use **TrimDuplicatesIncludeId** to retrieve the duplicates of a document when **TrimDuplicates** is **true** and **TrimDuplicatesOnProperty** or **CollapseSpecification** is set to **false**. - - - + The document ID, _docid_, is used to retrieve the duplicates of a particular document. - - - - **Syntax** - - - - `TrimDuplicatesIncludeId = ` - + +**Syntax** +`TrimDuplicatesIncludeId = ` + > [!NOTE] > The _fcoid_ managed property in FAST Search Server 2010 for SharePoint has been replaced with the _docid_ managed property in SharePoint. - - - - ## See also - - - -- [KeywordQuery](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.KeywordQuery.aspx) - - -- [Overview of the search schema in SharePoint](https://technet.microsoft.com/library/jj219669%28office.15%29.aspx) - - - - - - +- [KeywordQuery](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Query.KeywordQuery.aspx) +- [Overview of the search schema in SharePoint](https://technet.microsoft.com/library/jj219669%28office.15%29.aspx) diff --git a/docs/general-development/debugging-sharepoint-server-workflows.md b/docs/general-development/debugging-sharepoint-server-workflows.md index 88396467f..9ae9d211d 100644 --- a/docs/general-development/debugging-sharepoint-server-workflows.md +++ b/docs/general-development/debugging-sharepoint-server-workflows.md @@ -1,10 +1,9 @@ --- title: Debugging SharePoint workflows description: Demonstrates how SharePoint now relies on Workflow Manager 1.0 for all workflow processing and management, and demonstrates debugging options. -ms.date: 12/14/2020 -ms.prod: sharepoint +ms.date: 10/15/2022 ms.assetid: a5adf39b-8640-4871-be60-b786dcf9fafc -localization_priority: Priority +ms.localizationpriority: high --- # Debugging SharePoint workflows @@ -126,7 +125,7 @@ The first step is to first define the default proxy configuration for .NET Frame - `%systemdrive%\\Windows\\Microsoft.NET\\Framework\\v4.0.30319\\Config\\machine.config` - `%systemdrive%\\Windows\\Microsoft.NET\\Framework64\\v4.0.30319\\Config\\machine.config` -Next, add the following markup to the bottom of each file, just before the closing **** element: +Next, add the following markup to the bottom of each file, just before the closing **\** element: ```xml diff --git a/docs/general-development/deciding-between-sharepoint-add-ins-and-sharepoint-solutions.md b/docs/general-development/deciding-between-sharepoint-add-ins-and-sharepoint-solutions.md index d51e00d0b..3ae112357 100644 --- a/docs/general-development/deciding-between-sharepoint-add-ins-and-sharepoint-solutions.md +++ b/docs/general-development/deciding-between-sharepoint-add-ins-and-sharepoint-solutions.md @@ -1,9 +1,9 @@ --- title: Deciding between SharePoint Add-ins and SharePoint solutions -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides a link to the SharePoint Add-ins compared with SharePoint solutions topic for a modern solution. +ms.date: 06/09/2022 ms.assetid: 8459e265-b8fd-4bf8-911e-d63cae8bf96f -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/develop-access-web-apps.md b/docs/general-development/develop-access-web-apps.md index 7808170f4..bf36fae11 100644 --- a/docs/general-development/develop-access-web-apps.md +++ b/docs/general-development/develop-access-web-apps.md @@ -1,9 +1,9 @@ --- title: Develop Access web apps -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to develop web-based applications using Microsoft Access 2013 and provides information on Access 2013's new features. +ms.date: 06/09/2022 ms.assetid: 41131b27-d750-4d11-b3c7-c17ad4d666e2 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/develop-sharepoint-workflows-using-visual-studio.md b/docs/general-development/develop-sharepoint-workflows-using-visual-studio.md index bf916d4ff..18e73ac33 100644 --- a/docs/general-development/develop-sharepoint-workflows-using-visual-studio.md +++ b/docs/general-development/develop-sharepoint-workflows-using-visual-studio.md @@ -1,10 +1,9 @@ --- title: Develop SharePoint workflows using Visual Studio description: "SharePoint supports two primary workflow development environments for authoring workflows: SharePoint Designer and Visual Studio. This article summarizes both and discusses the advantages and disadvantages of each." -ms.date: 02/05/2021 -ms.prod: sharepoint +ms.date: 06/09/2022 ms.assetid: 28f5d3b1-6fe8-4b1f-8c4e-b11105fe6f46 -localization_priority: Priority +ms.localizationpriority: high --- # Develop SharePoint workflows using Visual Studio @@ -95,14 +94,14 @@ To debug on-premises workflows in Visual Studio, you need to temporarily allow t To debug SharePoint Online workflows in Visual Studio, perform the following steps: -1. If you're behind a firewall, you may need to install a proxy client (such as the [Forefront Threat Management Gateway (TMG) Client](https://www.microsoft.com/download/details.aspx?displaylang=en&id=10504)), depending on your company's network topology. +1. If you're behind a firewall, you may need to install a proxy client (such as the [Forefront Threat Management Gateway (TMG) Client](/previous-versions/tn-archive/cc441520(v=technet.10))), depending on your company's network topology. 1. Register for a Microsoft Azure account if you haven't already, and then sign into that account. For information about how to register for a Microsoft Azure account, see [Microsoft Azure](https://azure.microsoft.com/). 1. Create a Microsoft Azure Service Bus namespace, which you can use to debug remote workflows. You can do this on the [Microsoft Azure portal](https://ms.portal.azure.com). - For more information about the Microsoft Azure Service Bus, see [Create a Service Bus namespace using the Azure portal](https://docs.microsoft.com/azure/service-bus-messaging/service-bus-create-namespace-portal). + For more information about the Microsoft Azure Service Bus, see [Create a Service Bus namespace using the Azure portal](/azure/service-bus-messaging/service-bus-create-namespace-portal). > [!NOTE] > SharePoint Online workflow debugging uses the Relay Service component of the Microsoft Azure Service Bus, so you'll be charged for using the Service Bus. See [Service Bus Pricing FAQ](https://msdn.microsoft.com/library/hh667438.aspx). You get free access to Microsoft Azure each month that you subscribe to Visual Studio Professional with MSDN, Visual Studio Premium with MSDN, or Visual Studio Ultimate with MSDN. With this access, you can use the Service Bus relay for 1,500, 3,000, or 3,000 hours, depending on your MSDN subscription. See [Get some amount of Microsoft Azure Services each month at no additional charge](https://azure.microsoft.com/services/developer-tools/visual-studio-subscriptions/). diff --git a/docs/general-development/develop-the-site-design-in-sharepoint.md b/docs/general-development/develop-the-site-design-in-sharepoint.md index 08c11f813..65fe1a84b 100644 --- a/docs/general-development/develop-the-site-design-in-sharepoint.md +++ b/docs/general-development/develop-the-site-design-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Develop the site design in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to develop the site design in SharePoint using the Design Manager feature and provides links to other resources. +ms.date: 06/09/2022 ms.assetid: 4c061484-2ba5-45ea-9860-aec9d7c8f80e -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/developing-with-duet-enterprise-2-0.md b/docs/general-development/developing-with-duet-enterprise-2-0.md index dfd236f27..1a9d4abed 100644 --- a/docs/general-development/developing-with-duet-enterprise-2-0.md +++ b/docs/general-development/developing-with-duet-enterprise-2-0.md @@ -1,172 +1,89 @@ --- title: Developing with Duet Enterprise 2.0 -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes Duet Enterprise 2.0's features and details how to set up the developer environment, how to add an external content type, and more. +ms.date: 05/09/2023 ms.assetid: c3ef38aa-559e-4832-95c7-75e222c77624 -localization_priority: Normal +ms.localizationpriority: medium --- - # Developing with Duet Enterprise 2.0 ## Overview - Duet Enterprise 2.0 is the latest version of a collaborative effort between Microsoft and SAP to give SharePoint users the ability to work with data from SAP systems.It combines components from SAP as well as SharePoint and SharePoint Online. It gives a developer the ability to create components that will allow users to bring data from SAP systems into the familiar SharePoint environment. - - - ## Features of Duet Enterprise 2.0 - When properly installed and configured, Duet Enterprise 2.0 will provide the following features: - - - - You can work with data in SAP systems within SharePoint using Business Data Web parts, External lists and custom components. - - - Use SAP data in SharePoint without code by using built-in components. - - - Use SAP reporting systems inside of an app. - - - Use special web parts installed with Duet Enterprise 2.0 to add SAP information to SharePoint pages - - - Use SAP workflow in an app. - - - Developers can use client-side JavaScript to interact with SAP external data. - - - Secure data using OAuth for authentication. - - ## Setting up the development environment - Developing SharePoint Add-ins using Duet Enterprise 2.0, for the most part, is exactly the same as creating standard SharePoint Add-ins. You can use Visual Studio to extend your apps and work within the robust framework of the Visual Studio integrated development environment. - - - ## Adding external content types - In order to access the external data housed on the SAP system, you will have to add an external content type. Since SAP data is exposed through OData endpoints, the auto-generation tools installed in Visual Studio can be used to [How to: Create an external content type from an OData source in SharePoint](how-to-create-an-external-content-type-from-an-odata-source-in-sharepoint.md) that is scoped at the app level. - - - + Follow these steps to create an external content type: - - - ### Creating an external content type from an SAP OData endpoint 1. In **Solution Explorer**, open the shortcut menu for the project, and choose **Add**, **Content types for External Data source**. - - -2. On the **Specify OData Source** page, enter the URL of the Duet Enterprise Workflow Service. - - -3. Choose a name for your OData source. - - -4. Select the entities that are needed. - - -5. Choose **Finish**. - - +1. On the **Specify OData Source** page, enter the URL of the Duet Enterprise Workflow Service. +1. Choose a name for your OData source. +1. Select the entities that are needed. +1. Choose **Finish**. + Visual Studio will create a new folder named External Content Types where you will find the newly created BDC model. - - - ## Configuring the BDC model - The most important thing to make the project work, is to add the **ODataExtensionProvider** property to the BDC model. This property defines the extension provider that provides BCS with the SAP extensions needed for creating app code. - - - -This sample shows the properties added to the BDC model: - - - - - -```XML +This sample shows the properties added to the BDC model: +```xml - - - https://:443/sap/opu/odata/sap/ - ZANDY_PO_HEADER_SRV/$metadata - 2.0 - - OBA.Server.Canary.ObaOdataServerExtensionProvider, - OBA.Server.SSOProvider, - Version=15.0.0.0, - Culture=neutral, - PublicKeyToken=71e9bce111e9429c - SAP-PASSPORT - - + + + https://:443/sap/opu/odata/sap/ + ZANDY_PO_HEADER_SRV/$metadata + 2.0 + + OBA.Server.Canary.ObaOdataServerExtensionProvider, + OBA.Server.SSOProvider, + Version=15.0.0.0, + Culture=neutral, + PublicKeyToken=71e9bce111e9429c + SAP-PASSPORT + ``` - ## Using Duet starter services to develop custom apps - -Duet Enterprise 2.0 installs several starter services to the file system on the SharePoint server. In a default installation, the files are found at C:\\Program Files\\Duet Enterprise\\2.0\\Solutions\\Starter Services. Among these are: - - - +Duet Enterprise 2.0 installs several starter services to the file system on the SharePoint server. In a default installation, the files are found at **C:\\Program Files\\Duet Enterprise\\2.0\\Solutions\\Starter Services**. Among these are: - OBACustomerWorkspace - - - OBAOrderToCash - - - OBAPortal - - - OBAProductCenter - - + Each of these solutions contains WSP files, solution and other supporting files needed to implement them. - - - + These solutions can be used to see what can be done with Duet Enterprise 2.0 and what the development patterns are, but they are not supported for use in SharePoint Add-ins. - - - ## See also - - - -- [Duet Enterprise for Microsoft SharePoint and SAP Server 2.0](https://technet.microsoft.com/library/ff972436.aspx) - - -- [How to: Create an external content type from an OData source in SharePoint](how-to-create-an-external-content-type-from-an-odata-source-in-sharepoint.md) - - -- [Visual Studio Developer Center](https://msdn.microsoft.com/vstudio/default) - - -- [Office Development with Visual Studio](https://msdn.microsoft.com/office/hh133430) - - +- [Duet Enterprise for Microsoft SharePoint and SAP Server 2.0](https://technet.microsoft.com/library/ff972436.aspx) +- [How to: Create an external content type from an OData source in SharePoint](how-to-create-an-external-content-type-from-an-odata-source-in-sharepoint.md) +- [Visual Studio Developer Center](https://msdn.microsoft.com/vstudio/default) +- [Office Development with Visual Studio](https://msdn.microsoft.com/office/hh133430) diff --git a/docs/general-development/discovery-in-excel-services-rest-api.md b/docs/general-development/discovery-in-excel-services-rest-api.md index dfb344a93..8e8ef0626 100644 --- a/docs/general-development/discovery-in-excel-services-rest-api.md +++ b/docs/general-development/discovery-in-excel-services-rest-api.md @@ -1,153 +1,86 @@ --- title: Discovery in Excel Services REST API -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes the discovery mechanisms built into the Excel Services REST API and provides code examples. +ms.date: 05/09/2023 ms.assetid: e3a8e057-f803-446d-81c9-4eb8ef3691e1 -localization_priority: Normal +ms.localizationpriority: medium --- - # Discovery in Excel Services REST API This topic discusses the discovery mechanisms built into the Excel Services REST API. - -> [!NOTE] -> The Excel Services REST API applies to SharePoint and SharePoint 2016 on-premises. For Office 365 Education, Business, and Enterprise accounts, use the Excel REST APIs that are part of the [Microsoft Graph](http://graph.microsoft.io/docs/api-reference/v1.0/resources/excel -) endpoint. - - - +> [!NOTE] +> The Excel Services REST API applies to SharePoint and SharePoint 2016 on-premises. For Office 365 Education, Business, and Enterprise accounts, use the Excel REST APIs that are part of the [Microsoft Graph](/graph/api/overview) endpoint. ## Discovery Base URL and Discovery Example -Discovery enables developers and users to discover information about and the content of a workbook manually or programmatically. The discovery mechanism supplies the [Atom](http://tools.ietf.org/html/rfc4287) feed that contains information about the resources in a workbook. By using discovery, you can explore and view the resources in the workbook. Resources that you can explore and access are ranges, charts, tables, and PivotTables. - - - -Following is the construct of the REST URL to a specific element in a workbook: - - - - - +Discovery enables developers and users to discover information about and the content of a workbook manually or programmatically. The discovery mechanism supplies the [Atom](http://tools.ietf.org/html/rfc4287) feed that contains information about the resources in a workbook. By using discovery, you can explore and view the resources in the workbook. Resources that you can explore and access are ranges, charts, tables, and PivotTables. -``` +Following is the construct of the REST URL to a specific element in a workbook: +```http http:///_vti_bin/ExcelRest.aspx/// ``` -As described in the [Basic URI Structure and Path](basic-uri-structure-and-path.md) topic, following is the REST URL to access a workbook named **sampleWorkbook.xlsx** and further view the chart called **SampleChart**: - - - +As described in the [Basic URI Structure and Path](basic-uri-structure-and-path.md) topic, following is the REST URL to access a workbook named **sampleWorkbook.xlsx** and further view the chart called **SampleChart**: - - -``` +```http http:///_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart') ``` To start and explore the resources in the workbook and view the resources by using discovery, go to the model page by using a URI that follows this example: - - - - - -``` +```http http:///_vti_bin/ExcelRest.aspx///model ``` -Using the "sampleWorkbook.xlsx" example, following is the URI: - - - - +Using the **sampleWorkbook.xlsx** example, following is the URI: - -``` +```http http:///_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model ``` Following is a screen shot of the model page. - - - **Excel Services REST model URL** - - - - - - - ![Excel Services REST model URL](../images/SharePointServer14Con_XLSvcs_RESTModel.gif) - - - + The URL to the model page is where you start the discovery. The model page displays four resource collections that the Excel Services REST API currently supports. The resource collections are ranges, charts, tables, or PivotTables. You can explore those resources in a particular workbook by clicking **Ranges**, **Charts**, **Tables**, or **PivotTables** on the model page. - - - -For example, to access the chart in the workbook by using discovery, do the following: - - - - - - - -1. On the model page, click **Charts**. Clicking the **Charts** link brings another Atom feed—this resulting feed lists all the charts that are available in the sampleWorkbook.xlsx workbook. The sampleWorkbook.xlsx workbook contains three charts named **Chart 1**, **Chart 3**, and **SampleChart**. Therefore, three chart names are listed, as seen in the following screen shot. - - **Excel Services REST discovery chart list** +For example, to access the chart in the workbook by using discovery, do the following: - +1. On the model page, click **Charts**. Clicking the **Charts** link brings another Atom feed—this resulting feed lists all the charts that are available in the sampleWorkbook.xlsx workbook. The sampleWorkbook.xlsx workbook contains three charts named **Chart 1**, **Chart 3**, and **SampleChart**. Therefore, three chart names are listed, as seen in the following screen shot. - ![Excel Services REST discovery chart list](../images/19126dce-b896-4623-8686-92f2fa807283.gif) - + **Excel Services REST discovery chart list** - + ![Excel Services REST discovery chart list](../images/19126dce-b896-4623-8686-92f2fa807283.gif) - -2. On the model page, click **SampleChart**. This displays the chart named **SampleChart** that resides in **sampleWorkbook.xlsx**, as shown in the following screen shot. - - **Viewing chart using REST** +1. On the model page, click **SampleChart**. This displays the chart named **SampleChart** that resides in **sampleWorkbook.xlsx**, as shown in the following screen shot. - + **Viewing chart using REST** - ![Viewing chart using REST](../images/11734dcf-1b57-40cc-b1e8-8b10b7e5d5cb.gif) - + ![Viewing chart using REST](../images/11734dcf-1b57-40cc-b1e8-8b10b7e5d5cb.gif) - - - -3. Similarly, clicking **Chart 1** or **Chart 3** displays the chart with the corresponding name. Clicking **SampleChart** navigates to the actual chart URL. Following is the URL to the **SampleChart** image (as can be seen in the screen shot): - -``` - http:///_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart%20')?$format=image -``` +1. Similarly, clicking **Chart 1** or **Chart 3** displays the chart with the corresponding name. Clicking **SampleChart** navigates to the actual chart URL. Following is the URL to the **SampleChart** image (as can be seen in the screen shot): + ```http + http:///_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart%20')?$format=image + ``` ## Atom Feed -Using the [Atom](http://tools.ietf.org/html/rfc4287) feed provided by the REST API gives you an easier way of getting to the data that you are interested in. If you view the source of the webpage, you get the XML. An example from the charts in **sampleWorkbook.xlsx** is shown below. - - - -As can be seen in the XML, the feed contains traversable elements that enable code to discover what elements exist in the workbook. Each Atom entry corresponds to a chart that can be accessed. This same mechanism applies to discovering ranges, tables, and PivotTables. - - - - +Using the [Atom](http://tools.ietf.org/html/rfc4287) feed provided by the REST API gives you an easier way of getting to the data that you are interested in. If you view the source of the webpage, you get the XML. An example from the charts in **sampleWorkbook.xlsx** is shown below. +As can be seen in the XML, the feed contains traversable elements that enable code to discover what elements exist in the workbook. Each Atom entry corresponds to a chart that can be accessed. This same mechanism applies to discovering ranges, tables, and PivotTables. -```XML +```xml - + Charts http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts 2010-01-19T19:32:53Z @@ -191,14 +124,8 @@ As can be seen in the XML, the feed contains traversable elements that enable co ``` - ## See also - #### Concepts - - - - - [Resources URI for Excel Services REST API](resources-uri-for-excel-services-rest-api.md) +- [Resources URI for Excel Services REST API](resources-uri-for-excel-services-rest-api.md) diff --git a/docs/general-development/ediscovery-in-sharepoint.md b/docs/general-development/ediscovery-in-sharepoint.md index 85c23e308..357513132 100644 --- a/docs/general-development/ediscovery-in-sharepoint.md +++ b/docs/general-development/ediscovery-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: eDiscovery in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes eDiscovery features in SharePoint and provides details on prerequisites, site holds, the eDiscovery programming model, and eDiscovery types. +ms.date: 06/09/2022 ms.assetid: 45cb324a-75f5-444d-a0fa-5c223df19016 -localization_priority: Priority +ms.localizationpriority: high --- @@ -93,7 +93,7 @@ SharePoint provides a Microsoft .NET server programming model that you can use t **Table 1. eDiscovery types** -|**Type**|**Description**| +|Type|Description| |:-----|:-----| | [Case](https://msdn.microsoft.com/library/Microsoft.Office.Server.Discovery.Case.aspx)
|Represents an eDiscovery case. Associated with a specified [SPWeb](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPWeb.aspx) object, a case can be closed by a specified date or as a specific action. Cases can contain source groups, locations, mailboxes, custodians, saved searches, exports, export configurations for specified IDs, queries, and lists of all of the source groups, custodians, and locations in this **Case** object.
| | [Custodian](https://msdn.microsoft.com/library/Microsoft.Office.Server.Discovery.Custodian.aspx)
|Represents the person who is responsible for keeping records for an eDiscovery case.
| diff --git a/docs/general-development/enhancing-the-bdc-model-file-for-search-in-sharepoint.md b/docs/general-development/enhancing-the-bdc-model-file-for-search-in-sharepoint.md index 4be73106e..d02762ca1 100644 --- a/docs/general-development/enhancing-the-bdc-model-file-for-search-in-sharepoint.md +++ b/docs/general-development/enhancing-the-bdc-model-file-for-search-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Enhancing the BDC model file for Search in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes enhancing the BDC model file for Search in Sharepoint and provides a table of search properties for BDC model files. +ms.date: 06/09/2022 ms.assetid: 3c67b1cf-5fca-4805-a1b5-c9ac1ff8aede -localization_priority: Normal +ms.localizationpriority: medium --- @@ -47,7 +47,7 @@ The following table describes the BDC model properties that are applicable to Se **Table 1. Search properties for BDC model files** -|**Name**|**Metadata Object**|**Description**| +|Name|Metadata Object|Description| |:-----|:-----|:-----| |ShowInSearchUI
|Model
|Specifies that an **LobSystemInstance** element in the model file should be displayed in the search user interface. This value is ignored for custom connectors.
| |InputUriProcessor
|LobSystem
|Specifies the name of the class that processes the input URL before passing it to the connector. Applies to .NET and custom BCS indexing connectors. For more information, see [Creating a Custom Indexing Connector](https://msdn.microsoft.com/library/ec2df34d-178c-4ae1-a2b0-a6af04ee57bd%28Office.15%29.aspx).
| diff --git a/docs/general-development/excel-services-alerts.md b/docs/general-development/excel-services-alerts.md index 4084c756c..0fe8939f2 100644 --- a/docs/general-development/excel-services-alerts.md +++ b/docs/general-development/excel-services-alerts.md @@ -1,12 +1,12 @@ --- title: Excel Services Alerts -ms.date: 09/25/2017 +description: Describes Excel service alerts and provides details on "stop" alerts, "continue" alerts, exceptions, and error codes. +ms.date: 06/09/2022 keywords: errors f1_keywords: - errors -ms.prod: sharepoint ms.assetid: a4e7030b-05c2-484e-b21f-46cba937b803 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/excel-services-architecture.md b/docs/general-development/excel-services-architecture.md index 0f5ec3552..9604e1dee 100644 --- a/docs/general-development/excel-services-architecture.md +++ b/docs/general-development/excel-services-architecture.md @@ -1,12 +1,12 @@ --- title: Excel Services Architecture -ms.date: 09/25/2017 +description: Describes the Excel Services architecture and provides details on web front-end and back-end application servers, Excel web access, and more. +ms.date: 06/09/2022 keywords: excel services design f1_keywords: - excel services design -ms.prod: sharepoint ms.assetid: e0349b4a-2d52-46c4-a167-801e9c24eaca -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/excel-services-best-practices.md b/docs/general-development/excel-services-best-practices.md index a049a1453..436f5ccbc 100644 --- a/docs/general-development/excel-services-best-practices.md +++ b/docs/general-development/excel-services-best-practices.md @@ -1,237 +1,124 @@ --- title: Excel Services Best Practices -ms.date: 09/25/2017 +description: Describes the best practices for working with Excel Services and provides general advice and details on mitigating threats. +ms.date: 05/09/2023 keywords: guidelines f1_keywords: - guidelines -ms.prod: sharepoint ms.assetid: 56fa3913-c156-49da-bed0-a6a106fc129f -localization_priority: Normal +ms.localizationpriority: medium --- - # Excel Services Best Practices This topic contains a list of best-practice recommendations for working with Excel Services. - - - - ## Mitigating Threats - ### Anonymous Access and Information Disclosure The following settings combination gives anonymous users access to any files in the share to which the process account has access. Therefore, the following combination of settings is not recommended, because of the possibility of information disclosure: - - - - Anonymous access to Microsoft SharePoint Foundation is turned on. - - - You have a UNC trusted location and the **Process account** is turned on. - + > [!NOTE] > The **Process account** is a global Excel Services setting that affects all trusted locations. - - - - ### To view the Process account option - 1. On the **Start** menu, click **All Programs**. - - -2. Point to **Microsoft SharePoint 2010 Products**, and then click **SharePoint Central Administration**. - - -3. Under **Application Management**, click **Manage service applications**. - - -4. On the Manage Service Applications page, click **Excel Services Application**. - - -5. On the **Excel Services Application** page, click **Global Settings**. - - -6. In the **Security** section, look under **File Access Method** for the **Process account** option. - - +1. Point to **Microsoft SharePoint 2010 Products**, and then click **SharePoint Central Administration**. +1. Under **Application Management**, click **Manage service applications**. +1. On the Manage Service Applications page, click **Excel Services Application**. +1. On the **Excel Services Application** page, click **Global Settings**. +1. In the **Security** section, look under **File Access Method** for the **Process account** option. ### Denial of Service Attack In a denial of service attack against a Web service, an attacker generates very large, individual requests against the Web service. The purpose is to attempt to exploit the limits of one or more Web service input values. - - - + We recommend that you use the Microsoft Internet Information Services (IIS) setting to set the maximum request size for the Web service. - - - + Use the **maxRequestLength** attribute in the **httpRuntime** element in the **system.web** element to prevent denial of service attacks that are caused by users posting large files to the server. The default size is 4096 KB (4 MB). - - - + For more information, see [\ Element](https://msdn.microsoft.com/library/e9b81350-8aaf-47cc-9843-5f7d0c59f369.aspx) and [\ Element](https://msdn.microsoft.com/library/fd52b2c5-5014-4e6f-b869-4ea666dc83d6.aspx). - - - ### Sniffing Between the Calling Application and the Web Service Computer If the calling application and Excel Web Services are deployed to different computers, an attacker can listen to the network traffic for data transfer between the calling application and the Web service. This threat is also called "sniffing" or "eavesdropping." - - - + To help mitigate this threat, we recommend that you: - - - - Use Secure Sockets Layer (SSL) to set up a secure channel to protect data transfer between the client and the server. The SSL protocol helps to protect data against packet sniffing by anyone with physical access to the network. - - - Physically protect the relevant network if a custom application using Excel Web Services is running in a confined network—for example, if Excel Web Services is deployed on a Web front-end computer within the enterprise. - - -For more information, see [Securing Your Network](https://msdn.microsoft.com/library/af62ece0-0dd7-4b8e-ad12-4d13f2d60816.aspx) and [SOAP Security](https://msdn.microsoft.com/library/aa912494.aspx). - - - + +For more information, see [Securing Your Network](https://msdn.microsoft.com/library/af62ece0-0dd7-4b8e-ad12-4d13f2d60816.aspx) and [SOAP Security](https://msdn.microsoft.com/library/aa912494.aspx). + For information about Excel Services topology, scalability, performance, and security, see the Microsoft SharePoint Server 2010 TechCenter. - - - ### Spoofing We recommend that you use SSL to help mitigate the threats of hijacked Web service Internet Protocol (IP) addresses and ports, and to help prevent attackers from receiving requests and replying on behalf of the Web service. - - - + The SSL certificate is matched against a few properties, one of which is the IP address from which the message is coming. The attacker cannot spoof the IP address if it does not have the Web service SSL certificate. - - - + For more information, see [Securing Your Network](https://msdn.microsoft.com/library/af62ece0-0dd7-4b8e-ad12-4d13f2d60816.aspx). - - - ## Excel Services User-Defined Functions (UDFs) - ### Strong Name Dependencies In some cases, a user-defined function (UDF) assembly depends on other assemblies that are deployed with it. These dependent DLLs load successfully if they are in the global assembly cache, or if they are located in the same folder as the UDF assembly. - - - + In the latter case, however, it is possible for the load to fail if Excel Calculation Services has already loaded another assembly with the same name. (It fails either because the assembly is not strongly named, or because another version with the same name has been deployed and loaded.) - - - + Consider the following scenario, with the following directory structure: - - - -1. C:\\Udfs\\Udf01 - +1. ***C:\\Udfs\\Udf01*** + The Udf01 folder contains: - - - Udf01.dll - - - - dependent.dll (not strongly named) - - + + - Udf01.dll + - dependent.dll (not strongly named) The Udf01.dll file has a dependency on the dependent.dll file. - - -2. C:\\Udfs\\Udf02 - + +1. **C:\\Udfs\\Udf02** + The Udf02 folder contains: - - - Udf02.dll (which depends on Interop.dll) - - - - dependent.dll (which is not strongly named) - - + + - Udf02.dll (which depends on Interop.dll) + - dependent.dll (which is not strongly named) The Udf02.dll file has a dependency on the dependent.dll file. Udf01.dll's dependency and Udf02.dll's dependency share the same name. But Udf02.dll's dependent.dll file is not the same as Udf01.dll's dependent.dll file. - - + Assume the following flow: - - - - -1. Udf01.dll is the first DLL to be loaded. Excel Calculation Services looks for dependent.dll and loads Udf01.dll's dependency, which in this case is dependent.dll. - - -2. Udf02.dll is loaded after Udf01.dll. Excel Calculation Services sees that Udf02.dll depends on dependent.dll. However, a DLL with the name "dependent.dll" is already loaded. Therefore, Udf02.dll's dependent.dll file is not loaded, and the currently loaded dependent.dll file is used as the dependency. - - + +1. Udf01.dll is the first DLL to be loaded. Excel Calculation Services looks for dependent.dll and loads Udf01.dll's dependency, which in this case is dependent.dll. +1. Udf02.dll is loaded after Udf01.dll. Excel Calculation Services sees that Udf02.dll depends on dependent.dll. However, a DLL with the name "dependent.dll" is already loaded. Therefore, Udf02.dll's dependent.dll file is not loaded, and the currently loaded dependent.dll file is used as the dependency. + As a result, the object—in this case, the dependent.dll file that Udf02.dll needs—is not loaded into memory. - - - + To avoid name collision, we recommend that you strongly name your dependencies, and name them uniquely. - - - ## General - ### Naming Managed-Code DLLs To ensure that your assembly names are unique, use the fully qualified class name, following the [Namespace Naming Guidelines](https://msdn.microsoft.com/library/c08bc0d8-9b3a-4564-9af6-71699f62e00d.aspx). - - - -For example, use CompanyName.Hierarchichal.Namespace.ClassName instead ofNamespace.ClassName. - - - -## See also +For example, use `CompanyName.Hierarchichal.Namespace.ClassName` instead of `Namespace.ClassName`. +## See also #### Tasks - - - - - [How to: Trust a Location](how-to-trust-a-location.md) +- [How to: Trust a Location](how-to-trust-a-location.md) #### Concepts - - - - - [Excel Services Architecture](excel-services-architecture.md) - - - - [Accessing the SOAP API](accessing-the-soap-api.md) - - - - [Excel Services Alerts](excel-services-alerts.md) - - - - [Excel Services Known Issues and Tips](excel-services-known-issues-and-tips.md) - - - - [Excel Services Blogs, Forums, and Resources](excel-services-blogs-forums-and-resources.md) +- [Excel Services Architecture](excel-services-architecture.md) +- [Accessing the SOAP API](accessing-the-soap-api.md) +- [Excel Services Alerts](excel-services-alerts.md) +- [Excel Services Known Issues and Tips](excel-services-known-issues-and-tips.md) +- [Excel Services Blogs, Forums, and Resources](excel-services-blogs-forums-and-resources.md) diff --git a/docs/general-development/excel-services-blogs-forums-and-resources.md b/docs/general-development/excel-services-blogs-forums-and-resources.md index d4ae8038c..f938e4ce4 100644 --- a/docs/general-development/excel-services-blogs-forums-and-resources.md +++ b/docs/general-development/excel-services-blogs-forums-and-resources.md @@ -1,83 +1,44 @@ --- title: Excel Services Blogs, Forums, and Resources -ms.date: 09/25/2017 +description: Provides links to Excel Services blogs, forums, and resources, as well as links to articles on Excel Services concepts. +ms.date: 06/27/2022 keywords: blogger f1_keywords: - blogger -ms.prod: sharepoint ms.assetid: c0b137cd-126d-4c74-a3f7-eb9debe3c35f -localization_priority: Normal +ms.localizationpriority: medium --- - - # Excel Services Blogs, Forums, and Resources The following are links to blogs, forums, and additional resources related to Excel Services and SharePoint: - - - - - -|**Blog Name**|**Links**| -|:-----|:-----| -|Cum Grano Salis
| [Home page](https://blogs.msdn.com/cumgranosalis/)
[Excel Services page](https://blogs.msdn.microsoft.com/cumgranosalis/tag/excel-services/)
| -|Microsoft Excel: The official blog of the Microsoft Excel product team
| [Home page](https://www.microsoft.com/microsoft-365/blog/excel)
| - +| Blog Name | Links | +| :--------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------- | +| Cum Grano Salis | [Home page](https://blogs.msdn.com/cumgranosalis/) [Excel Services page](/archive/blogs/cumgranosalis/#excel-services) | +| Microsoft Excel: The official blog of the Microsoft Excel product team | [Home page](https://www.microsoft.com/microsoft-365/blog/excel) | +| Forum Name | Links | +| :----------------------------------- | :------------------------------------------------------------------------------------------------------------------ | +| SharePoint - Excel Services | [Excel Services forum home page](/sharepoint/dev/general-development/excel-services-blogs-forums-and-resources) | +| SharePoint Products and Technologies | [List of SharePoint Products and Technologies forums](https://social.msdn.microsoft.com/forums/category/sharepoint) | -|**Forum Name**|**Links**| -|:-----|:-----| -|SharePoint - Excel Services
| [Excel Services forum home page](/sharepoint/dev/general-development/excel-services-blogs-forums-and-resources)
| -|SharePoint Products and Technologies
| [List of SharePoint Products and Technologies forums](https://social.msdn.microsoft.com/forums/category/sharepoint)
| - - - -|**Additional Resources**|**Links**| -|:-----|:-----| -|Excel Services Resource Center
| [Excel Services Resource Center on MSDN](https://msdn.microsoft.com/office/bb203828.aspx)
| -|IT Pro \\ Administration Documentation
| [TechNet](https://technet.microsoft.com/library/ee424401%28office.14%29.aspx)
| -|Microsoft Excel Online, part of Office Online, also supports Excel workbooks in the browser.
|For more information about Excel Online, see the [documentation](https://technet.microsoft.com/library/ee855124.aspx) on Technet.
| - +| Additional Resources | Links | +| :------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------- | +| IT Pro \\ Administration Documentation | [TechNet](https://technet.microsoft.com/library/ee424401%28office.14%29.aspx) | +| Microsoft Excel Online, part of Office Online, also supports Excel workbooks in the browser. | For more information about Excel Online, see the [documentation](https://technet.microsoft.com/library/ee855124.aspx) on Technet. | ## See also - #### Concepts +- [Excel Services Overview](excel-services-overview.md) +- [Excel Services Development Roadmap](excel-services-development-roadmap.md) +- [Excel Services Architecture](excel-services-architecture.md) +- [Excel Services Best Practices](excel-services-best-practices.md) +- [Excel Services Alerts](excel-services-alerts.md) +- [Excel Services Known Issues and Tips](excel-services-known-issues-and-tips.md) - - - - [Excel Services Overview](excel-services-overview.md) - - - - [Excel Services Development Roadmap](excel-services-development-roadmap.md) - - - - [Excel Services Architecture](excel-services-architecture.md) - - - - [Excel Services Best Practices](excel-services-best-practices.md) - - - - [Excel Services Alerts](excel-services-alerts.md) - - - - [Excel Services Known Issues and Tips](excel-services-known-issues-and-tips.md) #### Other resources - - - - - [Walkthrough: Developing a Custom Application Using Excel Web Services](walkthrough-developing-a-custom-application-using-excel-web-services.md) - - - - [Unsupported Features in Excel Services](https://msdn.microsoft.com/library/5868e672-4786-4fed-9168-07ff538f6f5c%28Office.15%29.aspx) +- [Walkthrough: Developing a Custom Application Using Excel Web Services](walkthrough-developing-a-custom-application-using-excel-web-services.md) +- [Unsupported Features in Excel Services](https://msdn.microsoft.com/library/5868e672-4786-4fed-9168-07ff538f6f5c%28Office.15%29.aspx) diff --git a/docs/general-development/excel-services-development-roadmap.md b/docs/general-development/excel-services-development-roadmap.md index cb0e00517..dc34273fa 100644 --- a/docs/general-development/excel-services-development-roadmap.md +++ b/docs/general-development/excel-services-development-roadmap.md @@ -1,12 +1,12 @@ --- title: Excel Services Development Roadmap -ms.date: 09/25/2017 +description: Provides a roadmap for developing with Excel Services, focusing on Excel Web Service and the REST API. +ms.date: 06/09/2022 keywords: roadmap f1_keywords: - roadmap -ms.prod: sharepoint ms.assetid: 5c789f58-9cdb-4601-9047-9c6f83f2fbba -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/excel-services-ecmascript-javascript-jscript.md b/docs/general-development/excel-services-ecmascript-javascript-jscript.md index 9f6937d3c..6df58ec48 100644 --- a/docs/general-development/excel-services-ecmascript-javascript-jscript.md +++ b/docs/general-development/excel-services-ecmascript-javascript-jscript.md @@ -1,9 +1,9 @@ --- title: Excel Services ECMAScript (JavaScript, JScript) -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes ECMAScript (JavaScript and JScript) in Excel Services and provides links to ECMAScript tutorials. +ms.date: 06/09/2022 ms.assetid: 2355ffd0-8190-4385-955c-3f72bce7efc6 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/excel-services-ecmascript-overview.md b/docs/general-development/excel-services-ecmascript-overview.md index 9cd373897..7e56e839e 100644 --- a/docs/general-development/excel-services-ecmascript-overview.md +++ b/docs/general-development/excel-services-ecmascript-overview.md @@ -1,9 +1,9 @@ --- title: Excel Services ECMAScript Overview -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides an overview on ECMAScript in Excel Services and describes how to use the ECMAScript object model. +ms.date: 06/09/2022 ms.assetid: f8c1be86-df19-44c3-a3bc-c0da2b80df10 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/excel-services-error-codes.md b/docs/general-development/excel-services-error-codes.md index 1497871f8..0d11ea32f 100644 --- a/docs/general-development/excel-services-error-codes.md +++ b/docs/general-development/excel-services-error-codes.md @@ -1,26 +1,26 @@ --- title: Excel Services error codes +description: Excel Services generates errors and error messages in the SOAP exception based on errors that occur in Excel Services. The following table shows the errors that are accessible when calls to the Excel Web Services methods throw a SOAP exception. ms.date: 09/25/2017 keywords: alerts f1_keywords: - alerts -ms.prod: sharepoint ms.assetid: ff128d67-f3ac-4a8f-ae8e-1e19e343014e -localization_priority: Priority +ms.localizationpriority: high --- # Excel Services error codes -Excel Services generates errors and error messages in the SOAP exception based on errors that occur in Excel Services. The following table shows the errors that are accessible when calls to the Excel Web Services methods throw a SOAP exception. +Excel Services generates errors and error messages in the SOAP exception based on errors that occur in Excel Services. The following table shows the errors that are accessible when calls to the Excel Web Services methods throw a SOAP exception. -You use the [SubCode](https://docs.microsoft.com/dotnet/api/system.web.services.protocols.soapexception.subcode?view=netframework-4.7.2) property of the **SoapException** class to capture the error codes. For more information about using the **SubCode** property to capture error codes, see [How to: Use the SubCode Property to Capture Error Codes](how-to-use-the-subcode-property-to-capture-error-codes.md) +You use the [SubCode](/dotnet/api/system.web.services.protocols.soapexception.subcode) property of the **SoapException** class to capture the error codes. For more information about using the **SubCode** property to capture error codes, see [How to: Use the SubCode Property to Capture Error Codes](how-to-use-the-subcode-property-to-capture-error-codes.md) For more information about Excel Services alerts, see [Excel Services Alerts](excel-services-alerts.md). ## Error codes -The following table lists the error codes for Excel Web Services alerts and the associated messages, explanation, and resolutions. - +The following table lists the error codes for Excel Web Services alerts and the associated messages, explanation, and resolutions. + |**Error Code**|**Message**|**Explanation**|**Resolution**| |:-----|:-----|:-----|:-----| |ApiInvalidArgument
|Invalid value to argument: {0}
|An invalid value for an argument was passed into the API call.
0 = name of the argument. Its value is invalid.
|Use a valid value for the argument.
| @@ -50,10 +50,10 @@ The following table lists the error codes for Excel Web Services alerts and the |SheetRangeMismatch
|The sheet provided as the sheet argument is not the same as the sheet specified in the range argument.
|The name of the sheet passed in for a _sheetName_ parameter does not match the sheet location specified in the _rangeName_ parameter.
|When specifying a sheet in both the range and sheet arguments, ensure that the sheet names are the same. For example, `Calculate(Sheet1, Sheet1!Range("A1"))`.
| |SpecifiedRangeNotFound
|The requested range does not exist in the sheet.
|The range that was passed into a method with the A1 suffix (**SetCellA1**, **SetRangeA1**, **GetCellA1**, and **GetRangeA1**) could not be found.
|Make sure the range specified exists in the sheet.
| |WorkbookNotSupported
|The file you selected cannot be opened because it contains feature(s) that are not supported by Excel Services. One or more of the following unsupported features were detected in the workbook:
{0}
|The workbook contains unsupported features.
0 = a \\n separated list of unsupported feature names.
|Make sure the workbook does not contain features that are not supported by Excel Services.
| - + ## See also - + - [How to: Use the SubCode Property to Capture Error Codes](how-to-use-the-subcode-property-to-capture-error-codes.md) - [Excel Services Alerts](excel-services-alerts.md) - [Excel Services Known Issues and Tips](excel-services-known-issues-and-tips.md) diff --git a/docs/general-development/excel-services-in-sharepoint.md b/docs/general-development/excel-services-in-sharepoint.md index c75fe3de1..907f02be8 100644 --- a/docs/general-development/excel-services-in-sharepoint.md +++ b/docs/general-development/excel-services-in-sharepoint.md @@ -1,89 +1,41 @@ --- title: Excel Services in SharePoint +description: Learn about the new capabilities in Excel Services in SharePoint and how you can use them in your own development efforts. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: f7e13fcb-a86a-4a1e-af59-3bace98ce9d7 -localization_priority: Normal +ms.localizationpriority: medium --- - - # Excel Services in SharePoint + Learn about the new capabilities in Excel Services in SharePoint and how you can use them in your own development efforts. + ## What's new in Excel Services for developers - SharePoint brings new technologies to Excel Services─such as ECMAScript (JavaScript, JScript) UDFs and Excel Interactive View─and new enhancements to existing technologies, such as ODATA for REST, and updates to the ECMAScript (JavaScript, JScript) Object Model (JSOM) API. - - - ### JavaScript UDFs - -Excel Services already lets you create user-defined functions (UDFs) using managed code. Excel Services in SharePoint introduces a new kind of UDF—ECMAScript (JavaScript, JScript) UDFs. JavaScript UDFs run in the context of the browser: either in a Excel workbook that is hosted in an Excel Web Access web part on SharePoint, or in a workbook that is embedded on a host webpage. - - - +Excel Services already lets you create user-defined functions (UDFs) using managed code. Excel Services in SharePoint introduces a new kind of UDF—ECMAScript (JavaScript, JScript) UDFs. JavaScript UDFs run in the context of the browser: either in a Excel workbook that is hosted in an Excel Web Access web part on SharePoint, or in a workbook that is embedded on a host webpage. ### OData in Excel Services - SharePoint Server 2010 introduced the REST API for use in getting and setting information in Excel Workbooks stored in SharePoint document libraries. SharePoint adds a new way to request data from Excel Services that uses the Open Data Protocol (OData) which you can use to get information about Excel Services resources. This new service relies heavily on the existing Excel Services REST API. - - - - -### - > [!NOTE] -> The Excel Interactive View feature has been disabled. For information about removing this feature from your website, see [Removing Excel Interactive View from a webpage](removing-excel-interactive-view-from-a-webpage.md). - - - - +> The Excel Interactive View feature has been disabled. For information about removing this feature from your website, see [Removing Excel Interactive View from a webpage](removing-excel-interactive-view-from-a-webpage.md). ## In this section - - -- [Getting Started with Excel Services](getting-started-with-excel-services.md) - - -- [Excel Web Services](excel-web-services.md) - - -- [Excel Services User-Defined Functions](excel-services-user-defined-functions.md) - - -- [Excel Web Access](excel-web-access.md) - - -- [Excel Services ECMAScript (JavaScript, JScript)](excel-services-ecmascript-javascript-jscript.md) - - -- [Excel Services REST API](excel-services-rest-api.md) - - -- [General Guidelines](general-guidelines.md) - - -- [Removing Excel Interactive View from a webpage](removing-excel-interactive-view-from-a-webpage.md) - - +- [Getting Started with Excel Services](getting-started-with-excel-services.md) +- [Excel Web Services](excel-web-services.md) +- [Excel Services User-Defined Functions](excel-services-user-defined-functions.md) +- [Excel Web Access](excel-web-access.md) +- [Excel Services ECMAScript (JavaScript, JScript)](excel-services-ecmascript-javascript-jscript.md) +- [Excel Services REST API](excel-services-rest-api.md) +- [General Guidelines](general-guidelines.md) +- [Removing Excel Interactive View from a webpage](removing-excel-interactive-view-from-a-webpage.md) ## See also - - - -- [Add SharePoint capabilities](add-sharepoint-capabilities.md) - - -- [Office 2013 and SharePoint application services](office-and-sharepoint-application-services.md) - - - - - - +- [Add SharePoint capabilities](add-sharepoint-capabilities.md) +- [Office 2013 and SharePoint application services](office-and-sharepoint-application-services.md) diff --git a/docs/general-development/excel-services-known-issues-and-tips.md b/docs/general-development/excel-services-known-issues-and-tips.md index 82ec5ef5e..66fa55c00 100644 --- a/docs/general-development/excel-services-known-issues-and-tips.md +++ b/docs/general-development/excel-services-known-issues-and-tips.md @@ -1,328 +1,163 @@ --- title: Excel Services Known Issues and Tips -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes known issues and tips for working with Excel Services and provides links to related documentation. +ms.date: 05/09/2023 ms.assetid: b4a41437-4f00-4f88-8510-627fa0252004 -localization_priority: Normal +ms.localizationpriority: medium --- - # Excel Services Known Issues and Tips The following are a known issues and tips for working with Excel Services. - - - - ## Excel Web Service - ### Viewing the WSDL Location You can view the Excel Web Services Web Services Description Language (WSDL) page by navigating to the following URL on the server: `http:////_vti_bin/excelservice.asmx?WSDL` - - - -If you do not have a custom site, you can view the WSDL by using the following URL: - - - - `http:///_vti_bin/excelservice.asmx?WSDL` - - - -For more information, see [Accessing the SOAP API](accessing-the-soap-api.md). - - - + +If you do not have a custom site, you can view the WSDL by using the following URL: `http:///_vti_bin/excelservice.asmx?WSDL` + +For more information, see [Accessing the SOAP API](accessing-the-soap-api.md). ### Understanding Excel Web Services and Namespaces The following are Excel web services and namespaces: - - - - The single web service object that contains all the API methods: **ExcelService** - - -- The schema namespace: `http://schemas.microsoft.com/office/excel/server/webservices` - - -- The web service page name: ExcelService.asmx - - +- The schema namespace: `http://schemas.microsoft.com/office/excel/server/webservices` +- The web service page name: **ExcelService.asmx** ### Linking Locally or to a Web Service -In certain scenarios, you should link directly to Microsoft.Office.Excel.Server.WebServices.dll and access it as you would any local assembly, instead of calling it as a web service through SOAP over HTTP. - - - +In certain scenarios, you should link directly to Microsoft.Office.Excel.Server.WebServices.dll and access it as you would any local assembly, instead of calling it as a web service through SOAP over HTTP. + For more information and guidelines on when to use direct linking, see [Loop-Back SOAP Calls and Direct Linking](loop-back-soap-calls-and-direct-linking.md). - - - ### Understanding Invalid Characters The calls to the **GetCell** and **GetRange** methods will fail if the workbook cells contain characters that are invalid in an XML response. - - - + For example, if a cell contains characters with hexadecimal values 0x1, 0x2 ... 0x8, the ASP.NET parser will throw an exception that the value of the character being written to the XML response is invalid: - - - - **System.InvalidOperationException: Client found response content type of 'text/html; charset=utf-8', but expected 'text/xml'. The request failed with the error message: -- ' ', hexadecimal value 0x01, is an invalid character.** - - - + +**System.InvalidOperationException: Client found response content type of 'text/html; charset=utf-8', but expected 'text/xml'. The request failed with the error message: -- \ \ \' ', hexadecimal value 0x01, is an invalid character.** + This behavior is expected. The XML specification that defines which characters are allowed in a valid XML response specifies that hexadecimal values 0x1, 0x2 ... 0x8 are invalid XML characters: - - - - **Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF] /* any Unicode character, excluding the surrogate blocks, FFFE, and FFFF. */** - - - -For more information, see [W3C Extensible Markup Language (XML) Specification](http://www.w3.org/TR/REC-xml) (http://www.w3.org/TR/REC-xml#NT-Char). - - - + +**Char ::= #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF] /* any Unicode character, excluding the surrogate blocks, FFFE, and FFFF. */** + +For more information, see [W3C Extensible Markup Language (XML) Specification](http://www.w3.org/TR/REC-xml#NT-Char). ### Saving a Workbook When you make changes to a workbook—for example, by setting values to a range using Excel Web Services—the changes to the workbook are preserved only for that particular session. The changes are not saved or persisted back to the original workbook. When the current workbook session ends (for example, when you call the **CloseWorkbook** method, or the session times out), changes you made will be lost. - - - + If you want to save changes to a workbook, you can use the **GetWorkbook** method and then save the workbook using the API of the destination file store. For more information, see [How to: Get an Entire Workbook or a Snapshot](how-to-get-an-entire-workbook-or-a-snapshot.md) and [How to: Save a Workbook](https://msdn.microsoft.com/library/feb74f7a-2d8f-4672-911b-de85f8852aea%28Office.15%29.aspx). - - - ### Understanding the Url Property of an Excel Web Services Proxy Class -Do not use the **Url** property of an Excel Web Services proxy for the location of the workbook you want to open. The **Url** property of a web service proxy class generated by Visual Studio gets or sets the base URL of the XML web service the client is requesting. In the case of Excel Web Services, this is usually: - - - - `http:///_vti_bin/ExcelService.asmx` - - - -To specify the location of a workbook, use the **OpenWorkbook** method instead of the **Url** property as shown in the following code example. - - - - +Do not use the **Url** property of an Excel Web Services proxy for the location of the workbook you want to open. The **Url** property of a web service proxy class generated by Visual Studio gets or sets the base URL of the XML web service the client is requesting. In the case of Excel Web Services, this is usually: `http:///_vti_bin/ExcelService.asmx` +To specify the location of a workbook, use the **OpenWorkbook** method instead of the **Url** property as shown in the following code example. -``` - +```csharp //Instantiate the web service and make a status array object. ExcelService xlservice = new ExcelService(); -string sheetName = "Sheet1"; +string sheetName = "Sheet1"; //Set the path to the workbook to open. //TODO: Change the path to the workbook - //to point to a workbook you have access to. +//to point to a workbook you have access to. //The workbook must be in a trusted location. -string targetWorkbookPath = - "http://myserver02/example/Shared%20Documents/Book1.xlsx"; +string targetWorkbookPath = "http://myserver02/example/Shared%20Documents/Book1.xlsx"; //Set credentials for requests. xlservice.Credentials = System.Net.CredentialCache.DefaultCredentials; -//Call the open workbook, and point to the trusted +//Call the open workbook, and point to the trusted //location of the workbook to open. -string sessionId = xlservice.OpenWorkbook(targetWorkbookPath, "en-US", - "en-US", out outStatus); - +string sessionId = xlservice.OpenWorkbook(targetWorkbookPath, "en-US", "en-US", out outStatus); ``` -For more information, see [WebClientProtocol.Url Property](https://go.microsoft.com/fwlink/?LinkId=64908) (https://msdn.microsoft.com/library/default.asp?url=/library/cpref/html/frlrfSystemWebServicesProtocolsWebClientProtocolClassUrlTopic.asp). - - - +For more information, see [WebClientProtocol.Url Property](https://msdn.microsoft.com/library/default.asp?url=/library/cpref/html/frlrfSystemWebServicesProtocolsWebClientProtocolClassUrlTopic.asp). ## Understanding Security - ### Using Workbook Permissions Beware of the following issues regarding workbook permissions: - - - - Excel Web Services uses the Microsoft SharePoint Foundation authorization scheme to verify that the caller has the right to call APIs (that is, make web service calls) on the SharePoint Foundation site (that is, the website where Excel Web Services is located) remotely. If the caller does not have the "Use Remote API" right, the Excel Web Services returns an "HTTP 401 (Unauthorized)" error, and logs an "API authorization failed" event. Excel Web Services performs these authorization checks only for calls that originate as SOAP calls. Calls from applications that link locally to Microsoft.Office.Excel.Server.WebServices.dll are not considered remote calls. Therefore, they are not subject to authorization checks. However, if the application that links locally to Microsoft.Office.Excel.Server.WebServices.dll is itself a SOAP service, and handles the service's SOAP calls, the call to Excel Web Services will seem like a SOAP call (even though the application links directly to Microsoft.Office.Excel.Server.WebServices.dll). In this scenario, Excel Web Services will perform the authorization checks. - - - To get the entire workbook (for example, by calling the **GetWorkbook** method using the `WorkbookType.FullWorkbook` argument), the caller needs "open" permission for the workbook or "read" permission in a file share. - - - To call the **GetApiVersion** method, no permission is necessary. - - - For the rest of the Excel Web Services methods, besides credentials, the caller needs "view" permission (in SharePoint Foundation) or "read" permission (in a file share) for the workbook. - - ### Trusted Location The workbooks you want to open in Excel Services must be placed in a trusted location. If not, the Excel Web Services calls to open the workbook will fail. - - - + For information about how to trust a location, see [How to: Trust a Location](how-to-trust-a-location.md) and [How to: Trust Workbook Locations Using Script](https://msdn.microsoft.com/library/79ab6ced-7a0c-4275-b852-bb246fc6be57%28Office.15%29.aspx). - - - ## Visual Studio - ### Microsoft Visual Studio Proxy Behavior -When Microsoft Visual Studio creates a proxy class for a client project that calls Excel Web Services, it has the following behavior: - - - +When Microsoft Visual Studio creates a proxy class for a client project that calls Excel Web Services, it has the following behavior: + If a method has no return value, and one or more **out** arguments, the first **out** argument is moved to become the return value. That is, the method in the proxy class will have one less **out** argument in the method signature. But the signature will have a return value with the type and content of what used to be the first **out** argument. - - - + The affected Excel Web Services methods are: - - - - **Calculate** - - - **CalculateA1** - - - **CalculateWorkbook** - - - **CancelRequest** - - - **CloseWorkbook** - - - **GetSessionInformation** - - - **Refresh** - - - **SetCell** - - - **SetCellA1** - - - **SetRange** - - - **SetRangeA1** - - ## Excel Services User-Defined Functions - ### Global Assembly Cache is Checked First, Then the Local Folder By design in the Microsoft .NET Framework, an assembly in a global assembly cache will be loaded instead of the same assembly in a local folder. The common language runtime will look for an assembly in the global assembly cache first before searching in the local folders. - - - + Therefore, if an assembly is installed in the global assembly cache and is in the UDF list but disabled (or removed from the UDF list altogether), and an identical assembly is installed in a local folder and enabled, the assembly in the global assembly cache will still get loaded and used instead of the same assembly in the local folder. - - - + This does not affect upgrade scenarios in which the assembly version has been modified, which means the assembly is not the same anymore. - - - ## General - ### Order of Strings in Sharedstring.xml is Not Maintained -Excel Services does not maintain the original order of strings in a workbook shared-string table (the Sharedstrings.xml part within the Microsoft Office Excel XML Format file). For example, execute the following steps: - - - - -1. Open a file using Excel. - - -2. Save the file in .xlsx file format. - - -3. Upload the file to a document library that is a trusted location. - - -4. Open the file in the document library by using Excel Web Access. - - -5. Click **Open in Excel**. - - -6. Save the file in .xlsx file format. - - -If you compare the Sharedstrings.xml file created in Step 2 with the one created in Step 6, you will find the order of the Sharedstrings.xml parts might be different. - - - +Excel Services does not maintain the original order of strings in a workbook shared-string table (the **Sharedstrings.xml** part within the Microsoft Office Excel XML Format file). For example, execute the following steps: + +1. Open a file using Excel. +1. Save the file in .xlsx file format. +1. Upload the file to a document library that is a trusted location. +1. Open the file in the document library by using Excel Web Access. +1. Click **Open in Excel**. +1. Save the file in .xlsx file format. + +If you compare the **Sharedstrings.xml** file created in Step 2 with the one created in Step 6, you will find the order of the **Sharedstrings.xml** parts might be different. + You should not write an application that assumes the order of strings in the shared-string table is fixed. For example, you cannot replace the shared-string table with an existing localized translation table. You must adjust to the new ordering of strings in the shared-string table. - - - ## See also - #### Tasks +- [How to: Trust a Location](how-to-trust-a-location.md) - - - - [How to: Trust a Location](how-to-trust-a-location.md) #### Concepts - - - - - [Excel Services Best Practices](excel-services-best-practices.md) - - - - [Excel Services Alerts](excel-services-alerts.md) - - - - [Excel Services Architecture](excel-services-architecture.md) - - - - [Supported and Unsupported Features](supported-and-unsupported-features.md) - - - - [Accessing the SOAP API](accessing-the-soap-api.md) - - - - [Excel Services Blogs, Forums, and Resources](excel-services-blogs-forums-and-resources.md) +- [Accessing the SOAP API](accessing-the-soap-api.md) +- [Excel Services Alerts](excel-services-alerts.md) +- [Excel Services Architecture](excel-services-architecture.md) +- [Excel Services Best Practices](excel-services-best-practices.md) +- [Excel Services Blogs, Forums, and Resources](excel-services-blogs-forums-and-resources.md) +- [Supported and Unsupported Features](supported-and-unsupported-features.md) diff --git a/docs/general-development/excel-services-overview.md b/docs/general-development/excel-services-overview.md index 5bc2b52e2..0a6a80f2e 100644 --- a/docs/general-development/excel-services-overview.md +++ b/docs/general-development/excel-services-overview.md @@ -1,9 +1,9 @@ --- title: Excel Services Overview +description: "Excel Services is a service application that enables you to load, calculate, and display Microsoft Excel workbooks on Microsoft SharePoint." ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: 5fa22ebb-e507-4ffc-a425-e755502feae2 -localization_priority: Priority +ms.localizationpriority: high --- @@ -283,7 +283,7 @@ From there you can use OData system query options to get specific information ab - [Walkthrough: Developing a Custom Application Using Excel Web Services](walkthrough-developing-a-custom-application-using-excel-web-services.md) -- [Frequently Asked Questions About Excel Services UDFs](frequently-asked-questions-about-excel-services-udfs.md) +- [Frequently Asked Questions About Excel Services UDFs](frequently-asked-questions-about-excel-services-udfs.yml) - [Unsupported Features in Excel Services](https://msdn.microsoft.com/library/5868e672-4786-4fed-9168-07ff538f6f5c%28Office.15%29.aspx) diff --git a/docs/general-development/excel-services-rest-api-overview.md b/docs/general-development/excel-services-rest-api-overview.md index 3eda94642..7062be383 100644 --- a/docs/general-development/excel-services-rest-api-overview.md +++ b/docs/general-development/excel-services-rest-api-overview.md @@ -1,9 +1,9 @@ --- title: Excel Services REST API Overview -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides an overview of the Excel Services REST API and provides a link to an article about the Microsoft Graph REST API endpoint. +ms.date: 06/09/2022 ms.assetid: 5872f311-e180-4578-ac80-2519c1081951 -localization_priority: Priority +ms.localizationpriority: high --- @@ -12,7 +12,7 @@ localization_priority: Priority The REST API in Excel Services is new in Microsoft SharePoint Server 2010. By using the REST API, you can access workbook parts or elements directly through a URL. > [!NOTE] -> The Excel Services REST API applies to SharePoint and SharePoint 2016 on-premises. For For Office 365 Education, Business, and Enterprise accounts,, use the Excel REST APIs that are part of the [Microsoft Graph](http://graph.microsoft.io/docs/api-reference/v1.0/resources/excel) endpoint. +> The Excel Services REST API for SharePoint Online will no longer be supported for Microsoft 365 accounts from February 28th, 2022 forward. Instead, please use the REST API that’s part of the [Microsoft Graph](http://graph.microsoft.io/docs/api-reference/v1.0/resources/excel) endpoint. diff --git a/docs/general-development/excel-services-rest-api.md b/docs/general-development/excel-services-rest-api.md index a2994cd39..29229c636 100644 --- a/docs/general-development/excel-services-rest-api.md +++ b/docs/general-development/excel-services-rest-api.md @@ -1,9 +1,9 @@ --- title: Excel Services REST API -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes the Representational State Transfer (REST) API in Excel Services and provides links to articles and tutorials about the REST API. +ms.date: 06/09/2022 ms.assetid: 32033fea-873c-4781-900a-6946906066b0 -localization_priority: Priority +ms.localizationpriority: high --- @@ -12,7 +12,7 @@ localization_priority: Priority This section contains information about the Representational State Transfer (REST) API in Excel Services and explains how to use it. > [!NOTE] -> The Excel Services REST API applies to SharePoint and SharePoint 2016 on-premises. For Office 365 Education, Business, and Enterprise accounts, use the Excel REST APIs that are part of the [Microsoft Graph](http://graph.microsoft.io/docs/api-reference/v1.0/resources/excel +> The Excel Services REST API for SharePoint Online will no longer be supported for Microsoft 365 accounts from February 28th, 2022 forward. Instead, please use the REST API that’s part of the [Microsoft Graph](http://graph.microsoft.io/docs/api-reference/v1.0/resources/excel ) endpoint. diff --git a/docs/general-development/excel-services-user-defined-functions.md b/docs/general-development/excel-services-user-defined-functions.md index e35a8b74f..df735d7df 100644 --- a/docs/general-development/excel-services-user-defined-functions.md +++ b/docs/general-development/excel-services-user-defined-functions.md @@ -1,12 +1,12 @@ --- title: Excel Services User-Defined Functions +description: "This section contains information about user-defined functions (UDFs) and how to use UDF attributes in your code." ms.date: 09/25/2017 keywords: functions f1_keywords: - functions -ms.prod: sharepoint ms.assetid: 27dd8024-7e00-40de-a688-afc67c880603 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -35,7 +35,7 @@ This section contains information about user-defined functions (UDFs) and how to > Get step-by-step instructions about developing Excel Services UDFs by using Microsoft Visual C#. - [Frequently Asked Questions About Excel Services UDFs](frequently-asked-questions-about-excel-services-udfs.md) + [Frequently Asked Questions About Excel Services UDFs](frequently-asked-questions-about-excel-services-udfs.yml) diff --git a/docs/general-development/excel-web-access.md b/docs/general-development/excel-web-access.md index 3d7c15135..104fbd172 100644 --- a/docs/general-development/excel-web-access.md +++ b/docs/general-development/excel-web-access.md @@ -1,9 +1,9 @@ --- title: Excel Web Access -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes the Excel Web Access web part and provides its reference and links to tutorials related to Excel Web Access. +ms.date: 06/09/2022 ms.assetid: eef8991d-0844-4b35-a092-33c957102dee -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/excel-web-services.md b/docs/general-development/excel-web-services.md index 6b6f1de2f..843b43fa3 100644 --- a/docs/general-development/excel-web-services.md +++ b/docs/general-development/excel-web-services.md @@ -1,9 +1,9 @@ --- title: Excel Web Services -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes Excel Web Services, explains how to use it to develop custom applications, and provides links to articles and tutorials. +ms.date: 06/09/2022 ms.assetid: e30ef4e3-72ff-43de-beba-b377141d4d19 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/exporting-and-importing-search-configuration-settings-in-sharepoint.md b/docs/general-development/exporting-and-importing-search-configuration-settings-in-sharepoint.md index 27604eae6..e91a6b31a 100644 --- a/docs/general-development/exporting-and-importing-search-configuration-settings-in-sharepoint.md +++ b/docs/general-development/exporting-and-importing-search-configuration-settings-in-sharepoint.md @@ -1,29 +1,29 @@ --- title: Exporting and importing search configuration settings in SharePoint +description: Get code examples that show you how to export and import customized search configuration settings. These settings include all customized query rules, result sources, result types, ranking models, and site search settings. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: d00679a3-ffa2-4281-ad8b-70fc2c4a14e2 -localization_priority: Normal +ms.localizationpriority: medium --- # Exporting and importing search configuration settings in SharePoint -Get code examples that show you how to export and import customized search configuration settings. These settings include all customized query rules, result sources, result types, ranking models, and site search settings. SharePoint exposes this functionality through the [Microsoft.Office.Server.Search.Portability](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Portability.aspx) namespace.You can also export customized search configuration settings from a Search service application (SSA) and import the settings to site collections and sites. +Get code examples that show you how to export and import customized search configuration settings. These settings include all customized query rules, result sources, result types, ranking models, and site search settings. SharePoint exposes this functionality through the [Microsoft.Office.Server.Search.Portability](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Portability.aspx) namespace.You can also export customized search configuration settings from a Search service application (SSA) and import the settings to site collections and sites. > [!NOTE] -> You can't import customized search configuration settings to an SSA, or export the default search configuration settings. - - - +> You can't import customized search configuration settings to an SSA, or export the default search configuration settings. + + + ## Export search configuration settings The following code shows how to use [SearchConfigurationPortability](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Portability.SearchConfigurationPortability.aspx) to export your site's search configuration settings. The code uses an example site `http://yoursite/sites/publishing1`, which you'd replace with your own site. _fileName_ refers to the file where the search configuration settings are stored; _owner_ specifies the [SPWeb](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPWeb.aspx) level at which the search configuration settings are obtained. - - - + + + ``` @@ -43,11 +43,11 @@ private static void Export(string fileName) The following code shows how to import search configuration settings from a file by using [SearchConfigurationPortability](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Portability.SearchConfigurationPortability.aspx) and replace the existing search settings on a specified site, `http://yoursite/sites/publishing1`. _fileName_ refers to the file where the search configuration settings are stored; _owner_ specifies the [SPWeb](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPWeb.aspx) level at which the search configuration settings are obtained. - - - -```cs + + + +```csharp private static void Import(string fileName) { @@ -66,13 +66,13 @@ private static void Import(string fileName) - [Search in SharePoint](search-in-sharepoint.md) - - + + - [Export and import customized search configuration settings in SharePoint](https://technet.microsoft.com/library/jj871675.aspx) - - - - - + + + + + diff --git a/docs/general-development/extend-the-fixed-format-export-feature-in-word-automation-services.md b/docs/general-development/extend-the-fixed-format-export-feature-in-word-automation-services.md index f1f88a285..752362eb0 100644 --- a/docs/general-development/extend-the-fixed-format-export-feature-in-word-automation-services.md +++ b/docs/general-development/extend-the-fixed-format-export-feature-in-word-automation-services.md @@ -2,9 +2,8 @@ title: Extend the fixed-format export feature in Word Automation Services description: Extend Word Automation Services in Microsoft Office 2013 to replace the library used by the fixed-format export feature. ms.date: 12/14/2020 -ms.prod: sharepoint ms.assetid: d8375505-432e-438e-971b-221a1d9bb601 -localization_priority: Normal +ms.localizationpriority: medium --- # Extend the fixed-format export feature in Word Automation Services diff --git a/docs/general-development/external-content-types-in-sharepoint.md b/docs/general-development/external-content-types-in-sharepoint.md index a30bd15d9..c7760d0d2 100644 --- a/docs/general-development/external-content-types-in-sharepoint.md +++ b/docs/general-development/external-content-types-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: External content types in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes external content types in SharePoint and provides the prerequisites and steps to create external content types. +ms.date: 06/09/2022 ms.assetid: 11d7adb5-5388-4517-ae03-beb7be1c6981 -localization_priority: Priority +ms.localizationpriority: high --- @@ -129,7 +129,7 @@ Table 1 contains examples of tasks that illustrate working with external content **Table 1. Basic tasks for working with external content types** -|**Task**|**Description**| +|Task|Description| |:-----|:-----| | [How to: Create an external content type from an OData source in SharePoint](how-to-create-an-external-content-type-from-an-odata-source-in-sharepoint.md)
|Learn how to use Visual Studio 2012 to discover a published OData source, and create a reusable external content type for use in SharePoint Business Connectivity Services (BCS).
| | [How to: Create external content types for SQL Server in SharePoint](how-to-create-external-content-types-for-sql-server-in-sharepoint.md)
|Learn how to create an external content type based on a SQL Server database.
| diff --git a/docs/general-development/external-events-and-alerts-in-sharepoint.md b/docs/general-development/external-events-and-alerts-in-sharepoint.md index 235ad0494..056ad3528 100644 --- a/docs/general-development/external-events-and-alerts-in-sharepoint.md +++ b/docs/general-development/external-events-and-alerts-in-sharepoint.md @@ -1,289 +1,167 @@ --- title: External events and alerts in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Learn the concepts behind creating remote event receivers in SharePoint that can be attached to external lists and execute when the external data that the list represents is updated. +ms.date: 05/18/2023 ms.assetid: e48e4812-a185-43c5-b243-04b1d79b88ee -localization_priority: Normal +ms.localizationpriority: medium --- - - # External events and alerts in SharePoint + Learn the concepts behind creating remote event receivers in SharePoint that can be attached to external lists and execute when the external data that the list represents is updated. -## What are event receivers? - -An event receiver is a piece of managed code that responds to SharePoint triggering events such as adding, moving, deleting, checking in, and checking out. When these events occur, and the event receiver's criteria are met, the code that you write to provide additional functionality is executed. When SharePoint objects, such as lists, workflows and features, are configured to wait on these events to occur, they are called event hosts. - - - -Event receivers let you perform business logic when a specific event occurs. Essentially, these are the hooks where you can create code to handle certain conditions, make notifications, update other systems, and so on. When you create event receivers, a DLL is generated. You can place that DLL into the global assembly cache, so that the event receivers are invoked in response to any changes in an external system. - - - -The following example contains a simple external event receiver in C# that executes when a new item is added to the list. - - - +## What are event receivers? +An event receiver is a piece of managed code that responds to SharePoint triggering events such as adding, moving, deleting, checking in, and checking out. When these events occur, and the event receiver's criteria are met, the code that you write to provide additional functionality is executed. When SharePoint objects, such as lists, workflows and features, are configured to wait on these events to occur, they are called event hosts. +Event receivers let you perform business logic when a specific event occurs. Essentially, these are the hooks where you can create code to handle certain conditions, make notifications, update other systems, and so on. When you create event receivers, a DLL is generated. You can place that DLL into the global assembly cache, so that the event receivers are invoked in response to any changes in an external system. -```cs +The following example contains a simple external event receiver in C# that executes when a new item is added to the list. +```csharp public class EntryContentEventReceiver : SPItemEventReceiver { - public override void ItemAdded(SPItemEventProperties properties) - { - base.ItemAdded(properties); - - // properties.ExternalNotificationMessage holds the message sent by the external - // system. - } + public override void ItemAdded(SPItemEventProperties properties) + { + base.ItemAdded(properties); + // properties.ExternalNotificationMessage holds the message sent by the external system + } +} ``` -External event receivers can also be extended to work against an entity event receiver and as remote event receivers deployed as a service on-premises or in Microsoft Azure. - - - +External event receivers can also be extended to work against an entity event receiver and as remote event receivers deployed as a service on-premises or in Microsoft Azure. ## What are remote event receivers? - Remote event receivers are new for SharePoint. In a traditional SharePoint solution, you use an event receiver to handle events such as users creating or deleting lists or items in lists. In an SharePoint Add-in, you use a remote event receiver to handle similar events. Remote event receivers work similarly to regular event receivers, except that remote event receivers handle events that occur when an SharePoint Add-in is on a different system from its host web application. - - - + Business Connectivity Services (BCS) uses remote event receivers attached to external lists and entities to allow you to write code that can react to changes in data hosted in the external system. - - - + To accommodate this, two stereotypes have been added to the schema of the BDC model: **EventSubscriber** and **EventUnsubscriber**. - -> [!NOTE] -> Event receivers are not supported in sandboxed solutions. - - - +> [!NOTE] +> Event receivers are not supported in sandboxed solutions. ## What features and capabilities does the new external event receiver infrastructure provide? - By using and extending the SharePoint event receiver features, BCS is able to add alerts, external list event receivers, and entity receivers to provide extended functionality. - - - - -- **Alerts:** Alerts have been an integral part of SharePoint for several versions, but until SharePoint, they would not work with external lists. Now a user can create alerts on an external list that have the same behavior as alerts on a standard SharePoint list. - - -- **External list event receivers:** Event receivers can now be attached to external lists just like they can for standard lists. This provides an extensibility mechanism that lets you write code that is executed at specific times. - - + +- **Alerts:** Alerts have been an integral part of SharePoint for several versions, but until arePoint, they would not work with external lists. Now a user can create alerts on an external list that have the same behavior as alerts on a standard SharePoint list. +- **External list event receivers:** Event receivers can now be attached to external lists just like they can for standard lists. This provides an extensibility mechanism that lets you write de that is executed at specific times. - **Entity event receivers:** Entity event receivers provide flexibility by letting you write more robust code that allows other operations like providing user context for filtering data. This can allow better personalization and customized security. - - + Remote eventing in SharePoint makes several interesting scenarios possible. For example, you might have a "Sales Lead Tracking" application that lets a sales team be notified when new sales leads are entered into an external lead application. When a new sales lead is entered, SharePoint is notified through the notification system that is part of the lead application. SharePoint receives the notification and then creates new tasks for the specified salespeople to follow up on each new lead. By configuring the sales lead entry application on the external system to send a notification to SharePoint on the creation of each new lead, SharePoint is kept completely up to date. - - - ## Prerequisites for using event receivers for external lists - To use event receivers for external lists, you need the following: - - - - SharePoint - - - Visual Studio 2012 - - + For more information about setting up a SharePoint development environment, see [Set up a general development environment for SharePoint](set-up-a-general-development-environment-for-sharepoint.md). - - - ## Configure the external system to notify SharePoint of external events - For external events to work, a number of components have to be installed and configured on both the SharePoint host and the external system. - - - + You have to configure the external system so that it can do the following: - - - - **Determine when underlying data changes.** For the external system to know when changes have been made, you have to create a mechanism for polling for specific changes. You can do this by using a timed service that polls the data source at specific intervals. - - -- **Receive and record requests for subscriptions to change notifications.** The external system has to implement a subscription store so that it can store who should receive change notifications. The simplest solution is probably a database table. The table (or whatever mechanism you choose) should record SubscriptionID, Delivery Address, Event Type, and Entity Name. - - -- **Post notifications to Representational State Transfer (REST) endpoints.** To let SharePoint subscribers know that a change has occurred, the external system application needs to send an HTTP WebRequest to the delivery address recorded in the subscription store. This delivery address is a RESTful endpoint generated by SharePoint during the subscription process. - - +- **Receive and record requests for subscriptions to change notifications.** The external system has to implement a subscription store so that it can store who should receive change notifications. The simplest solution is probably a database table. The table (or whatever anism you choose) should record SubscriptionID, Delivery Address, Event Type, and Entity Name. +- **Post notifications to Representational State Transfer (REST) endpoints.** To let SharePoint subscribers know that a change has occurred, the external system application needs to send an HTTPWebRequest to the delivery address recorded in the subscription store. This delivery address is a RESTful endpoint generated by SharePoint during the subscription process ## Configure SharePoint to allow communication with external systems - To allow communication with the external system, SharePoint must be configured with the following: - - - - A BDC model with **EventSubscriber** and **EventUnsubscriber** stereotypes configured - - - Event receivers - - ### How is external eventing enabled? You can enable external eventing in SharePoint through **Site Settings** or by adding the following custom feature id to your project - - - - -```XML +```xml ``` Eventing for an external system is enabled when SharePoint creates the delivery address and sends it to the external system during the Subscribe process. - - - ## Overall flow of external eventing between SharePoint and external systems - In Figure 1, notice that there are three distinct steps involved when using external event receivers: subscribe, notification, and unsubscribe. - - - **Figure 1 Complete data flow for external notifications** - - - - - - - -![Data flow for external event notifications](../images/ExtEvtsAndAlrts_Figure1.jpg) - - - - - - - - - - - +[Data flow for external event notifications](../images/ExtEvtsAndAlrts_Figure1.jpg) ## EventSubscriber: subscribe to notifications - For a user (SharePoint object) to receive notifications when the underlying data has changed, the user must subscribe to the notifications for an entity. To allow this, the BDC Model schema has been extended to include the **Subscribe** stereotype. The **Subscribe** stereotype is used by SharePoint to let the external system know that the sender is requesting to be notified of changes to the underlying data. - - - + Figure 2 demonstrates the flow of information between SharePoint and the external system during the Subscribe process. - - - **Figure 2. Subscribe process flow** - - - - - - - ![External eventing Subscribe method process flow](../images/ExtEvtsAndAlerts_Figure2.jpg) - - - -The following describes the general flow of the subscription process: - - - - - - +The following describes the general flow of the subscription process: 1. **User requests a subscription for notifications.** Using a custom user interface (a button on a page or a ribbon), SharePoint initiates a request to the external system app for notifications. - - -2. **SharePoint generates a delivery address.** As part of the Subscribe process, SharePoint creates a REST endpoint where notifications will be delivered. - - -3. **Subscription request is sent to the external system.** SharePoint then encapsulates the requestor information along with the dynamically generated REST URL, and sends a web request to the external system. - - -4. **External system receives request.** There are different possibilities for implementing a subscription store. In this example, you will use a SQL Server database table. - - -5. **External system generates a subscriptionId.** A new **subscriptionId** is generated using code in the line-of-business (LOB) application. The **subscriptionId** should be a GUID. - - -6. **External system records the subscription.** The external system application records the **subscriptionId**, delivery address, event type, and other information sent from SharePoint into the subscription store. - - -7. **External system sends the subscriptionId back to SharePoint.** For SharePoint to correctly route the updates that are sent by the external system, the **subscriptionId** is sent back to SharePoint and SharePoint records that information in its database. - - The BDC model is working against a **Subscribe** function import. The metadata for function import is shown in this example. - +1. **SharePoint generates a delivery address.** As part of the Subscribe process, SharePoint creates a REST endpoint where notifications will be delivered. +1. **Subscription request is sent to the external system.** SharePoint then encapsulates the requestor information along with the dynamically generated REST URL, and sends a web request to the external system. +1. **External system receives request.** There are different possibilities for implementing a subscription store. In this example, you will use a SQL Server database table. +1. **External system generates a subscriptionId.** A new **subscriptionId** is generated using code in the line-of-business (LOB) application. The **subscriptionId** should be a GUID. +1. **External system records the subscription.** The external system application records the **subscriptionId**, delivery address, event type, and other information sent from SharePoint into the subscription store. +1. **External system sends the subscriptionId back to SharePoint.** For SharePoint to correctly route the updates that are sent by the external system, the **subscriptionId** is sent back to SharePoint and SharePoint records that information in its database. + The BDC model is working against a **Subscribe** function import. The metadata for function import is shown in this example. -```XML - FunctionImport - +```xml - - - + + + - - - + + + - ``` - ### Code example: BDC model with Subscribe The following is an example of a BDC model with the **Subscribe** method added. - - - - -```XML +```xml /EntitySubscribes @@ -318,7 +196,7 @@ The following is an example of a BDC model with the **Subscribe** method added. - Customers @@ -368,148 +246,72 @@ The following is an example of a BDC model with the **Subscribe** method added. ``` Table 1 lists the important attributes of the BDC model that are needed to make the **Subscribe** stereotype work. - - - **Table 1. BDC model attributes** - -|**Attribute**|**Description**| -|:-----|:-----| -|**IsDeliveryAddress**
|A **Boolean** flag used on a **TypeDescriptor** to indicate whether the delivery address provided is to be used to deliver notifications.
| -|**IsEventType**
|A **Boolean** flag used on a **TypeDescriptor** to indicate whether the event type provided is to be used as the event type. Valid event types are **ItemAdded**, **ItemUpdated**, **ItemDeleted**, and so on.
| -|**SubscriptionIdName**
|A string used on a **TypeDescriptor** that represents the name of a **subscriptionId** part.
| - +| **Attribute** | **Description** | +| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **IsDeliveryAddress** | A **Boolean** flag used on a **TypeDescriptor** to indicate whether the delivery address provided is to be used to deliver notifications. | +| **IsEventType** | A **Boolean** flag used on a **TypeDescriptor** to indicate whether the event type provided is to be used as the event type. Valid event types are **ItemAdded**, **ItemUpdated**, **ItemDeleted**, and so on. | +| **SubscriptionIdName** | A string used on a **TypeDescriptor** that represents the name of a **subscriptionId** part. | ## Notifications - In SharePoint, the event-handling infrastructure has been enhanced to allow external data sources to notify SharePoint when information in the external system has been modified. Then, when SharePoint receives a notification, event receivers that are associated with the SharePoint external list or entity can execute code to perform specified actions. - - - + When a subscription is created, the external system needs a way to tell SharePoint about the changes that have occurred on a particular entity. The external system is expected to deliver notifications to the delivery address as provided by SharePoint to the external system during the Subscribe process using an OData Atom-formatted payload. - - - + Figure 3 shows the communication flow between the external system and SharePoint when a new record is added to the data in the external system. - - - **Figure 3 Notification process** - - - - - - - ![External event notification process](../images/ExtEvtsAndAlerts_Figure3.jpg) - - - - - - - 1. **New record is added to external system.** In this example, a new record is added to the external system using the application user interface or directly into the database. - - -2. **External system application is notified of the change.** The external system application has to be made aware of the changes that are happening to the underlying data. There are a number of ways to do this. You can use SQL triggers that fire when data changes on specific tables, or you can create a polling mechanism to query the data store for changes. There are other ways to accomplish this, but each will have to be evaluated with performance in mind. - - -3. **External system sends notification request to SharePoint through delivery address.** To communicate the changes, an Atom-formatted request has to be sent to the delivery address that is stored in the LOB application's subscription store. - - +1. **External system application is notified of the change.** The external system application has to be made aware of the changes that are happening to the underlying data. There are a number of ways to do this. You can use SQL triggers that fire when data changes on specific tables, or you can create a polling mechanism to query the data store for changes. There are other ways to accomplish this, but each will have to be evaluated with performance in mind. +1. **External system sends notification request to SharePoint through delivery address.** To communicate the changes, an Atom-formatted request has to be sent to the delivery address that is stored in the LOB application's subscription store. ### Notification payload In constructing the notification, the LOB system has to create an HTTP payload that includes either the full details of the item that changed, or just the identity of the item that changed. - - - - **Identity:** When the payload is sent as an identity, the payload is expected to have only information about the identity of the changed item. For example, for a customer in a Customers entity, the payload would only contain the ID of the customer that has changed. - - - **Full item:** In this case, the payload is an entire record that has changed in the external system. In the customer example, the entire changed customer record is included. - + > [!NOTE] -> The full item is only supported when you use the OData connector. - - - +> The full item is only supported when you use the OData connector. The type of payload that is being sent by the external system must be indicated during the subscription process. - - - -The following is an example of the BDC model property used for notifications. - - - - +The following is an example of the BDC model property used for notifications. -```XML - +```xml ODataEntryContentNotificationParser - ``` If it is not specified, the default payload is an identity payload. - - - ### Notification delivery address (virtual address) The subscription process initiated from SharePoint results in a virtual address being created by SharePoint, allowing an entry point for the external system to post notifications. The delivery address is used by the external system to post those notifications. The delivery address is also passed to the external system during the subscription request. - - - ## EventUnsubscriber: remove subscription from the notifications list - The **Unsubscribe** operation removes a subscription from the notifications list. - - - - Figure 4 shows that the **UnSubscribe** method is much simpler. Because the subscription ID was sent back to SharePoint, and SharePoint recorded it, all that is needed is to send the UnSubscribe request with the correct subscription ID. - - - -**Figure 4 Code flow for UnSubscribe method** +Figure 4 shows that the **UnSubscribe** method is much simpler. Because the subscription ID was sent back to SharePoint, and SharePoint recorded it, all that is needed is to send the UnSubscribe request with the correct subscription ID. - - - +**Figure 4 Code flow for UnSubscribe method** - - - ![External notifications unsubscribe process](../images/ExternalEventsAndAlerts_UnsubscribeFlow.jpg) - - - ### BDC model for Unsubscribe The following XML example shows how you can create a BDC model that unsubscribes from the external system event notifications. - - - - -```XML +```xml @@ -540,7 +342,7 @@ The following XML example shows how you can create a BDC model that unsubscribes - @@ -554,8 +356,6 @@ The following XML example shows how you can create a BDC model that unsubscribes - - @@ -567,12 +367,12 @@ The following XML example shows how you can create a BDC model that unsubscribes - - None @@ -588,77 +388,46 @@ The following XML example shows how you can create a BDC model that unsubscribes - ``` - ## Code example: Attach an event receiver to an external list - The following code provides an example of how to attach an event receiver to an external list. After it is attached, the event receiver listens for notifications from the external system about updates, additions, and deletions that are performed on the native data. - - - - -```XML +```csharp private static void AddEventReceiver(string siteUrl, string listTitle) -{ - string assembly = "SampleEventReceiver, Culture=neutral, Version=1.0.0.0, - PublicKeyToken=1bfafa687d2e46a7"; - string className = "SampleEventReceiver.EntryContentEventReceiver"; - - try - { - using (SPSite site = new SPSite(siteUrl)) - { - using (SPWeb web = site.OpenWeb()) - { - SPList list = web.Lists[listTitle]; - list.EventReceivers.Add(SPEventReceiverType.ItemAdded, - assembly, className); - } +{ + string assembly = "SampleEventReceiver, Culture=neutral, Version=1.0.0.0,PublicKeyToken=1bfafa687d2e46a7"; + string className = "SampleEventReceiver.EntryContentEventReceiver"; + try + { + using (SPSite site = new SPSite(siteUrl)) + { + using (SPWeb web = site.OpenWeb()) + { + SPList list = web.Lists[listTitle]; + list.EventReceivers.Add(SPEventReceiverType.ItemAdded, assembly, className); } - } - catch (Exception e) - { - Console.WriteLine(e); - } + } + } + catch (Exception e) + { + Console.WriteLine(e); + } } - ``` - ## Beyond the basics: Learn more about using external event receivers - For more information about external events and alerts, see the following. - - - **Table 2. Advanced concepts for working with external event receivers** +| **Article** | **Description** | +| :----------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [How to: Create an OData data service for use as a BCS external system](how-to-create-an-odata-data-service-for-use-as-a-bcs-external-system.md) | Learn how to create an Internet-addressable Windows Communication Foundation (WCF) service that uses OData to send notifications to SharePoint when the underlying data changes. These notifications are used to tigger events that are attached to external lists. | -|**Article**|**Description**| -|:-----|:-----| -| [How to: Create an OData data service for use as a BCS external system](how-to-create-an-odata-data-service-for-use-as-a-bcs-external-system.md)
|Learn how to create an Internet-addressable Windows Communication Foundation (WCF) service that uses OData to send notifications to SharePoint when the underlying data changes. These notifications are used to trigger events that are attached to external lists.
| - - -## See also - - - -- [What's new in Business Connectivity Services in SharePoint](what-s-new-in-business-connectivity-services-in-sharepoint.md) - - -- [Business Connectivity Services in SharePoint](business-connectivity-services-in-sharepoint.md) - - -- [Business Connectivity Services programmers reference for SharePoint](business-connectivity-services-programmers-reference-for-sharepoint.md) - - -- [How to: Create external event receivers](how-to-create-external-event-receivers.md) - - +## See Also +- [What's new in Business Connectivity Services in SharePoint](what-s-new-in-business-connectivity-services-in-sharepoint.md) +- [Business Connectivity Services in SharePoint](business-connectivity-services-in-sharepoint.md) diff --git a/docs/general-development/fast-query-language-fql-syntax-reference.md b/docs/general-development/fast-query-language-fql-syntax-reference.md index 48df9d176..3a85d77d4 100644 --- a/docs/general-development/fast-query-language-fql-syntax-reference.md +++ b/docs/general-development/fast-query-language-fql-syntax-reference.md @@ -1,10 +1,9 @@ --- title: FAST Query Language (FQL) syntax reference description: Learn about constructing complex search queries for Search in SharePoint using the FAST Query Language (FQL). This reference describes the elements of an FQL query and how to use property specifications, token expressions, and operators in your FQL queries. -ms.date: 12/22/2020 -ms.prod: sharepoint +ms.date: 06/09/2022 ms.assetid: bd98a41b-623c-41d4-a15d-26c0d4ba4311 -localization_priority: Priority +ms.localizationpriority: high --- # FAST Query Language (FQL) syntax reference @@ -656,7 +655,7 @@ Use the **RANGE** operator for numeric and date/time managed properties. The ope #### Parameters -| Parameter | Value | Description | | +| Parameter | Value | Value | Description | | :-------- | :------------------ | :------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | _start_ | _\\ | \_ | Start value for the range. To specify that the range has no lower bound, use the reserved word **min**. | | _stop_ | _\\ | \_ | End value for the range. To specify that the range has no upper bound, use the reserved word **max**. | diff --git a/docs/general-development/follow-content-in-sharepoint.md b/docs/general-development/follow-content-in-sharepoint.md index 5abf78f05..13944f2dd 100644 --- a/docs/general-development/follow-content-in-sharepoint.md +++ b/docs/general-development/follow-content-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Follow content in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes the APIs for programmatically following content in SharePoint and provides lists of SharePoint APIs. +ms.date: 06/09/2022 ms.assetid: 30e68cd6-6e55-4cf9-afd6-7139b0a97288 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -65,7 +65,7 @@ Table 1 shows the manager and other key objects (or REST resources) in the APIs **Table 1. SharePoint APIs used for following content programmatically** -|**API**|**Key objects**| +|API|Key objects| |:-----|:-----| |.NET client object model
See: [How to: Follow documents and sites by using the .NET client object model in SharePoint](how-to-follow-documents-and-sites-by-using-the-net-client-object-model-in-sharep.md)|Manager object: [SocialFollowingManager](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialFollowingManager.aspx)
Primary namespace: [Microsoft.SharePoint.Client.Social](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.aspx)
Other key objects: [SocialActor](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialActor.aspx) , [SocialActorInfo](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialActorInfo.aspx) , [SocialActorType](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialActorType.aspx) , [SocialActorTypes](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialActorTypes.aspx)
Class library: Microsoft.SharePoint.Client.UserProfiles.dll | |JavaScript object model|Manager object: [SocialFollowingManager](https://msdn.microsoft.com/library/9ee1c0c0-b864-f0c3-f0cb-4dd4f1870dfa%28Office.15%29.aspx)
Primary namespace: [SP.Social](https://msdn.microsoft.com/library/43d47f01-c085-0e77-bd01-48bcb7d5bb35%28Office.15%29.aspx)
Other key objects: [SocialActor](https://msdn.microsoft.com/library/4e369fd5-b9b0-9804-957e-b3e39c559cd4%28Office.15%29.aspx), [SocialActorInfo](https://msdn.microsoft.com/library/d940db32-1561-c868-bb66-0612e2031f17%28Office.15%29.aspx), [SocialActorType](https://msdn.microsoft.com/library/fbde74da-f292-dc87-0b7e-81bc5b7a880c%28Office.15%29.aspx), [SocialActorTypes](https://msdn.microsoft.com/library/a460c3e6-ed88-117d-6755-4c5803a154a0%28Office.15%29.aspx)
Class library: SP.UserProfiles.js | @@ -88,7 +88,7 @@ Table 2 shows common programming tasks for following content and the members tha **Table 2. API for common tasks for following content in SharePoint** -|**Task**|**Members**| +|Task|Members| |:-----|:-----| |Create an instance of a manager object in the context of the current user|CSOM: [SocialFollowingManager](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialFollowingManager.aspx)
JSOM: [SocialFollowingManager](https://msdn.microsoft.com/library/9ee1c0c0-b864-f0c3-f0cb-4dd4f1870dfa%28Office.15%29.aspx)
REST: `/_api/social.following`
SSOM: [SPSocialFollowingManager](https://msdn.microsoft.com/library/Microsoft.Office.Server.Social.SPSocialFollowingManager.aspx)| |Create an instance of a manager object in the context of a specified user|CSOM: not implemented
JSOM: not implemented
REST: not implemented
SSOM: [SPSocialFollowingManager](https://msdn.microsoft.com/library/Microsoft.Office.Server.Social.SPSocialFollowingManager.aspx) (overloaded)| diff --git a/docs/general-development/follow-people-in-sharepoint.md b/docs/general-development/follow-people-in-sharepoint.md index 878920949..fb74dd3c7 100644 --- a/docs/general-development/follow-people-in-sharepoint.md +++ b/docs/general-development/follow-people-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Follow people in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes the common programming tasks for following people in SharePoint and provides a list of APIs for programmatically following people. +ms.date: 06/09/2022 ms.assetid: 0fa2e235-63d0-41b1-9eed-4aeb2f59a14d -localization_priority: Normal +ms.localizationpriority: medium --- @@ -65,7 +65,7 @@ Table 1 shows the manager and other key objects (or REST resources) in the APIs **Table 1. SharePoint APIs used for following people programmatically** -|**API**|**Key objects**| +|API|Key objects| |:-----|:-----| |.NET client object model
See: [How to: Follow people by using the .NET client object model in SharePoint](how-to-follow-people-by-using-the-net-client-object-model-in-sharepoint.md)|Manager object: [SocialFollowingManager](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialFollowingManager.aspx)
Primary namespace: [Microsoft.SharePoint.Client.Social](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.aspx)
Other key objects: [SocialActor](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialActor.aspx) , [SocialActorInfo](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialActorInfo.aspx) , [SocialActorType](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialActorType.aspx) , [SocialActorTypes](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialActorTypes.aspx)
Class library: Microsoft.SharePoint.Client.UserProfiles.dll | |JavaScript object model
See: [How to: Follow people by using the JavaScript object model in SharePoint](how-to-follow-people-by-using-the-javascript-object-model-in-sharepoint.md)|Manager object: [SocialFollowingManager](https://msdn.microsoft.com/library/9ee1c0c0-b864-f0c3-f0cb-4dd4f1870dfa%28Office.15%29.aspx)
Primary namespace: **SP.Social**
Other key objects: [SocialActor](https://msdn.microsoft.com/library/4e369fd5-b9b0-9804-957e-b3e39c559cd4%28Office.15%29.aspx), [SocialActorInfo](https://msdn.microsoft.com/library/d940db32-1561-c868-bb66-0612e2031f17%28Office.15%29.aspx), [SocialActorType](https://msdn.microsoft.com/library/fbde74da-f292-dc87-0b7e-81bc5b7a880c%28Office.15%29.aspx), [SocialActorTypes](https://msdn.microsoft.com/library/a460c3e6-ed88-117d-6755-4c5803a154a0%28Office.15%29.aspx)
Class library: SP.UserProfiles.js | @@ -92,7 +92,7 @@ The **SocialFollowingManager** object consolidates the core Following People and **Table 2. API for common tasks for following people by using the SocialFollowingManager object** -|**Task**|**Members**| +|Task|Members| |:-----|:-----| |Create an instance of a manager object in the context of the current user |CSOM: [SocialFollowingManager](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialFollowingManager.aspx)
JSOM: **SocialFollowingManager**
REST: `/_api/social.following`
SSOM: [SPSocialFollowingManager](https://msdn.microsoft.com/library/Microsoft.Office.Server.Social.SPSocialFollowingManager.aspx)| |Create an instance of a manager object in the context of a particular user |CSOM: not implemented
JSOM: not implemented
REST: not implemented
SSOM: [SPSocialFollowingManager](https://msdn.microsoft.com/library/Microsoft.Office.Server.Social.SPSocialFollowingManager.aspx) (overloaded)| @@ -111,7 +111,7 @@ Table 3 shows the **PeopleManager** members that you can use for additional Foll **Table 3. API for common tasks for following people by using the PeopleManager object** -|**Task**|**Members**| +|Task|Members| |:-----|:-----| |Find out whether the **People I'm Following** list for the current user is public|CSOM: [IsMyPeopleListPublic](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.UserProfiles.PeopleManager.IsMyPeopleListPublic.aspx)
JSOM: [isMyPeopleListPublic](https://msdn.microsoft.com/library/2ffc73a5-24ce-1ed4-d850-a6fea4c773bb%28Office.15%29.aspx)
REST: [IsMyPeopleListPublic](https://msdn.microsoft.com/library/10757ed1-6e86-474f-89e0-6dec6aa66a2b%28Office.15%29.aspx#bk_PeopleManagerProperties)
Example: **GET** `/_api/SP.UserProfiles.PeopleManager/IsMyPeopleListPublic`
SSOM: [IsMyPeopleListPublic](https://msdn.microsoft.com/library/Microsoft.Office.Server.UserProfiles.PeopleManager.IsMyPeopleListPublic.aspx)| |Find out whether someone is following the current user |CSOM: [AmIFollowedBy](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.UserProfiles.PeopleManager.AmIFollowedBy.aspx)
JSOM: [amIFollowedBy](https://msdn.microsoft.com/library/3641c469-0063-054d-355d-e56697cb08ae%28Office.15%29.aspx)
REST: [AmIFollowedBy](https://msdn.microsoft.com/library/10757ed1-6e86-474f-89e0-6dec6aa66a2b%28Office.15%29.aspx#bk_PeopleManagerAmIFollowedBy)
Example: **GET** `/_api/SP.UserProfiles.PeopleManager/AmIFollowedBy(accountName=@v)?@v='domain\\user'`
SSOM: [AmIFollowedBy](https://msdn.microsoft.com/library/Microsoft.Office.Server.UserProfiles.PeopleManager.AmIFollowedBy.aspx)| diff --git a/docs/general-development/following-people-and-content-rest-api-reference-for-sharepoint.md b/docs/general-development/following-people-and-content-rest-api-reference-for-sharepoint.md index 9a3cf0d0f..e917934f3 100644 --- a/docs/general-development/following-people-and-content-rest-api-reference-for-sharepoint.md +++ b/docs/general-development/following-people-and-content-rest-api-reference-for-sharepoint.md @@ -1,9 +1,9 @@ --- title: Following people and content REST API reference for SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes finding SharePoint REST endpoints for following people and content by using the SocialRestFollowingManager and the PeopleManager resources. +ms.date: 06/09/2022 ms.assetid: c05755df-846d-4a39-941d-950d066cc6d4 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/frequently-asked-questions-about-excel-services-udfs.md b/docs/general-development/frequently-asked-questions-about-excel-services-udfs.md deleted file mode 100644 index 3f534adef..000000000 --- a/docs/general-development/frequently-asked-questions-about-excel-services-udfs.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -title: Frequently Asked Questions About Excel Services UDFs -ms.date: 09/25/2017 -keywords: faqs -f1_keywords: -- faqs -ms.prod: sharepoint -ms.assetid: 3d94d040-eecf-4f8e-a316-6d1cca95e7eb -localization_priority: Normal ---- - - -# Frequently Asked Questions About Excel Services UDFs - -Here are some frequently asked questions about Excel Services user-defined functions (UDFs). - - - - - -## Creating Managed-Code UDFs - - -### What is a supported UDF class? - -The UDF class in a UDF assembly must be public. It can be sealed. It cannot be abstract, internal, or private. It must have a parameterless, public constructor. For languages that automatically generate a parameterless, public constructor (for example, C#), you can have no constructor at all. - - - - -### What is a supported UDF method? - -The UDF method in a UDF assembly must be public. The UDF method must be thread-safe. - - - -A UDF method cannot have: - - - - -- **ref** or **out** parameters - - -- **retval** attributes - - -- **Optional** arguments - - -- unsupported data types - - -The UDF method must also have a supported return type. For a list of supported data types, see the "Data Types" section of this topic. - - - - -### Can I call a Web service from a UDF assembly? - -Yes. For an example, see the following UDF sample code. Also see [How to: Create a UDF That Calls a Web Service](how-to-create-a-udf-that-calls-a-web-service.md). - - - - -```cs - -using System; -using System.Collections.Generic; -using System.Text; -using Microsoft.Office.Excel.Server.Udf; -using UdfWS.dk.iter.webservices; - -namespace UdfWS -{ - [UdfClass] - public class MyUdfClass - { - // Instantiate the Web service. The Web service used is at - // http://webservices.iter.dk/calculator.asmx - Calculator calc = new Calculator(); - - [UdfMethod] - public int MyFunction() - { - int i; - i = (i + 88) * 2; - return i; - } - - [UdfMethod(IsVolatile = true)] - public double MyDouble(double d) - { - return d * 9; - } - - [UdfMethod] - public int AddMe(int a, int b) - { - int c; - // Call the Web service Add method - c = calc.Add(a, b); - return c; - } - } -} -``` - - -```VB.net - -Imports System -Imports System.Collections.Generic -Imports System.Text -Imports Microsoft.Office.Excel.Server.Udf -Imports UdfWS.dk.iter.webservices - -Namespace UdfWS - _ - Public Class MyUdfClass - ' Instantiate the Web service. The Web service used is at - ' http://webservices.iter.dk/calculator.asmx - Private calc As New Calculator() - - _ - Public Function MyFunction() As Integer - Dim i As Integer - i = (i + 88) * 2 - Return i - End Function - - _ - Public Function MyDouble(ByVal d As Double) As Double - Return d * 9 - End Function - - _ - Public Function AddMe(ByVal a As Integer, ByVal b As Integer) As Integer - Dim c As Integer - ' Call the Web service Add method - c = calc.Add(a, b) - Return c - End Function - End Class -End Namespace -``` - - -## Data Types - - -### What are the data types that can be used as UDF parameters? - -The supported data types are as follows: - - - - -- Numeric types: Double, Single, Int32, UInt32, Int16, UInt16, Byte, Sbyte - - -- String - - -- Boolean - - -- Object arrays: one- or two- dimensional arrays, that is, object [] and object [,] - - -- DateTime - - - -### What are the supported return value types? - -The supported return value types are as follows: - - - - -- Numeric types: Double, Single, Int32, UInt32, Int16, UInt16, Byte, Sbyte - - -- String - - -- Boolean - - -- Object arrays: one- or two-dimensional arrays, that is, object [], object [,], int[] and int[,]) - - -- DateTime - - -- Object - - - -## XLLs - - -### Are XLLs supported? - -Not directly. Excel Services will load and call only managed-code UDFs. However, you can write a managed-code wrapper to call the XLLs and deploy the XLLs to the server, together with the managed-code wrapper assembly. - - - - -## See also - - -#### Tasks - - - - - - [How to: Create a UDF That Calls a Web Service](how-to-create-a-udf-that-calls-a-web-service.md) - - - - [How to: Trust a Location](how-to-trust-a-location.md) - - - - [How to: Catch Exceptions](how-to-catch-exceptions.md) -#### Concepts - - - - - - [Understanding Excel Services UDFs](understanding-excel-services-udfs.md) - - - - [Walkthrough: Developing a Managed-Code UDF](walkthrough-developing-a-managed-code-udf.md) - - - - [Excel Services Architecture](excel-services-architecture.md) - - - - [Excel Services Alerts](excel-services-alerts.md) - - - - [Excel Services Known Issues and Tips](excel-services-known-issues-and-tips.md) - - - - [Excel Services Best Practices](excel-services-best-practices.md) diff --git a/docs/general-development/frequently-asked-questions-about-excel-services-udfs.yml b/docs/general-development/frequently-asked-questions-about-excel-services-udfs.yml new file mode 100644 index 000000000..761eaac4a --- /dev/null +++ b/docs/general-development/frequently-asked-questions-about-excel-services-udfs.yml @@ -0,0 +1,200 @@ +### YamlMime:FAQ +metadata: + title: Frequently Asked Questions About Excel Services UDFs + description: Here are some frequently asked questions about Excel Services user-defined functions (UDFs). + ms.date: 09/25/2017 + keywords: faqs + f1_keywords: + - faqs + ms.assetid: 3d94d040-eecf-4f8e-a316-6d1cca95e7eb + ms.localizationpriority: medium + +title: Frequently Asked Questions About Excel Services UDFs +summary: | + Here are some frequently asked questions about Excel Services user-defined functions (UDFs). + +sections: + - name: Creating Managed-Code UDFs + questions: + - question: | + What is a supported UDF class? + answer: | + The UDF class in a UDF assembly must be public. It can be sealed. It cannot be abstract, internal, or private. It must have a parameterless, public constructor. For languages that automatically generate a parameterless, public constructor (for example, C#), you can have no constructor at all. + + - question: | + What is a supported UDF method? + answer: | + The UDF method in a UDF assembly must be public. The UDF method must be thread-safe. + + A UDF method cannot have: + + - **ref** or **out** parameters + + - **retval** attributes + + - **Optional** arguments + + - unsupported data types + + The UDF method must also have a supported return type. For a list of supported data types, see the "Data Types" section of this topic. + + - question: | + Can I call a Web service from a UDF assembly? + answer: | + Yes. For an example, see the following UDF sample code. Also see [How to: Create a UDF That Calls a Web Service](how-to-create-a-udf-that-calls-a-web-service.md). + + ```csharp + using System; + using System.Collections.Generic; + using System.Text; + using Microsoft.Office.Excel.Server.Udf; + using UdfWS.dk.iter.webservices; + + namespace UdfWS + { + [UdfClass] + public class MyUdfClass + { + // Instantiate the Web service. The Web service used is at + // http://webservices.iter.dk/calculator.asmx + Calculator calc = new Calculator(); + + [UdfMethod] + public int MyFunction() + { + int i; + i = (i + 88) * 2; + return i; + } + + [UdfMethod(IsVolatile = true)] + public double MyDouble(double d) + { + return d * 9; + } + + [UdfMethod] + public int AddMe(int a, int b) + { + int c; + // Call the Web service Add method + c = calc.Add(a, b); + return c; + } + } + } + ``` + + + ```VB.net + + Imports System + Imports System.Collections.Generic + Imports System.Text + Imports Microsoft.Office.Excel.Server.Udf + Imports UdfWS.dk.iter.webservices + + Namespace UdfWS + _ + Public Class MyUdfClass + ' Instantiate the Web service. The Web service used is at + ' http://webservices.iter.dk/calculator.asmx + Private calc As New Calculator() + + _ + Public Function MyFunction() As Integer + Dim i As Integer + i = (i + 88) * 2 + Return i + End Function + + _ + Public Function MyDouble(ByVal d As Double) As Double + Return d * 9 + End Function + + _ + Public Function AddMe(ByVal a As Integer, ByVal b As Integer) As Integer + Dim c As Integer + ' Call the Web service Add method + c = calc.Add(a, b) + Return c + End Function + End Class + End Namespace + ``` + + - name: Data Types + questions: + - question: | + What are the data types that can be used as UDF parameters? + answer: | + The supported data types are as follows: + + - Numeric types: Double, Single, Int32, UInt32, Int16, UInt16, Byte, Sbyte + + + - String + + + - Boolean + + + - Object arrays: one- or two- dimensional arrays, that is, object [] and object [,] + + + - DateTime + + - question: | + What are the supported return value types? + answer: | + The supported return value types are as follows: + + - Numeric types: Double, Single, Int32, UInt32, Int16, UInt16, Byte, Sbyte + + - String + + - Boolean + + - Object arrays: one- or two-dimensional arrays, that is, object [], object [,], int[] and int[,]) + + - DateTime + + - Object + + + + - name: XLLs + questions: + - question: | + Are XLLs supported? + answer: | + Not directly. Excel Services will load and call only managed-code UDFs. However, you can write a managed-code wrapper to call the XLLs and deploy the XLLs to the server, together with the managed-code wrapper assembly. + + +additionalContent: | + + ## See also + + #### Tasks + + [How to: Create a UDF That Calls a Web Service](how-to-create-a-udf-that-calls-a-web-service.md) + + [How to: Trust a Location](how-to-trust-a-location.md) + + [How to: Catch Exceptions](how-to-catch-exceptions.md) + + #### Concepts + + + [Understanding Excel Services UDFs](understanding-excel-services-udfs.md) + + [Walkthrough: Developing a Managed-Code UDF](walkthrough-developing-a-managed-code-udf.md) + + [Excel Services Architecture](excel-services-architecture.md) + + [Excel Services Alerts](excel-services-alerts.md) + + [Excel Services Known Issues and Tips](excel-services-known-issues-and-tips.md) + + [Excel Services Best Practices](excel-services-best-practices.md) \ No newline at end of file diff --git a/docs/general-development/general-guidelines.md b/docs/general-development/general-guidelines.md index a96824143..c08754b48 100644 --- a/docs/general-development/general-guidelines.md +++ b/docs/general-development/general-guidelines.md @@ -1,9 +1,9 @@ --- title: General Guidelines -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides general information related to Excel Services and provides links to articles and tutorials about Excel Services. +ms.date: 06/09/2022 ms.assetid: 437541f8-5cd9-46f4-92b6-3bf9d7e62f69 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/get-started-developing-with-social-features-in-sharepoint.md b/docs/general-development/get-started-developing-with-social-features-in-sharepoint.md index c590fcd2b..9431f614a 100644 --- a/docs/general-development/get-started-developing-with-social-features-in-sharepoint.md +++ b/docs/general-development/get-started-developing-with-social-features-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Get started developing with social features in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to get started with developing SharePoint social features and provides links to articles and tutorials. +ms.date: 06/09/2022 ms.assetid: 8852ce36-8309-45a7-a141-2e10ac17a123 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -113,7 +113,7 @@ After you set up your development environment and choose your scenario, you can **Table 1. How-to articles for developing with social features** -|**Feature area**|**Description**| +|Feature area|Description| |:-----|:-----| | [How to: Learn to read and write to the social feed by using the .NET client object model in SharePoint](how-to-learn-to-read-and-write-to-the-social-feed-by-using-the-net-client-object.md)|Walk through detailed steps for creating an application that reads and writes to the social feed by using the .NET client object model.| | [How to: Learn to read and write to the social feed by using the REST service in SharePoint](how-to-learn-to-read-and-write-to-the-social-feed-by-using-the-rest-service-in-s.md)|Walk through detailed steps for creating an application that reads and writes to the social feed by using the REST service.| @@ -141,7 +141,7 @@ Although apps and solutions access SharePoint differently, after you do access S **Table 2. APIs for programming with social features** -|**API name**|**Source and path**| +|API name|Source and path| |:-----|:-----| | [.NET client object model](https://msdn.microsoft.com/library/9cc3f70c-78ac-4d2d-b46e-77522ee5d937%28Office.15%29.aspx)|Microsoft.SharePoint.Client.UserProfiles.dll
in %ProgramFiles%\\Common Files\\Microsoft Shared\\web server extensions\\15\\ISAPI| |Silverlight client object model|Microsoft.SharePoint.Client.UserProfiles.Silverlight.dll
in %ProgramFiles%\\Common Files\\Microsoft Shared\\web server extensions\\15\\TEMPLATE\\LAYOUTS\\ClientBin| @@ -172,7 +172,7 @@ App permission requests are scoped to the SharePoint deployment landscape. Table **Table 3. App permission scopes and available rights for social features in SharePoint** -|**Scope name**|**Description**|**Available rights**| +|Scope name|Description|Available rights| |:-----|:-----|:-----| |User Profiles
`http://sharepoint/social/tenant`|The permission request scope used to access all user profiles. Only the profile picture can be changed; all other user profile properties are read-only for SharePoint Add-ins. Must be installed by a tenant administrator.|Read, Write, Manage, FullControl| |Core
`http://sharepoint/social/core`|The permission request scope used to access the user's followed content and shared metadata that is used by microblogging features. This scope applies only to personal sites that support following content. If the app installs on any other type of site, use the Tenant scope.|Read, Write, Manage, FullControl| diff --git a/docs/general-development/get-started-using-the-client-object-model-with-external-data-in-sharepoint.md b/docs/general-development/get-started-using-the-client-object-model-with-external-data-in-sharepoint.md index e2584c33c..b6fe3360a 100644 --- a/docs/general-development/get-started-using-the-client-object-model-with-external-data-in-sharepoint.md +++ b/docs/general-development/get-started-using-the-client-object-model-with-external-data-in-sharepoint.md @@ -1,15 +1,14 @@ --- title: Get started using the client object model with external data in SharePoint +description: Learn how to use the SharePoint client object model to work with Business Connectivity Services (BCS) in SharePoint. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: 8ed91929-fdb6-4fde-ba2a-7942870575f3 -localization_priority: Normal +ms.localizationpriority: medium --- - - - # Get started using the client object model with external data in SharePoint + Learn how to use the SharePoint client object model to work with Business Connectivity Services (BCS) in SharePoint. + ## What is the SharePoint client object model? The client object model for SharePoint is a set of client-based libraries that represent the server object model. They are packaged in three different DLLs to accommodate a variety of development types. The client object model includes most of the major functions of the server API. This allows access to the same types of functionality from browser scripting and also .NET web applications and Silverlight applications.
To enhance and expand the capabilities for working with external data, Business Connectivity Services (BCS) has expanded the client object model to include additional functionality.
@@ -100,7 +99,7 @@ This example shows how to get context from SharePoint, and then retrieve a speci -```cs +```csharp ClientContext ctx = new ClientContext("http://sharepointservername"); Web web = ctx.Web; @@ -118,7 +117,7 @@ This example shows how to write a generic invoker so that you can create an enti -```cs +```csharp LobSystem lobSystem = entity.GetLobSystem(); ctx.Load(lobSystem); @@ -152,7 +151,7 @@ The following example shows how to retrieve a filtered, paged dataset. In this c -```cs +```csharp // Find filters for given Method Name. FilterCollection fCollection = entity.GetFilters("methodName"); @@ -177,7 +176,7 @@ The following example demonstrates how to return a filtered result set. In this -```cs +```csharp // Find filters for given Method Name. FilterCollection fCollection = entity.GetFilters("methodName"); diff --git a/docs/general-development/get-started-with-business-connectivity-services-in-sharepoint.md b/docs/general-development/get-started-with-business-connectivity-services-in-sharepoint.md index e1c4247ac..724782b63 100644 --- a/docs/general-development/get-started-with-business-connectivity-services-in-sharepoint.md +++ b/docs/general-development/get-started-with-business-connectivity-services-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Get started with Business Connectivity Services in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to get started with Business Connectivity Services in SharePoint and provides lists of core concepts and basic tasks. +ms.date: 06/09/2022 ms.assetid: c6bf3db0-db79-4b13-9834-891d24b2c9e5 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/get-started-with-workflows-in-sharepoint.md b/docs/general-development/get-started-with-workflows-in-sharepoint.md index ca1feac65..9a55786ce 100644 --- a/docs/general-development/get-started-with-workflows-in-sharepoint.md +++ b/docs/general-development/get-started-with-workflows-in-sharepoint.md @@ -1,12 +1,12 @@ --- title: Get started with workflows in SharePoint -ms.date: 09/25/2017 +description: Describes how to get started with workflows in SharePoint and provides steps for creating a workflow using Visual Studio. +ms.date: 06/09/2022 keywords: vs.sharepointtools.workflow4.workflowlist,VS.SharePointTools.Workflow4.WorkflowName f1_keywords: - vs.sharepointtools.workflow4.workflowlist,VS.SharePointTools.Workflow4.WorkflowName -ms.prod: sharepoint ms.assetid: a2643cd7-474d-4e4c-85bb-00f0b6685a1d -localization_priority: Priority +ms.localizationpriority: high --- @@ -16,6 +16,7 @@ Learn about the newly engineered Workflow Manager Client 1.0, which provides the > For instructions on setting up and configuring SharePoint and Microsoft Azure, see [Set up and configure SharePoint Workflow Manager](set-up-and-configure-sharepoint-workflow-manager.md). > [!NOTE] +> SharePoint 2013 workflow has been deprecated since April 2023 and will be turned off for new tenants as of April 2, 2024. It will be removed from existing tenants and will be fully retired as of April 2, 2026. If you’re using SharePoint 2013 workflow, we recommend migrating to Power Automate or other supported solutions. For more info, see [SharePoint 2013 workflow retirement in Microsoft 365](https://support.microsoft.com/office/4613d9cf-69aa-40f7-b6bf-6e7831c9691e). > SharePoint 2010 workflows have been retired since August 1, 2020 for new tenants and removed from existing tenants on November 1, 2020. If you’re using SharePoint 2010 workflows, we recommend migrating to Power Automate or other supported solutions. For more info, see [SharePoint 2010 workflow retirement](https://support.microsoft.com/office/sharepoint-2010-workflow-retirement-1ca3fff8-9985-410a-85aa-8120f626965f). diff --git a/docs/general-development/getting-familiar-with-visual-designer-for-workflow-in-sharepoint-designer.md b/docs/general-development/getting-familiar-with-visual-designer-for-workflow-in-sharepoint-designer.md index 757f85bc9..eb5bd2f49 100644 --- a/docs/general-development/getting-familiar-with-visual-designer-for-workflow-in-sharepoint-designer.md +++ b/docs/general-development/getting-familiar-with-visual-designer-for-workflow-in-sharepoint-designer.md @@ -1,9 +1,9 @@ --- title: Getting familiar with Visual Designer for workflow in SharePoint Designer 2013 -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes the basic features of the Visual Designer in SharePoint Designer 2013 and provides guidance for using the Visual Designer in SharePoint. +ms.date: 06/09/2022 ms.assetid: ff9b0314-eea1-47e4-87c7-53ed4de98c30 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/getting-ranges-using-atom-feed-and-html-fragment.md b/docs/general-development/getting-ranges-using-atom-feed-and-html-fragment.md index e1e168419..138b17b3f 100644 --- a/docs/general-development/getting-ranges-using-atom-feed-and-html-fragment.md +++ b/docs/general-development/getting-ranges-using-atom-feed-and-html-fragment.md @@ -1,9 +1,9 @@ --- title: Getting Ranges Using Atom Feed and HTML Fragment -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes the Atom feed method and the HTML fragment method to access ranges by using the REST API in Excel Services. +ms.date: 06/09/2022 ms.assetid: 45d4ef08-02d6-48dd-b0ef-a748db1a0c6a -localization_priority: Normal +ms.localizationpriority: medium --- @@ -48,7 +48,7 @@ Therefore, for a workbook with the file name **sampleWorkbook.xlsx** that is sav http:///_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model ``` -Using the discovery mechanism described in [Discovery in Excel Services REST API](discovery-in-excel-services-rest-api.md), if you click on the **Ranges** Atom feed on the model page on the server, ( `http://` __ `/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model`), it displays a page that shows all the named ranges in the workbook. The sampleWorkbook.xlsx contains one named range, **SampleNamedRange**, as shown in the following screen shot: +Using the discovery mechanism described in [Discovery in Excel Services REST API](discovery-in-excel-services-rest-api.md), if you click on the **Ranges** Atom feed on the model page on the server, ( `http://` _\_ `/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model`), it displays a page that shows all the named ranges in the workbook. The sampleWorkbook.xlsx contains one named range, **SampleNamedRange**, as shown in the following screen shot: @@ -184,19 +184,19 @@ The feed item contains XML that represents the data inside the range. Following -- **** The range element. Represents the container of the returned range. +- **\** The range element. Represents the container of the returned range. -- **** The row element. Represents each row in the range. +- **\** The row element. Represents each row in the range. -- **** The cell element. Represents each cell in a row. +- **\** The cell element. Represents each cell in a row. -- **** The formatted value element. Represents the value as it is formatted by Excel. If the value is of type string in the workbook, the formatted value element is the only element under ****. +- **\** The formatted value element. Represents the value as it is formatted by Excel. If the value is of type string in the workbook, the formatted value element is the only element under **\**. -- **** The value element. Represents a number value. If the value in the cell is a number instead of a string, the value element contains that information. +- **\** The value element. Represents a number value. If the value in the cell is a number instead of a string, the value element contains that information. Using XML gives you an easier way to get data out of an Excel range so that you can use it in your application. diff --git a/docs/general-development/getting-started-with-excel-services.md b/docs/general-development/getting-started-with-excel-services.md index 6ae8ae47a..cc622475f 100644 --- a/docs/general-development/getting-started-with-excel-services.md +++ b/docs/general-development/getting-started-with-excel-services.md @@ -1,9 +1,9 @@ --- title: Getting Started with Excel Services -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides an overview of Excel Services and its architecture, and provides links to Excel Service articles and reference topics. +ms.date: 06/09/2022 ms.assetid: 392e4734-5ca0-4647-8f6d-e671daa45a4d -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-access-an-external-data-source-from-a-udf.md b/docs/general-development/how-to-access-an-external-data-source-from-a-udf.md index a6d3067b0..93dfbf263 100644 --- a/docs/general-development/how-to-access-an-external-data-source-from-a-udf.md +++ b/docs/general-development/how-to-access-an-external-data-source-from-a-udf.md @@ -1,12 +1,12 @@ --- title: Access an external data source from a UDF +description: This example shows how to access an external database from a user-defined function (UDF). ms.date: 09/25/2017 keywords: how to,howdoi,howto,UDF f1_keywords: - how to,howdoi,howto,UDF -ms.prod: sharepoint ms.assetid: 7a1876da-aeb5-4017-8eb6-3fed47912f70 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -21,7 +21,7 @@ This example shows how to access an external database from a user-defined functi ## Example -```cs +```csharp using System; using System.Collections.Generic; @@ -185,7 +185,7 @@ End Namespace - [Frequently Asked Questions About Excel Services UDFs](frequently-asked-questions-about-excel-services-udfs.md) + [Frequently Asked Questions About Excel Services UDFs](frequently-asked-questions-about-excel-services-udfs.yml) diff --git a/docs/general-development/how-to-access-external-data-with-rest-in-sharepoint.md b/docs/general-development/how-to-access-external-data-with-rest-in-sharepoint.md index dda4d9fbd..5d9087c9d 100644 --- a/docs/general-development/how-to-access-external-data-with-rest-in-sharepoint.md +++ b/docs/general-development/how-to-access-external-data-with-rest-in-sharepoint.md @@ -1,193 +1,130 @@ --- title: Access external data by using REST in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to access external data from SharePoint by using REST URLs for BCS and provides an example that sets up an external list. +ms.date: 05/18/2023 ms.assetid: 0663cc8c-a736-434d-9858-6ce12ce7f748 -localization_priority: Priority +ms.localizationpriority: high --- - - # Access external data by using REST in SharePoint Learn how to access external data from SharePoint by using Representational State Transfer (REST) URLs for Business Connectivity Services (BCS). This article shows how to set up an external list that retrieves data from an Open Data protocol (OData) source. - - - - ## Prerequisites for accessing external data using REST - To access external data from SharePoint by using REST, you need the following: - - - - SharePoint - - - Visual Studio 2012 - - - Office Developer Tools for Visual Studio 2012 - - - A functioning SharePoint Add-ins development environment: Follow the instructions in [Set up a general development environment for SharePoint](set-up-a-general-development-environment-for-sharepoint.md). - - - Access to the public OData.org producers - - ### Core concepts to know when accessing external data with REST The SharePoint REST service provides a way to access external data using a specially constructed URL. To understand how it works and how to use it, see the following articles. - - - **Table 1. Core concepts for REST in SharePoint** - -|**Article title**|**Description**| -|:-----|:-----| -| [Use OData query operations in SharePoint REST requests](https://msdn.microsoft.com/library/d4b5c277-ed50-420c-8a9b-860342284b72%28Office.15%29.aspx)
|Learn how to use the SharePoint REST service, which provides a REST programming interface comparable to the existing client object model.
| -| [Get to know the SharePoint REST service](https://msdn.microsoft.com/library/2de035a0-ac75-43bd-9665-5c5a59c4c590%28Office.15%29.aspx)
|Get the basics of using the SharePoint REST service to access and update SharePoint data, using the REST and OData web protocol standards.
| -| [Complete basic operations using SharePoint REST endpoints](https://docs.microsoft.com/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints)
|Learn how to navigate the SharePoint data structure as it is represented in the REST service, perform common CRUD (create, read, update, and delete) operations on SharePoint items via the REST service, synchronize SharePoint items across applications, and control item concurrency.
| - +| **Article title** | **Description** | +| :---------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Use OData query operations in SharePoint REST requests](https://msdn.microsoft.com/library/d4b5c277-ed50-420c-8a9b-860342284b72%28Office.15%29.aspx) | Learn how to use the SharePoint REST service, which provides a REST programming interface comparable to the existing client object model. | +| [Get to know the SharePoint REST service](https://msdn.microsoft.com/library/2de035a0-ac75-43bd-9665-5c5a59c4c590%28Office.15%29.aspx) | Get the basics of using the SharePoint REST service to access and update SharePoint data, using the REST and OData web protocol standards. | +| [Complete basic operations using SharePoint REST endpoints](/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints) | Learn how to navigate the SharePoint data structure as it is represented in the REST service, perform common CRUD (create, read, update, and delete) operations on SharePoint items via the REST service, synchronize SharePoint items across applications, and control item concurrency. | ## Create an SharePoint Add-in to access external data using REST - The following procedures guide you through setting up an SharePoint Add-in and configuring a webpage to make requests using REST functions to retrieve data from an external data source. - - - ### To create an SharePoint Add-in - 1. Open Visual Studio 2012 or later. - - -2. Create an **App for SharePoint** project. - - -3. Specify the app settings, including app name, the site URL for debugging the app, and how you want to host the app (Autohosted, Provider-hosted, SharePoint-hosted). For more information about hosting options, see [Choose patterns for developing and hosting your SharePoint Add-in](https://msdn.microsoft.com/library/05ce5435-0a03-4ddc-976b-c33b08d03457%28Office.15%29.aspx). - - -4. Choose **Finish** to create the app. - - +1. Create an **App for SharePoint** project. +1. Specify the app settings, including app name, the site URL for debugging the app, and how you want to host the app (Autohosted, Provider-hosted, SharePoint-hosted). For more information about hosting options, see [Choose patterns for developing and hosting your SharePoint Add-in](https://msdn.microsoft.com/library/05ce5435-0a03-4ddc-976b-c33b08d03457%28Office.15%29.aspx). +1. Choose **Finish** to create the app. ### To generate the external content type - 1. In **Solution Explorer**, open the shortcut menu for the project, and choose **Add**, **Content Types for External Data Source**. - - -2. In the **Specify OData Source** page, enter the URL of the OData service you want to connect to. In this case, use the Northwind OData source published at [http://www.odata.org/ecosystem](http://www.odata.org/ecosystem). Set the URL for the OData service to `http://services.odata.org/Northwind/Northwind.svc/`, and provide a name for the data source. - +1. In the **Specify OData Source** page, enter the URL of the OData service you want to connect to. In this case, use the Northwind OData source published at [https://www.odata.org/ecosystem](https://www.odata.org/ecosystem). Set the URL for the OData service to `http://services.odata.org/Northwind/Northwind.svc/`, and provide a name for the data source. + Choose **Next**. - - -3. This displays a list of data entities that are being exposed by the OData Service. Select the **Customers** entity. Ensure that the **Create list instances for the selected data entities (except Service Operations)** check box is selected. - - -4. Choose **Finish**. - - + +1. This displays a list of data entities that are being exposed by the OData Service. Select the **Customers** entity. Ensure that the **Create list instances for the selected data entities (except Service Operations)** check box is selected. +1. Choose **Finish**. ## Code example: Add scripts and HTML to the Home.aspx page - -At this point, you have an external content type and an external list that will display the data from the Northwind OData source. - - - +At this point, you have an external content type and an external list that will display the data from the Northwind OData source. + The next objective is to modify the default.aspx page that was created when you created your app. You will add a container to hold the results of the query that is executed with the page loads. By executing the scripts on the page load event, you ensure that the script is executed every time the page is browsed, and the resulting REST calls are made to the Northwind OData source to add records to the page. - - - ### To add the container to the Default.aspx page - 1. In **Solution Explorer**, open the Default.aspx page in the **Pages** module. - - -2. Add the following **div** element to the page. - -```HTML - -
-``` +1. Add the following **div** element to the page. + + ```html +
+ ``` + +1. Save the page. -3. Save the page. - - Finally, you add code to the App.js file that executes when the page loads. - - - ### To modify the App.js file to make REST calls +1. Open the **App.js** file in the Scripts module of your SharePoint project. +1. Paste the following code at the end of the file. -1. Open the App.js file in the Scripts module of your SharePoint project. - - -2. Paste the following code at the end of the file. - -``` - $(document).ready(function () { +```javascript +$(document).ready(function () { - // Namespace - window.AppLevelECT = window.AppLevelECT || {}; + // Namespace + window.AppLevelECT = window.AppLevelECT || {}; - // Constructor - AppLevelECT.Grid = function (hostElement, surlWeb) { - this.hostElement = hostElement; - if (surlWeb.length > 0 && surlWeb.substring(surlWeb.length - 1, surlWeb.length) != "/") - surlWeb += "/"; - this.surlWeb = surlWeb; - } + // Constructor + AppLevelECT.Grid = function (hostElement, surlWeb) { + this.hostElement = hostElement; + if (surlWeb.length > 0 && surlWeb.substring(surlWeb.length - 1, surlWeb.length) != "/") + surlWeb += "/"; + this.surlWeb = surlWeb; + } - // Prototype - AppLevelECT.Grid.prototype = { + // Prototype + AppLevelECT.Grid.prototype = { - init: function () { + init: function () { - $.ajax({ - url: this.surlWeb + "_api/lists/getbytitle('Customer')/items?$select=BdcIdentity,CustomerID,ContactName", - headers: { - "accept": "application/json", - "X-RequestDigest": $("#__REQUESTDIGEST").val() - }, - success: this.showItems - }); - }, + $.ajax({ + url: this.surlWeb + "_api/lists/getbytitle('Customer')/items?$select=BdcIdentity,CustomerID,ContactName", + headers: { + "accept": "application/json", + "X-RequestDigest": $("#__REQUESTDIGEST").val() + }, + success: this.showItems + }); + }, - showItems: function (data) { - var items = []; + showItems: function (data) { + var items = []; - items.push(""); - items.push(''); + items.push("
Customer IDCustomer Name
"); + items.push(''); - $.each(data.d.results, function (key, val) { - items.push(''); - }); + $.each(data.d.results, function (key, val) { + items.push(''); + }); - items.push("
Customer IDCustomer Name
' + - val.CustomerID + '' + - val.ContactName + '
' + + val.CustomerID + '' + + val.ContactName + '
"); + items.push(""); - $("#displayDiv").html(items.join('')); - } - } + $("#displayDiv").html(items.join('')); + } + } - ExecuteOrDelayUntilScriptLoaded(getCustomers, "sp.js"); + ExecuteOrDelayUntilScriptLoaded(getCustomers, "sp.js"); }); function getCustomers() { @@ -197,28 +134,11 @@ function getCustomers() { ``` Press F5 to deploy the app to SharePoint. Browse to the Default.aspx page in the app, and a list of customers appears on the page. - - - ## See also - - - -- [Business Connectivity Services in SharePoint](business-connectivity-services-in-sharepoint.md) - - -- [Get to know the SharePoint REST service](https://msdn.microsoft.com/library/2de035a0-ac75-43bd-9665-5c5a59c4c590%28Office.15%29.aspx) - - -- [Complete basic operations using SharePoint REST endpoints](https://docs.microsoft.com/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints) - - -- [Add-in-scoped external content types in SharePoint](add-in-scoped-external-content-types-in-sharepoint.md) - - -- [What's new in Business Connectivity Services in SharePoint](what-s-new-in-business-connectivity-services-in-sharepoint.md) - - - +- [Business Connectivity Services in SharePoint](business-connectivity-services-in-sharepoint.md) +- [Get to know the SharePoint REST service](https://msdn.microsoft.com/library/2de035a0-ac75-43bd-9665-5c5a59c4c590%28Office.15%29.aspx) +- [Complete basic operations using SharePoint REST endpoints](/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints) +- [Add-in-scoped external content types in SharePoint](add-in-scoped-external-content-types-in-sharepoint.md) +- [What's new in Business Connectivity Services in SharePoint](what-s-new-in-business-connectivity-services-in-sharepoint.md) diff --git a/docs/general-development/how-to-add-a-device-channel-panel-snippet-in-sharepoint.md b/docs/general-development/how-to-add-a-device-channel-panel-snippet-in-sharepoint.md index 164b254e0..6d119f6d0 100644 --- a/docs/general-development/how-to-add-a-device-channel-panel-snippet-in-sharepoint.md +++ b/docs/general-development/how-to-add-a-device-channel-panel-snippet-in-sharepoint.md @@ -1,156 +1,92 @@ --- title: Add a Device Channel Panel snippet in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to add a Device Channel Panel that can be added to a master page or page layout to control how content is rendered in created channels. +ms.date: 05/18/2023 ms.assetid: 612780a8-6267-49f6-a32d-33600bb5f6b4 -localization_priority: Normal +ms.localizationpriority: medium --- - # Add a Device Channel Panel snippet in SharePoint A Device Channel Panel is a snippet that you can add to a master page or page layout to control what content is rendered for each channel that you create. The primary purpose of a Device Channel Panel is to selectively display different page fields on different channels from a single page layout. ## Introduction to the Device Channel Panel snippet - A Device Channel Panel is a control that you can add to a master page or page layout to control what content is rendered in each channel that you create. A Device Channel Panel is a container that specifies one or more channels; if one or more of those channels are active when the page is rendered, all of the contents of the Device Channel Panel are also rendered. A Device Channel Panel can include almost any type of content, including a link to a CSS file or a .js file. It is an easy way to include specific content for specific channels. - - - + Perhaps the most common scenario for using Device Channel Panels is to selectively include parts of a page layout for specific channels. For example, you may have a page layout with separate text fields for a long greeting and a short greeting. By placing the page fields inside Device Channel Panels, you can display the short greeting only to phones and the long greeting only to the desktop. The content of a Device Channel Panel is not displayed on non-included channels—in fact, the content is not rendered at all, which prevents bytes from going across the wire. For this reason, using Device Channel Panels is a better way to display content on specific channels than using a CSS class with `Display:None` because Device Channel Panels help to reduce the page weight for a specific channel. - - - + You can also use Device Channel Panels on master pages. For example, if you have a master page that can accommodate two different devices (or two different browsers) with only minimal changes, you can use Device Channel Panels to hold the content on the master page that is specific to either of those devices. - - - + There are two limitations to using a Device Channel Panel: - - - - **Display templates** Because display templates are rendered on the client side and Device Channel Panels run on the server side, you cannot use a Device Channel Panel within a display template. Instead, you should use two different Content Search web parts within Device Channel Panels on your page layout, or use the JavaScript variable to trigger the behavior you want within the display template itself. - - - **Web part zones** You cannot insert a web part zone inside a Device Channel Panel. If you want to allow authors to add web parts to a page, and if you are not concerned about the page weight for mobile devices, you can add a Rich Text Editor page field to a Device Channel Panel, and then instruct authors to add web parts there. You can add web parts directly to a Device Channel Panel (without a web part zone). - - ## Inserting a Device Channel Panel snippet - Like all snippets, you add a Device Channel Panel snippet from the Snippet Gallery. To navigate to the Snippet Gallery, you must first select a master page or page layout to edit. - - - - ### To insert a Device Channel Panel snippet - 1. Browse to your publishing site. - - -2. In the upper-right corner of the page, choose the Settings gear, and then choose **Design Manager**. - - -3. In Design Manager, in the left navigation pane, choose **Edit Master Pages** or **Edit Page Layouts**, depending on what type of file you're editing. - - -4. Select the name of the master page or page layout that you want to add the snippet to. - - -5. To open the Snippet Gallery, choose **Snippets** in the upper-right corner of the server-side preview. - - -6. On the ribbon, on the **Design** tab, choose **Device Channel Panel**. - - -7. On the right side of the Snippet Gallery, under **About this Component**, click or select section headers to expand or collapse groups of properties, and then configure any custom settings that you want. - +1. In the upper-right corner of the page, choose the Settings gear, and then choose **Design Manager**. +1. In Design Manager, in the left navigation pane, choose **Edit Master Pages** or **Edit Page Layouts**, depending on what type of file you're editing. +1. Select the name of the master page or page layout that you want to add the snippet to. +1. To open the Snippet Gallery, choose **Snippets** in the upper-right corner of the server-side preview. +1. On the ribbon, on the **Design** tab, choose **Device Channel Panel**. +1. On the right side of the Snippet Gallery, under **About this Component**, click or select section headers to expand or collapse groups of properties, and then configure any custom settings that you want. + The section named **Important** contains the properties that are key to how this particular snippet works. For a Device Channel Panel, the **IncludedChannels** property is the most important. For this property, enter the alias of each Device Channel that you want to display the content contained in this Device Channel Panel. If you enter more than one alias, separate each with a comma. - + > [!NOTE] > If you edit the alias of a channel in the Device Channels list, you must manually find and update that alias wherever it appears in your design files, including updating the **IncludedChannels** property for every Device Channel Panel that uses that alias. -8. After you configure any other properties, choose **Update**. This updates the HTML snippet on the left side of the page, so that the markup reflects your custom settings. You can always choose **Reset** to return all properties to their default settings. - - -9. On the left side of the Snippet Gallery, under **HTML Snippet**, choose **Copy to Clipboard**. - - -10. In your HTML editor, open the mapped network drive on your computer, and then open the HTML file for the master page or page layout that you're adding the snippet to. - +1. After you configure any other properties, choose **Update**. This updates the HTML snippet on the left side of the page, so that the markup reflects your custom settings. You can always choose **Reset** to return all properties to their default settings. +1. On the left side of the Snippet Gallery, under **HTML Snippet**, choose **Copy to Clipboard**. +1. In your HTML editor, open the mapped network drive on your computer, and then open the HTML file for the master page or page layout that you're adding the snippet to. + For more information, see [How to: Map a network drive to the SharePoint Master Page Gallery](how-to-map-a-network-drive-to-the-sharepoint-master-page-gallery.md). - - -11. In the HTML file, paste the snippet where you want the markup to appear. - + +1. In the HTML file, paste the snippet where you want the markup to appear. + If you are adding the snippet to a page layout, make sure to paste the snippet inside **PlaceHolderMain**. - - -12. Replace the **
** where `class="DefaultContentBlock"` with your own specific content. - - Typically, if you're adding a Device Channel Panel to a page layout, you replace the **
** by copying page fields inside the panel. - - -13. Save the page, and then refresh the server-side preview in Design Manager to make sure the Device Channel Panel appears as expected. - + +1. Replace the `
` where `class="DefaultContentBlock"` with your own specific content. + + Typically, if you're adding a Device Channel Panel to a page layout, you replace the `
` by copying page fields inside the panel. + +1. Save the page, and then refresh the server-side preview in Design Manager to make sure the Device Channel Panel appears as expected. + To preview the panel on different channels, you can add query string parameters to the URL. For example, you can append the query string variable `"DeviceChannel=YourChannelAlias"` to the URL of any page in the server-side preview. - - ## Understanding the snippet markup - -The two most important parts of a Device Channel Panel snippet are the **IncludedChannels** property and the **
** where `class="DefaultContentBlock"`. By default, the **IncludedChannels** property is empty. In the **Important** section of the property grid, you should enter the aliases, separated by commas, of the device channels that you want to display the content in this panel. - +The two most important parts of a Device Channel Panel snippet are the **IncludedChannels** property and the `
` where `class="DefaultContentBlock"`. By default, the **IncludedChannels** property is empty. In the **Important** section of the property grid, you should enter the aliases, separated by commas, of the device channels that you want to display the content in this panel. + > [!NOTE] > If you change an alias in the Device Channels list, you must also change that alias wherever it appears in your markup, including in the **IncludedChannels** property for every Device Channel Panel that uses that alias. - - - - -The **
** where `class="DefaultContentBlock"` should be replaced with whatever specific content you want to display for the included channels. A Device Channel Panel can include almost any type of content, including a link to a CSS file or a .js file. The most common scenario for using Device Channel Panels is to include specific page fields from a page layout for specific channels. In this case, you copy the page field markup where the **
** is positioned inside the Device Channel Panel. - - - +The `
` where `class="DefaultContentBlock"` should be replaced with whatever specific content you want to display for the included channels. A Device Channel Panel can include almost any type of content, including a link to a CSS file or a .js file. The most common scenario for using Device Channel Panels is to include specific page fields from a page layout for specific channels. In this case, you copy the page field markup where the `
` is positioned inside the Device Channel Panel. ```HTML -
- You should replace this div with content that renders based on your Device Channel Panel Properties. + You should replace this div with content that renders based on your Device Channel Panel Properties.
- ``` - ## See also - - - -- [SharePoint Design Manager snippets](sharepoint-design-manager-snippets.md) - - -- [SharePoint Design Manager device channels](sharepoint-design-manager-device-channels.md) - - -- [Build sites for SharePoint](build-sites-for-sharepoint.md) - - -- [Develop the site design in SharePoint](develop-the-site-design-in-sharepoint.md) - - +- [SharePoint Design Manager snippets](sharepoint-design-manager-snippets.md) +- [SharePoint Design Manager device channels](sharepoint-design-manager-device-channels.md) +- [Build sites for SharePoint](build-sites-for-sharepoint.md) +- [Develop the site design in SharePoint](develop-the-site-design-in-sharepoint.md) diff --git a/docs/general-development/how-to-add-a-geolocation-column-to-a-list-programmatically-in-sharepoint.md b/docs/general-development/how-to-add-a-geolocation-column-to-a-list-programmatically-in-sharepoint.md index 2d1fec003..29d293584 100644 --- a/docs/general-development/how-to-add-a-geolocation-column-to-a-list-programmatically-in-sharepoint.md +++ b/docs/general-development/how-to-add-a-geolocation-column-to-a-list-programmatically-in-sharepoint.md @@ -1,218 +1,160 @@ --- title: Add a Geolocation column to a list programmatically in SharePoint description: Learn how to programmatically add a Geolocation column to a list in SharePoint. Integrate location information and maps in SharePoint lists and location-based websites by using the new Geolocation field creating your own Geolocation-based field type. -ms.date: 02/17/2021 -ms.prod: sharepoint +ms.date: 01/06/2023 ms.assetid: f31a3594-c328-4731-b8eb-5da6b85103ad -localization_priority: Priority +ms.localizationpriority: high --- # Add a Geolocation column to a list programmatically in SharePoint Learn how to programmatically add a Geolocation column to a list in SharePoint. Integrate location information and maps in SharePoint lists and location-based websites by using the new Geolocation field creating your own Geolocation-based field type. -SharePoint introduces a new field type named Geolocation that enables you to annotate SharePoint lists with location information. In columns of type Geolocation, you can enter location information as a pair of latitude and longitude coordinates in decimal degrees or retrieve the coordinates of the user's current location from the browser if it implements the W3C Geolocation API. For more information about the Geolocation column, see [Integrating location and map functionality in SharePoint](integrating-location-and-map-functionality-in-sharepoint.md). The Geolocation column is not available by default in SharePoint lists. To add the column to a SharePoint list, you have to write code. In this article, learn how to add the Geolocation field to a list programmatically by using the SharePoint client object model. - - - +SharePoint introduces a new field type named Geolocation that enables you to annotate SharePoint lists with location information. In columns of type Geolocation, you can enter location information as a pair of latitude and longitude coordinates in decimal degrees or retrieve the coordinates of the user's current location from the browser if it implements the W3C Geolocation API. For more information about the Geolocation column, see [Integrating location and map functionality in SharePoint](integrating-location-and-map-functionality-in-sharepoint.md). The Geolocation column isn't available by default in SharePoint lists. To add the column to a SharePoint list, you have to write code. In this article, learn how to add the Geolocation field to a list programmatically by using the SharePoint client object model. + +An MSI package named SQLSysClrTypes.msi must be installed on every SharePoint front-end web server to view the geolocation field value or data in a list. This package installs components that implement the new geometry, geography, and hierarchy ID types in SQL Server 2008. By default, this file is installed for SharePoint Online. However, it isn't for an on-premises deployment of SharePoint. You must be a member of the Farm Administrators group to perform this operation. To download SQLSysClrTypes.msi, see [Microsoft SQL Server 2008 R2 SP1 Feature Pack](https://www.microsoft.com/download/details.aspx?id=30437) for SQL Server 2008, or [Microsoft SQL Server 2012 Feature Pack](https://www.microsoft.com/download/details.aspx?id=29065)for SQL Server 2012 in the Microsoft Download Center. -An MSI package named SQLSysClrTypes.msi must be installed on every SharePoint front-end web server to view the geolocation field value or data in a list. This package installs components that implement the new geometry, geography, and hierarchy ID types in SQL Server 2008. By default, this file is installed for SharePoint Online. However, it is not for an on-premises deployment of SharePoint. You must be a member of the Farm Administrators group to perform this operation. To download SQLSysClrTypes.msi, see [Microsoft SQL Server 2008 R2 SP1 Feature Pack](https://www.microsoft.com/download/details.aspx?id=26728) for SQL Server 2008, or [Microsoft SQL Server 2012 Feature Pack](https://www.microsoft.com/download/details.aspx?id=29065)for SQL Server 2012 in the Microsoft Download Center. ## Prerequisites for adding a Geolocation column - +- Access to a SharePoint list, with sufficient privileges to add a column. +- A valid Bing Maps key set at the farm or web level, which can be obtained from the [Bing Maps Account Center](https://www.bingmapsportal.com/). + + > [!IMPORTANT] + > Please note that you are responsible for compliance with terms and conditions applicable to your use of the Bing Maps key, and any necessary disclosures to users of your application regarding data passed to the Bing Maps service. - - - +- Visual Studio 2010 +- SharePoint Online Management Shell: https://www.microsoft.com/download/details.aspx?id=35588 +- SharePoint PnP-PowerShell (legacy): https://github.com/SharePoint/PnP-PowerShell/ +- SharePoint PnP.PowerShell (latest): https://github.com/pnp/powershell -- Access to a SharePoint list, with sufficient privileges to add a column. - - -- A valid Bing Maps key set at the farm or web level, which can be obtained from the [Bing Maps Account Center](https://www.bingmapsportal.com/). - - > **Important:** - > Please note that you are responsible for compliance with terms and conditions applicable to your use of the Bing Maps key, and any necessary disclosures to users of your application regarding data passed to the Bing Maps service. -- Visual Studio 2010. -- SharePoint Online Management Shell - https://www.microsoft.com/download/details.aspx?id=35588 -- SharePoint PnP-PowerShell (legacy) - https://github.com/SharePoint/PnP-PowerShell/ -- SharePoint PnP.PowerShell (latest) - https://github.com/pnp/powershell - [!INCLUDE [pnp-powershell](../../includes/snippets/open-source/pnp-powershell.md)] ## Code example: Add a Geolocation column to an existing list programmatically - Follow these steps to add the Geolocation column to a list. This must be done programmatically with CSOM or PowerShell - + ### To add the Geolocation column to a list using PnP PowerShell -1. Open the SharePoint Online Management Shell -2. Connect to the site you wish to add the column to -```cs -Connect-PnPOnline -url "https://TENANT.sharepoint.com/sites/SITEURL" -``` -3. Open the list you wish to add the column to -```cs -$list = Get-PnPList -Identity "LISTNAME" -``` -4. #Add the Geolocation field - Change parameters as necessary -```cs -Add-PnPField -List $list -Type GeoLocation -DisplayName "GeoLocationField" -InternalName "GeoLocationField" -AddToDefaultView -Required -``` - - - -### To add the Geolocation column to a list using the client object model in Visual Studio +1. Open PowerShell +1. Connect to the site you wish to add the column to + + ```powershell + Connect-PnPOnline -url "https://TENANT.sharepoint.com/sites/SITEURL" + ``` +1. Open the list you wish to add the column to + + ```powershell + $list = Get-PnPList -Identity "LISTNAME" + ``` + +1. #Add the Geolocation field - Change parameters as necessary + + ```powershell + Add-PnPField -List $list -Type GeoLocation -DisplayName "GeoLocationField" -InternalName "GeoLocationField" -AddToDefaultView -Required + ``` + +### To add the Geolocation column to a list using the client object model in Visual Studio 1. Start Visual Studio. - - -2. On the menu bar, choose **File, New Project**. The **New Project** dialog box opens. - - -3. In the **New Project** dialog box, choose **C#** in the **Installed Templates** box, and then choose the **Console Application** template. - - -4. Give the project a name, and then choose the **OK** button. - - -5. Visual Studio creates the project. Add a reference to the following assemblies, and choose **OK**. - - Microsoft.SharePoint.Client.dll - - Microsoft.SharePoint.Client.Runtime.dll - - -6. In the default .cs file, add a **using** directive as follows. - - `using Microsoft.SharePoint.Client;` - - -7. Add the following code to the **Main** method in the .cs file. - -```cs - -class Program +1. On the menu bar, choose **File, New Project**. The **New Project** dialog box opens. +1. In the **New Project** dialog box, choose **C#** in the **Installed Templates** box, and then choose the **Console Application** template. +1. Give the project a name, and then choose the **OK** button. +1. Visual Studio creates the project. Add a reference to the following assemblies, and choose **OK**. + + - Microsoft.SharePoint.Client.dll + - Microsoft.SharePoint.Client.Runtime.dll + +1. In the default .cs file, add a **using** directive as follows. + + ```csharp + using Microsoft.SharePoint.Client; + ``` + +1. Add the following code to the **Main** method in the .cs file. + + ```csharp + class Program { - static void Main(string[] args) - { - AddGeolocationField(); - Console.WriteLine("Location field added successfully"); - } - private static void AddGeolocationField() - { - // Replace site URL and List Title with Valid values. - ClientContext context = new ClientContext(""); - List oList = context.Web.Lists.GetByTitle(""); - oList.Fields.AddFieldAsXml("",true, AddFieldOptions.AddToAllContentTypes); - oList.Update(); - context.ExecuteQuery(); - } + static void Main(string[] args) + { + AddGeolocationField(); + Console.WriteLine("Location field added successfully"); + } + private static void AddGeolocationField() + { + // Replace site URL and List Title with Valid values. + ClientContext context = new ClientContext(""); + List oList = context.Web.Lists.GetByTitle(""); + oList.Fields.AddFieldAsXml("",true, AddFieldOptions.AddToAllContentTypes); + oList.Update(); + context.ExecuteQuery(); + } } -``` - -8. Replace \ and \ with valid values. - - -9. Set the target framework in Project Properties as .NET Framework 4.0 or 3.5, and run the example. - - -10. Navigate to the list. You should be able to see a column named **Location** of type Geolocation in the list. You can now enter some values and see it in action. Figure 1 shows the default location and map features that you can expect to see in your list. - - **Figure 1. Summarized view of the default location and map features** + ``` - +1. Replace `` and `` with valid values. +1. Set the target framework in Project Properties as .NET Framework 4.0 or 3.5, and run the example. +1. Navigate to the list. You should be able to see a column named **Location** of type Geolocation in the list. You can now enter some values and see it in action. Figure 1 shows the default location and map features that you can expect to see in your list. + **Figure 1. Summarized view of the default location and map features** ![Default Geolocation and Map feature](../images/SP15Con_HowToAddGeolocationColumnUpdated_Fig1.png) - - - - - ## Add a list item with the Geolocation field value to a SharePoint list programmatically - After the Geolocation field is added to a SharePoint list, the developer can add the list item to the list programmatically. There are two ways to add the list item programmatically: by passing the **FieldGeolocationValue** object to the Geolocation field, and by passing **Raw Value** to the Geolocation field. - - - ### Method A: Pass the FieldGeolocationValue object to the Geolocation field - - The following method adds a list item by passing the Geolocation value as an object. - -```cs - -private void AddListItem() - { // Replace site URL and List Title with Valid values. - ClientContext context = new ClientContext(""); - List oList = context.Web.Lists.GetByTitle(""); - - ListItemCreationInformation itemCreationInfo = new ListItemCreationInformation(); - ListItem oListItem = oList.AddItem(itemCreationInfo); - oListItem["Title"] = "New Title"; + ```csharp + private void AddListItem() { + // Replace site URL and List Title with Valid values. + ClientContext context = new ClientContext(""); + List oList = context.Web.Lists.GetByTitle(""); - FieldGeolocationValue oGeolocationValue = new FieldGeolocationValue(); - oGeolocationValue.Latitude = (double)17.4; - oGeolocationValue.Longitude = (double)78.4; - oListItem["location"] = oGeolocationValue; + ListItemCreationInformation itemCreationInfo = new ListItemCreationInformation(); + ListItem oListItem = oList.AddItem(itemCreationInfo); - oListItem.Update(); - context.ExecuteQuery(); - } + oListItem["Title"] = "New Title"; -``` + FieldGeolocationValue oGeolocationValue = new FieldGeolocationValue(); + oGeolocationValue.Latitude = (double)17.4; + oGeolocationValue.Longitude = (double)78.4; + oListItem["location"] = oGeolocationValue; + oListItem.Update(); + context.ExecuteQuery(); + } + ``` ### Method B: Pass a raw value to the Geolocation field - - The following method adds a list item to the SharePoint list by passing raw values to the Geolocation field. - -```cs - -private void AddListItem() - { // Replace site URL and List Title with Valid values. - ClientContext context = new ClientContext(""); - List oList = context.Web.Lists.GetByTitle(""); - - ListItemCreationInformation itemCreationInfo = new ListItemCreationInformation(); - ListItem oListItem = oList.AddItem(itemCreationInfo); - oListItem["Title"] = "New Title"; - // Data in WKT (World Known Text) format. - oListItem["location"] = "POINT (78.4 17.4)" ; + ```csharp + private void AddListItem() { + // Replace site URL and List Title with Valid values. + ClientContext context = new ClientContext(""); + List oList = context.Web.Lists.GetByTitle(""); - oListItem.Update(); - context.ExecuteQuery(); - } + ListItemCreationInformation itemCreationInfo = new ListItemCreationInformation(); + ListItem oListItem = oList.AddItem(itemCreationInfo); -``` + oListItem["Title"] = "New Title"; + // Data in WKT (World Known Text) format. + oListItem["location"] = "POINT (78.4 17.4)" ; + oListItem.Update(); + context.ExecuteQuery(); + } + ``` ## See also - - - -- [Integrating location and map functionality in SharePoint](integrating-location-and-map-functionality-in-sharepoint.md) - - -- [How to: Set the Bing Maps key at the web and farm level in SharePoint](how-to-set-the-bing-maps-key-at-the-web-and-farm-level-in-sharepoint.md) - - -- [How to: Extend the Geolocation field type using client-side rendering](how-to-extend-the-geolocation-field-type-using-client-side-rendering.md) - - -- [Create a map view for the Geolocation field in SharePoint](create-a-map-view-for-the-geolocation-field-in-sharepoint.md) - - -- [How to: Integrate maps with Windows Phone apps and SharePoint lists](how-to-integrate-maps-with-windows-phone-apps-and-sharepoint-lists.md) - - -- [Use the SharePoint location field type in mobile applications](https://technet.microsoft.com/library/fp161355%28v=office.15%29.aspx) - - +- [Integrating location and map functionality in SharePoint](integrating-location-and-map-functionality-in-sharepoint.md) +- [How to: Set the Bing Maps key at the web and farm level in SharePoint](how-to-set-the-bing-maps-key-at-the-web-and-farm-level-in-sharepoint.md) +- [How to: Extend the Geolocation field type using client-side rendering](how-to-extend-the-geolocation-field-type-using-client-side-rendering.md) +- [Create a map view for the Geolocation field in SharePoint](create-a-map-view-for-the-geolocation-field-in-sharepoint.md) +- [How to: Integrate maps with Windows Phone apps and SharePoint lists](how-to-integrate-maps-with-windows-phone-apps-and-sharepoint-lists.md) +- [Use the SharePoint location field type in mobile applications](https://technet.microsoft.com/library/fp161355%28v=office.15%29.aspx) diff --git a/docs/general-development/how-to-add-a-security-trim-snippet-in-sharepoint.md b/docs/general-development/how-to-add-a-security-trim-snippet-in-sharepoint.md index 175bc66fe..6fde84dc3 100644 --- a/docs/general-development/how-to-add-a-security-trim-snippet-in-sharepoint.md +++ b/docs/general-development/how-to-add-a-security-trim-snippet-in-sharepoint.md @@ -1,152 +1,87 @@ --- title: Add a Security Trim snippet in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to add a Security Trim snippet in SharePoint to display content only to specific and authenticated users. +ms.date: 05/18/2023 ms.assetid: 4beaab08-760b-408a-b768-906312779379 -localization_priority: Priority +ms.localizationpriority: high --- - # Add a Security Trim snippet in SharePoint You can use a Security Trim snippet to display content only to specific users, based on a specific permission that those users must have and whether the users are authenticated or anonymous. ## Introduction to the Security Trim snippet - You can use a Security Trim snippet to display content only to specific users, based on a specific permission that those users must have, and whether those users are authenticated or anonymous. You can add a Security Trim panel to a master page or page layout. A Security Trim panel is a container that can include other components or snippets, such as web parts, in addition to static content. - - - + For example, you can use a Security Trim panel to display the following content to specific users: - - - - A Content by Search web part that displays which documents an authenticated user is currently working on. - - - A list view of recently modified documents so that authenticated users can see what's new on the site. - - - A Content by Search web part that displays to non-authenticated visitors a list of recommended links based on the current article. Such a list of recommendations might be noise to authenticated content authors working in the site, but it's important for non-authenticated visitors. - - - A sign-in link separate from the ribbon, for non-authenticated users or users who have yet to be authenticated. - + > [!NOTE] - > This sign-in link is inserted automatically into a master page that is created by using Design Manager, but you can delete it if it's not needed. + > This sign-in link is inserted automatically into a master page that is created by using Design Manager, but you can delete it if it's not needed. A Security Trim panel has two important property settings, one for authentication and one for permissions (or authorization). For example, you can use a Security Trim panel to display the following content to specific users: - - - - **AuthenticationRestrictions** With this property, you can restrict the panel to either authenticated or anonymous users, or choose all users (all users is the default setting). - - - **Permissions** With this property, you can select a specific permission that users must have to view the content in the panel. - + > [!NOTE] - > You are selecting an individual permission, not a permission level. (A permission level is a set of granted permissions.) + > You are selecting an individual permission, not a permission level. (A permission level is a set of granted permissions.) + Of course, if you restrict the authentication to only anonymous users, it's typically not necessary to specify a specific permission because anonymous users have usually not been given any SharePoint permissions. It makes sense to use permissions only with all users or with all authenticated users. - - - -The Security Trim panel has three options on the ribbon, listed in the left column of Table 1. Table 1 shows how these settings determine the specific permission that users are required to have, the lowest default permission level that includes that specific permission, and the group that is linked to that permission level by default.) - + +The Security Trim panel has three options on the ribbon, listed in the left column of Table 1. Table 1 shows how these settings determine the specific permission that users are required to have, the lowest default permission level that includes that specific permission, and the group that is linked to that permission level by default. + > [!NOTE] -> These are the default settings, which can be changed for any given scope, such as a site collection, site, list, or item. - - - +> These are the default settings, which can be changed for any given scope, such as a site collection, site, list, or item. For example, if you set a Security Trim panel to **Show to authors**, by default content inside that panel is visible to users in the Members group and the Owners group. - - - **Table 1. Mapping of panel options to default permission levels and groups** - |**Security Trim panel option**|**Permissions property**|**Permission**|**Permission level**|**Group**| |:-----|:-----|:-----|:-----|:-----| -|Show to authors
|**AddAndCustomizePages**
|Add and Customize Pages
|Contribute (or higher)
|Members
| -|Show to Authenticated Users
|**ViewPages**
|View Pages
|Read (or higher)
|Visitors
| -|Show to Administrators
|**FullMask**
|Select All
|Full Control
|Owners
| - +|Show to authors |**AddAndCustomizePages** |Add and Customize Pages |Contribute (or higher) |Members | +|Show to Authenticated Users |**ViewPages** |View Pages |Read (or higher) |Visitors | +|Show to Administrators |**FullMask** |Select All |Full Control |Owners | ### Inserting a Security Trim panel - Like all snippets, you add the Security Trim snippet from the Snippet Gallery. To navigate to the Snippet Gallery, you must first select a master page or page layout to edit. - - - ### To insert a Security Trim panel - 1. Browse to your publishing site. - - -2. In the upper-right corner of the page, choose the Settings gear, and then choose **Design Manager**. - - -3. In Design Manager, in the left navigation pane, choose **Edit Master Pages** or **Edit Page Layouts**, depending on what type of file you're editing. - - -4. Select the name of the master page or page layout that you want to add the snippet to. - - -5. To open the Snippet Gallery, choose **Snippets** in the upper-right corner of the server-side preview. - - -6. On the ribbon, on the **Design** tab, choose **Security Trim**. - +1. In the upper-right corner of the page, choose the Settings gear, and then choose **Design Manager**. +1. In Design Manager, in the left navigation pane, choose **Edit Master Pages** or **Edit Page Layouts**, depending on what type of file you're editing. +1. Select the name of the master page or page layout that you want to add the snippet to. +1. To open the Snippet Gallery, choose **Snippets** in the upper-right corner of the server-side preview. +1. On the ribbon, on the **Design** tab, choose **Security Trim**. + Optionally, in the drop-down list on the **Security Trim** button, you can select the users to whom the panel content will be visible, or you can see more options by configuring the important property values for the panel. - - -7. On the right side of the Snippet Gallery, under **About this Component**, click or select section headers to expand or collapse groups of properties, and then configure any custom settings that you want. - - -8. After you configure any properties, choose **Update**. This updates the HTML snippet on the left side of the page, so that the markup reflects your custom settings. You can always choose **Reset** to return all properties to their default settings. - - -9. On the left side of the Snippet Gallery, under **HTML Snippet**, choose **Copy to Clipboard**. - - -10. In your HTML editor, open the mapped network drive on your computer, and then open the HTML file for the master page or page layout that you're adding the snippet to. - - -11. In the HTML file, paste the snippet where you want the markup to appear. - + +1. On the right side of the Snippet Gallery, under **About this Component**, click or select section headers to expand or collapse groups of properties, and then configure any custom settings that you want. +1. After you configure any properties, choose **Update**. This updates the HTML snippet on the left side of the page, so that the markup reflects your custom settings. You can always choose **Reset** to return all properties to their default settings. +1. On the left side of the Snippet Gallery, under **HTML Snippet**, choose **Copy to Clipboard**. +1. In your HTML editor, open the mapped network drive on your computer, and then open the HTML file for the master page or page layout that you're adding the snippet to. +1. In the HTML file, paste the snippet where you want the markup to appear. + If you are adding the snippet to a page layout, make sure to paste the snippet inside **PlaceHolderMain**. - - -12. Replace the **
** where `class="DefaultContentBlock"` with your own specific content. - - -13. Save the page, and then refresh the server-side preview in Design Manager to make sure the Security Trim panel appears as expected. - - -## Understanding the snippet markup - +1. Replace the `
` where `class="DefaultContentBlock"` with your own specific content. +1. Save the page, and then refresh the server-side preview in Design Manager to make sure the Security Trim panel appears as expected. -The most important parts of a Security Trim snippet are the **AuthenticationRestrictions** property and the **Permissions** property, and the **
** in bold below. **AuthenticationRestrictions** appears in the markup only when changed from **AllUsers**, which is the default. If you choose **Reset** for the snippet in the Snippet Gallery, **AuthenticationRestrictions** is removed from the markup, which means the snippet uses the default value, **AllUsers**. - - - -The **
** where `class="DefaultContentBlock"` is what you replace with your own content, which can include other snippets and controls. - - - +## Understanding the snippet markup +The most important parts of a Security Trim snippet are the **AuthenticationRestrictions** property and the **Permissions** property, and the `
` in bold below. **AuthenticationRestrictions** appears in the markup only when changed from **AllUsers**, which is the default. If you choose **Reset** for the snippet in the Snippet Gallery, **AuthenticationRestrictions** is removed from the markup, which means the snippet uses the default value, **AllUsers**. +The `
` where `class="DefaultContentBlock"` is what you replace with your own content, which can include other snippets and controls. ```HTML -
@@ -161,21 +96,9 @@ The **
** where `class="DefaultContentBlock"` is what you replace with your
``` - ## See also - - - -- [Understanding permission levels](https://support.office.com/article/understanding-permission-levels-in-sharepoint-87ecbb0e-6550-491a-8826-c075e4859848) - - -- [SharePoint Design Manager snippets](sharepoint-design-manager-snippets.md) - - -- [Build sites for SharePoint](build-sites-for-sharepoint.md) - - -- [Develop the site design in SharePoint](develop-the-site-design-in-sharepoint.md) - - +- [Understanding permission levels](https://support.office.com/article/understanding-permission-levels-in-sharepoint-87ecbb0e-6550-491a-8826-c075e4859848) +- [SharePoint Design Manager snippets](sharepoint-design-manager-snippets.md) +- [Build sites for SharePoint](build-sites-for-sharepoint.md) +- [Develop the site design in SharePoint](develop-the-site-design-in-sharepoint.md) diff --git a/docs/general-development/how-to-add-a-web-part-zone-snippet-in-sharepoint.md b/docs/general-development/how-to-add-a-web-part-zone-snippet-in-sharepoint.md index a31e53041..5390f1ed0 100644 --- a/docs/general-development/how-to-add-a-web-part-zone-snippet-in-sharepoint.md +++ b/docs/general-development/how-to-add-a-web-part-zone-snippet-in-sharepoint.md @@ -1,209 +1,116 @@ --- title: Add a web part zone snippet in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to add a web part zone snippet in SharePoint and provides a list of Web part zone properties used to restrict content authors. +ms.date: 05/18/2023 ms.assetid: 7583b217-200c-4569-8f88-fe975c8ebd72 -localization_priority: Priority +ms.localizationpriority: high --- - # Add a web part zone snippet in SharePoint -> [!IMPORTANT] +> [!IMPORTANT] > This extensibility option is **only** available for classic SharePoint experiences. You cannot use this option with modern experiences in SharePoint Online, like with communication sites. We do not recommend using classic experience or these branding techniques anymore. A web part zone is a snippet that you can add to a page layout so that content authors can add, edit, or delete web parts in that zone. ## Introduction to the web part zone snippet - A web part is a server control that provides a specific piece of SharePoint functionality, and a web part zone is a container that determines the layout, behavior, and other properties of the web parts contained in that zone. For example, a web part zone can specify whether the web parts in the zone: - - - -- Are arranged in a horizontal or vertical layout. - - +- Are arranged in a horizontal or vertical layout. - Display common user interface (UI) elements such as a title bar or border. - - - Can be customized by content authors when they edit a page in the browser. - - - Can be personalized by site visitors who create a personal view of a web part when they view a page in the browser. - - + In a publishing site, content authors with the necessary permissions can create or edit pages that reside in the Pages library. As a designer, you can add a web part zone to a page layout. When a content author creates or edits a page based on that page layout, the author can add, edit, or delete web parts in that zone. For example, you may want to add a web part zone to a page layout so that content authors can: - - - - Display the results of a search query by using a Content Search web part. Authors can update or modify the search query when a search-driven web part resides inside a web part zone. - - - Embed video or audio clips in a webpage by using a Media web part. - - - Create lists of hyperlinks that are easily edited, grouped, or reordered by using a Summary Link web part. - - - Create a site map that lists all pages in a site and that is automatically updated whenever a page is added, deleted, renamed, or moved by using a Table of Contents web part. - - ### When to use web part zones When a page layout includes one or more web part zones, the web part zones are available on all pages that use that layout, which enables authors to insert web parts onto those pages. If you enable authors to insert web parts on pages, you reduce your control over the users' experience of the site. For example, an author could insert a Table of Contents web part onto a page that exposes parts of your site that you don't want visitors to navigate to from the current page. - - - + If you want complete control over how a web part appears on your site, and if you want that web part to appear on all pages of a certain type, add the web part directly to a page layout. If you want a web part to appear on all pages in a site, you can also add a web part directly to a master page. - + > [!NOTE] -> Web part zones are available on page layouts but not on master pages—the purpose of zones is to allow authors to modify web parts, and authors typically don't edit a master page. - - - +> Web part zones are available on page layouts but not on master pages—the purpose of zones is to allow authors to modify web parts, and authors typically don't edit a master page. You can also add web part zones to a page layout but restrict their use. For example, you can add web parts to a zone, and then set a property of that zone so that content authors can edit the properties of existing web parts but not add or remove web parts from the zone. web part zones have a set of properties that serve a dual purpose. You can use one subset of properties to organize the layout and format of web parts on the page. You can use another subset of properties to provide an additional level of protection from modification (or "lock down") of the web parts within the zone. - - - + For varying levels of control over how web parts are presented on your site, you can: - - - - Add web parts directly to a master page or page layout. This means content authors cannot modify the web parts. - - - Add web parts to zones on page layouts, but restrict those zones to only the default web parts that you add. - - - Add web part zones to page layouts, and give content authors complete control over what web parts appear in those zones and how they are configured. - - + The properties of a web part zone can specify whether content authors are allowed to change: - - - - The layout of web parts in the zone by adding, deleting, resizing, or moving the web parts. - - - The web part settings for all users (the shared view of a web part). - - - Their personal web part settings (the personal view of a web part). - - + Table 1 shows important properties to consider when you want to restrict a web part zone. - - - **Table 1. Web part zone properties used to restrict content authors** - |**Property Name**|**Description**| |:-----|:-----| -|**AllowLayoutChange**
|Specifies whether web parts within the zone can be closed, minimized, deleted, or restored.
If set to **False**, users cannot close, minimize, delete, or restore web parts in the zone, drag web parts to a different zone, or rearrange or move web parts within the zone. Users also cannot add web parts from the web part catalog, and several properties that affect the UI of web parts in the zone are disabled. This property does not affect the ability to change the layout programmatically.
If set to **True**, users with appropriate permissions can perform these actions.
| -|**LockLayout**
|Specifies whether web parts within the zone can be added, deleted, resized, or moved. This property works the same whether the web part page is in personal view or shared view.
If set to **True**, the specific web part properties for each web part in the zone that are affected are: **Zone (ZoneID)**, **Part Order (PartOrder)**, **Visible on Page (IsVisible)**, **Height (Height)**, **Width (Width)**, **Allow Close (AllowRemove)**, and **IsIncluded** (the **Close** command on the **web part** menu). Other web part properties are not affected.
If set to **False**, the web part properties determine whether modifications can be made (together with the appropriate site permissions).
| -|**AllowCustomization**
|Specifies whether shared property values of web parts within the zone can be modified.
If set to **True**, users with appropriate permissions can make changes to the web parts in the zone for all users.
If set to **False**, users cannot make changes to the web parts in the zone in the UI in shared view. But, changes can still be made programmatically and by using the web part Maintenance page.
| -|**AllowPersonalization**
|Specifies whether personal property values of web parts within the zone can be modified.
If set to **True**, users with appropriate permissions can make personal changes to the web parts in the zone.
If set to **False**, users cannot make personal changes to the web parts through the UI, unless the web part is a private web part and they have appropriate permissions.
| - -> [!NOTE] -> You cannot insert a web part zone inside a Device Channel Panel. If you want to allow authors to add web parts to a page, and if you are not concerned about the page weight for mobile devices, you can add a Rich Text Editor page field to a Device Channel Panel, and then instruct authors to add web parts there. You can add web parts directly to a Device Channel Panel (without a web part zone). For more information, see [How to: Add a Device Channel Panel snippet in SharePoint](how-to-add-a-device-channel-panel-snippet-in-sharepoint.md). - - - +|**AllowLayoutChange** |Specifies whether web parts within the zone can be closed, minimized, deleted, or restored. If set to **False**, users cannot close, minimize, delete, or restore web parts in the zone, drag web parts to a different zone, or rearrange or move web parts within the zone. Users also cannot add web parts from the web part catalog, and several properties that affect the UI of web parts in the zone are disabled. This property does not affect the ability to change the layout programmatically. If set to **True**, users with appropriate permissions can perform these actions. | +|**LockLayout** |Specifies whether web parts within the zone can be added, deleted, resized, or moved. This property works the same whether the web part page is in personal view or shared view. If set to **True**, the specific web part properties for each web part in the zone that are affected are: **Zone (ZoneID)**, **Part Order (PartOrder)**, **Visible on Page (IsVisible)**, **Height (Height)**, **Width (Width)**, **Allow Close (AllowRemove)**, and **IsIncluded** (the **Close** command on the **web part** menu). Other web part properties are not affected. If set to **False**, the web part properties determine whether modifications can be made (together with the appropriate site permissions). | +|**AllowCustomization** |Specifies whether shared property values of web parts within the zone can be modified. If set to **True**, users with appropriate permissions can make changes to the web parts in the zone for all users. If set to **False**, users cannot make changes to the web parts in the zone in the UI in shared view. But, changes can still be made programmatically and by using the web part Maintenance page. | +|**AllowPersonalization** |Specifies whether personal property values of web parts within the zone can be modified. If set to **True**, users with appropriate permissions can make personal changes to the web parts in the zone. If set to **False**, users cannot make personal changes to the web parts through the UI, unless the web part is a private web part and they have appropriate permissions. | +> [!NOTE] +> You cannot insert a web part zone inside a Device Channel Panel. If you want to allow authors to add web parts to a page, and if you are not concerned about the page weight for mobile devices, you can add a Rich Text Editor page field to a Device Channel Panel, and then instruct authors to add web parts there. You can add web parts directly to a Device Channel Panel (without a web part zone). For more information, see [How to: Add a Device Channel Panel snippet in SharePoint](how-to-add-a-device-channel-panel-snippet-in-sharepoint.md). ## Inserting a web part zone snippet - Like all snippets, you add this snippet from the Snippet Gallery. To navigate to the Snippet Gallery, you must first select a page layout to edit. Web part zones can be added to page layouts but cannot be added to master pages. - - - ### To insert a web part zone snippet - 1. Browse to your publishing site. - - -2. In the upper-right corner of the page, choose the Settings gear, and then choose **Design Manager**. - - -3. In Design Manager, in the left navigation pane, choose **Edit Page Layouts**. - - -4. Select the name of the page layout that you want to add the snippet to. - - -5. To open the Snippet Gallery, choose **Snippets** in the upper-right corner of the server-side preview. - - -6. On the ribbon, on the **Design** tab, choose **web part zone**. - - -7. On the right side of the Snippet Gallery, under **About this Component**, click or select section headers to expand or collapse groups of properties, and then configure any custom settings that you want. - +1. In the upper-right corner of the page, choose the Settings gear, and then choose **Design Manager**. +1. In Design Manager, in the left navigation pane, choose **Edit Page Layouts**. +1. Select the name of the page layout that you want to add the snippet to. +1. To open the Snippet Gallery, choose **Snippets** in the upper-right corner of the server-side preview. +1. On the ribbon, on the **Design** tab, choose **web part zone**. +1. On the right side of the Snippet Gallery, under **About this Component**, click or select section headers to expand or collapse groups of properties, and then configure any custom settings that you want. + The section named **Important** contains the properties that are key to how this particular snippet works. For a web part zone, the snippet has a unique ID. After you copy the snippet into your page layout, you should not reuse this ID. If you want to add another web part zone snippet, choose **Refresh** to generate a new ID for the next snippet. - + For descriptions of properties that are necessary for restricting a web part zone ( **LockLayout**, **AllowCustomization**, and **AllowPersonalization**), see Table 1. - + > [!NOTE] - > You may notice that some property names are bold in the property grid of the Snippet Gallery. These properties have values that have been changed from the default setting for this component, but these properties are not necessarily relevant to a designer scenario. In other words, a property may be bold but not necessarily important for your scenario. - -8. After you configure any properties, choose **Update**. This updates the HTML snippet on the left side of the page, so that the markup reflects your custom settings. You can always choose **Reset** to return all properties to their default settings. - - -9. On the left side of the Snippet Gallery, under **HTML Snippet**, choose **Copy to Clipboard**. - - -10. In your HTML editor, open the mapped network drive on your computer, and then open the HTML file for the master page or page layout that you're adding the snippet to. - + > You may notice that some property names are bold in the property grid of the Snippet Gallery. These properties have values that have been changed from the default setting for this component, but these properties are not necessarily relevant to a designer scenario. In other words, a property may be bold but not necessarily important for your scenario. + +1. After you configure any properties, choose **Update**. This updates the HTML snippet on the left side of the page, so that the markup reflects your custom settings. You can always choose **Reset** to return all properties to their default settings. +1. On the left side of the Snippet Gallery, under **HTML Snippet**, choose **Copy to Clipboard**. +1. In your HTML editor, open the mapped network drive on your computer, and then open the HTML file for the master page or page layout that you're adding the snippet to. + For more information, see [How to: Map a network drive to the SharePoint Master Page Gallery](how-to-map-a-network-drive-to-the-sharepoint-master-page-gallery.md). - - -11. In the HTML file, paste the snippet where you want the markup to appear. - + +1. In the HTML file, paste the snippet where you want the markup to appear. + When you are adding the snippet to a page layout, make sure to paste the snippet inside **PlaceHolderMain**. - - -12. Replace the **
** where `class="DefaultContentBlock"` with your own specific content. - - -13. If you want to prepopulate the zone with web parts—for example, if the zone will restrict content authors to modifying only existing web parts and not adding new ones—insert web part snippets where the **** tag appears. - - -14. Save the page, and then refresh the server-side preview in Design Manager to make sure the page appears as expected. - - + +1. Replace the `
` where `class="DefaultContentBlock"` with your own specific content. +1. If you want to prepopulate the zone with web parts—for example, if the zone will restrict content authors to modifying only existing web parts and not adding new ones—insert web part snippets where the **** tag appears. +1. Save the page, and then refresh the server-side preview in Design Manager to make sure the page appears as expected. ## Understanding the snippet markup - The two most important parts of a web part zone snippet are the **ID** property and the **** comment. Each zone should have a unique ID. If you want to add more than one web part zone to your page layout, make sure to choose **Refresh** in the Snippet Gallery before copying each snippet so that a new ID is generated. The **** comment should be replaced with any web parts that you want to appear in the zone by default. - - - + Additional properties that can be used to restrict how content authors can use zones ( **AllowCustomization**, **AllowPersonalization**, and **LockLayout**) are shown in the following code. - + > [!NOTE] > The **AllowCustomization**, **AllowPersonalization**, and **LockLayout** properties appear in the markup only if you change their default values in the property grid. - - - - - - - -```HTML +```html
@@ -219,24 +126,10 @@ Additional properties that can be used to restrict how content authors can use z ``` - ## See also - - - -- [SharePoint Design Manager snippets](sharepoint-design-manager-snippets.md) - - -- [WebPartZone class](https://msdn.microsoft.com/library/system.web.ui.webcontrols.webparts.webpartzone.aspx) - - -- [WebPartZoneBase properties](https://msdn.microsoft.com/library/335sw9k3.aspx) - - -- [Build sites for SharePoint](build-sites-for-sharepoint.md) - - -- [Develop the site design in SharePoint](develop-the-site-design-in-sharepoint.md) - - +- [SharePoint Design Manager snippets](sharepoint-design-manager-snippets.md) +- [WebPartZone class](https://msdn.microsoft.com/library/system.web.ui.webcontrols.webparts.webpartzone.aspx) +- [WebPartZoneBase properties](https://msdn.microsoft.com/library/335sw9k3.aspx) +- [Build sites for SharePoint](build-sites-for-sharepoint.md) +- [Develop the site design in SharePoint](develop-the-site-design-in-sharepoint.md) diff --git a/docs/general-development/how-to-add-an-edit-mode-panel-snippet-in-sharepoint.md b/docs/general-development/how-to-add-an-edit-mode-panel-snippet-in-sharepoint.md index 0291727dc..c5ebadd63 100644 --- a/docs/general-development/how-to-add-an-edit-mode-panel-snippet-in-sharepoint.md +++ b/docs/general-development/how-to-add-an-edit-mode-panel-snippet-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Add an Edit Mode Panel snippet in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to add an Edit Mode Panel snippet in SharePoint to display instructions or other content to content authors. +ms.date: 06/09/2022 ms.assetid: 39fa1e32-9129-407d-914f-96f4c6e66dc8 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-apply-a-master-page-to-a-site-in-sharepoint.md b/docs/general-development/how-to-apply-a-master-page-to-a-site-in-sharepoint.md index 49e096bf6..ca1720117 100644 --- a/docs/general-development/how-to-apply-a-master-page-to-a-site-in-sharepoint.md +++ b/docs/general-development/how-to-apply-a-master-page-to-a-site-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Apply a master page to a site in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to apply a master page to a site in SharePoint and how to map a master page to a SharePoint site. +ms.date: 06/09/2022 ms.assetid: 04861390-84d5-40ea-b0db-6c0748eff196 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/how-to-apply-styles-to-page-fields-in-sharepoint.md b/docs/general-development/how-to-apply-styles-to-page-fields-in-sharepoint.md index 12ca69a73..084691223 100644 --- a/docs/general-development/how-to-apply-styles-to-page-fields-in-sharepoint.md +++ b/docs/general-development/how-to-apply-styles-to-page-fields-in-sharepoint.md @@ -2,9 +2,8 @@ title: Apply styles to page fields in SharePoint description: In a page layout, you can apply styles to a page field, and those styles are applied to any content added by content authors when they create a page from that page layout. Also, you have further options to control how content in a RichHtmlField page field is styled. ms.date: 12/22/2020 -ms.prod: sharepoint ms.assetid: e227613d-0e4d-4312-924d-bb55e1fe4293 -localization_priority: Priority +ms.localizationpriority: high --- # Apply styles to page fields in SharePoint diff --git a/docs/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md b/docs/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md index 15927fa3b..f239f0fb8 100644 --- a/docs/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md +++ b/docs/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md @@ -1,274 +1,325 @@ --- title: Avoid getting throttled or blocked in SharePoint Online -description: Find out about throttling in SharePoint Online, and learn how to avoid being throttled or blocked. Includes sample client-side object model (CSOM) and REST code you can use to make your task easier. -ms.date: 03/17/2021 -ms.prod: sharepoint +description: Learn about throttling in SharePoint Online and learn how to avoid being throttled or blocked. +ms.date: 06/12/2025 ms.assetid: 33ed8106-d850-42b1-8d7f-5ba83901149c -localization_priority: Priority +ms.localizationpriority: high --- # Avoid getting throttled or blocked in SharePoint Online -Find out about throttling in SharePoint Online, and learn how to avoid being throttled or blocked. Includes sample client-side object model (CSOM) and REST code you can use to make your task easier. +Find out about throttling in SharePoint Online and learn how to avoid being throttled or blocked. - [What is throttling?](how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md#what-is-throttling) +- [How to handle throttling?](how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md#how-to-handle-throttling) - [Common throttling scenarios in SharePoint Online](how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md#common-throttling-scenarios-in-sharepoint-online) -- [Why can't you just tell me the exact throttling limits?](how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md#why-cant-you-just-tell-me-the-exact-throttling-limits) -- [Search query volume limits when using app-only authentication with Sites.Read.All permission](how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md#search-query-volume-limits-when-using-app-only-authentication-with-sitesreadall-permission) -- [Best practices to handle throttling](how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md#best-practices-to-handle-throttling) -- [How to decorate your traffic to avoid getting throttled?](how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md#how-to-decorate-your-http-traffic-to-avoid-throttling) -- [GitHub CSOM code samples: SharePoint Online Throttling](how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md) +- [Scenario specific limits](how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md#scenario-specific-limits) - [What should you do if you get blocked in SharePoint Online?](how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md#what-should-you-do-if-you-get-blocked-in-sharepoint-online) - [Additional resources](how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online.md#see-also) -Does this sound familiar? You're running a CSOM process - for example, to migrate files in SharePoint Online - but you keep getting throttled. Or even worse, you get blocked. What's going on and what can you do to make it stop? +Does this sound familiar? You're running an application - for example, to scan files in SharePoint Online - but you get throttled. Or even worse, you get blocked. What's going on and what can you do to make it stop? ## What is throttling? -SharePoint Online uses throttling to maintain optimal performance and reliability of the SharePoint Online service. Throttling limits the number of user actions or concurrent calls (by script or code) to prevent overuse of resources. +SharePoint Online uses throttling to maintain the optimal performance and reliability of the SharePoint Online service. Throttling limits the number of API calls or operations within a time window to prevent the overuse of resources. -That said, it is rare for a user to get throttled in SharePoint Online. The service is robust, and it is designed to handle high volume. If you do get throttled, 99% of the time it is because of custom code. That doesn't mean that there aren't other ways to get throttled, just that they're less common. For example, you spin up 10 machines and have a sync client going on all 10. On each sync 1 TB of content. This would likely get you throttled. - -![How throttling happens](../images/3b9184db-99a4-416e-ba1e-7f8653484cee.png) +> [!NOTE] +> Recent updates to this article enhance transparency to already existing throttling rules in the system ### What happens when you get throttled in SharePoint Online? -When a user exceeds usage limits, SharePoint Online throttles any further requests from that user account for a short period. All user actions are throttled while the throttle is in effect. +When usage limits are exceeded, SharePoint Online throttles any further requests from that client for a short period. + +For requests that a user performs directly in the browser, SharePoint Online redirects you to the throttling information page, and the requests fail. + +For requests that an application makes, including [Microsoft Graph](/graph), CSOM, or REST calls, SharePoint Online returns HTTP status code 429 ("Too many requests") or 503 ("Server Too Busy"), and the requests will fail. + +- HTTP 429 indicates the calling application sent too many requests in a time window and exceeded a predetermined limit. +- HTTP 503 indicates the service isn't ready to handle the request. The common cause is that the service is experiencing more temporary load spikes. + +In both cases, a `Retry-After` header is included in the response, indicating how long the calling application should wait before retrying or making a new request. Throttled requests count towards usage limits, so failure to honor `Retry-After` may result in more throttling. + +If the offending application continues to exceed usage limits, SharePoint Online may completely block the application or specific request patterns from the application; in this case, the application will keep getting HTTP status code 503, and Microsoft will notify the tenant of the block in the Office 365 Message Center. + +### Resource units + +Some limits are measured in terms of API costs. [Microsoft Graph APIs](/graph) have a predetermined resource unit cost per request: + +| Resource units per request | Operations | +| -------------------------- | -------------------------------------------------------------------------------------------------------------- | +| 1 |
  • Single item query, such as get item
  • Delta with a token
  • Download file from drive item | +| 2 |
  • Multi item query, such as list children, except delta with a token
  • Create, update, delete, and upload | +| 5 |
  • All permission resource operations, including `$expand=permissions` | + +> [!NOTE] +> We reserve the right to change the API resource unit cost. + +### User Throttling + +Throttling limits the number of calls and operations collectively made by applications on behalf of a user to prevent the overuse of resources. + +That said, it's rare for a user to get throttled in SharePoint Online. The service is robust, and it's designed to handle high volume. If you do get throttled, 99% of the time it is because of custom code, such as custom web parts, complex list views and queries, or custom apps users run. That doesn’t mean that there aren’t other ways to get throttled, just that they’re less common. For example, one user syncing a large amount of data across 10 machines at the same time could trigger throttling. + +| Category | Type of throttling | Time interval | Limit | +|--------------|------------------------------|-------------------|-----------| +| User | Requests | 5 min | 3,000 | +| User | Ingress | 1 H | 50 GB | +| User | Egress | 1 H | 100 GB | +| User | Delegation Token Request | 5 min | 50 | +| User | External sharing emails | 1 H | 200 | + +> [!NOTE] +> Displayed limits are default values. Microsoft may change these limits at any time. Your experience may vary -- For requests that a user performs directly in the browser, SharePoint Online redirects you to the throttling information page, and the requests fail. -- For all other requests, including CSOM or REST calls, SharePoint Online returns HTTP status code 429 ("Too many requests") or 503 ("Server Too Busy") and the requests will fail. +### Tenant Throttling -If the offending process continues to exceed usage limits, SharePoint Online might completely block the process; in this case, you won't see any successful requests and Microsoft will notify you of the block in the Office 365 Message Center. +Some throttling limits are applied at the Tenant level to ensure the operations collectively made do not overuse resources. + +When a customer enables Multi-Geo, each geo gets its own limits (usage measurement not shared across geos). For the limits that are dependent on license count, the total tenant user license count is used (total users across all geos). + +| Category | Type of throttling | Time interval | Tenant license count | Limit | +|--------------|--------------------------------------|-------------------|--------------------------|-----------| +| Tenant | [Resource Units](#resource-units) | 5 min | 0 - 1,000 | 18,750 | +| Tenant | [Resource Units](#resource-units) | 5 min | 1,001 - 5,000 | 37,500 | +| Tenant | [Resource Units](#resource-units) | 5 min | 5,001 - 15,000 | 56,250 | +| Tenant | [Resource Units](#resource-units) | 5 min | 15,001 - 50,000 | 75,000 | +| Tenant | [Resource Units](#resource-units) | 5 min | 50,000+ | 93,750 | +| Tenant | Assign Sensitivity Label | 5 min | no license bound | 100 | +| Tenant | PeopleManagerAPIs | 5 min | 0 - 1,000 | 3,000 | +| Tenant | PeopleManagerAPIs | 5 min | 1,001 - 5,000 | 6,000 | +| Tenant | PeopleManagerAPIs | 5 min | 5,001 - 15,000 | 9,000 | +| Tenant | PeopleManagerAPIs | 5 min | 15,001 - 50,000 | 12,000 | +| Tenant | PeopleManagerAPIs | 5 min | 50,000+ | 15,000 | + +> [!NOTE] +> Displayed limits are default values. Microsoft may change these limits at any time. Your experience may vary ### Application Throttling -In addition to throttling by user account, limits are also applied to each application. Every application in SharePoint Online has its own available resources, but multiple applications running against the same tenant ultimately share from the same resource bucket and in rare occurrences can cause rate limiting. -In these cases, SharePoint Online will attempt to prioritize interactive user requests over background activities. +In addition to throttling by user account, limits are also applied to applications in a tenant. -## Common throttling scenarios in SharePoint Online +Every application has its own limits in a tenant, which are based on the number of licenses purchased per organization (see the plans listed on [SharePoint Limits](/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#limits-by-plan) for licenses included). Every request that an application makes across all API endpoints, including [Microsoft Graph](/graph), CSOM, and REST, counts towards the application’s usage. -The most common causes of per-user throttling in SharePoint Online are client-side object model (CSOM) or Representational State Transfer (REST) code that performs too many actions too frequently. +SharePoint provides various APIs. Different APIs have different costs depending on the complexity of the API. The cost of APIs is normalized by SharePoint and expressed by resource units. Application’s limits are also defined using resource units. -- **Sporadic traffic** +For multitenant applications: - Constant load or repetitive complex queries against SharePoint Online must be optimized for low impact. Failing to follow [best practices for scanning applications](https://aka.ms/ScanGuidance) that process files in bulk will likely result in throttling. These apps include sync engines, backup providers, search indexers, classification engines, data loss prevention tools, and any other tool, which attempts to reason over the entirety of data and apply changes to it. +1. Each tenant hosting the application is considered distinct, operating independently from others. Consequently, every application is subject to its own usage limits within each tenant as defined above. +1. The consumption of resource units by the application is to be measured on a per-tenant, per-application basis. This ensures that each tenant-application pair remains within the permissible resource limits specified for that particular tenant. +1. Should the application reach its resource limit within one tenant, this occurrence will not affect other instances of the application operating in different tenants. Each tenant's resource utilization is isolated, preventing cross-tenant impact. - For example, after migrating files to SharePoint Online, you run a custom CSOM or REST script to update metadata on the files. The CSOM/REST script is updating a large number of files at a high frequency, which triggers throttling. Similarly, an autocomplete UI widget using REST services, making too many calls to lists during each end-user operation, may also cause throttling, depending on what other operations are consuming resources at the same time. +| Category | Type of throttling | Time interval | Tenant license count | Limit | +|--------------------|--------------------------------------|-------------------|--------------------------|------------| +| Per APP Per Tenant | [Resource Units](#resource-units) | 24 H | 0 - 1,000 | 1,200,000 | +| Per APP Per Tenant | [Resource Units](#resource-units) | 24 H | 1,001 - 5,000 | 2,400,000 | +| Per APP Per Tenant | [Resource Units](#resource-units) | 24 H | 5,001 - 15,000 | 3,600,000 | +| Per APP Per Tenant | [Resource Units](#resource-units) | 24 H | 15,001 - 50,000 | 4,800,000 | +| Per APP Per Tenant | [Resource Units](#resource-units) | 24 H | 50,000+ | 6,000,000 | +| Per APP Per Tenant | [Resource Units](#resource-units) | 1 min | 0 - 1,000 | 1,250 | +| Per APP Per Tenant | [Resource Units](#resource-units) | 1 min | 1,001 - 5,000 | 2,500 | +| Per APP Per Tenant | [Resource Units](#resource-units) | 1 min | 5,001 - 15,000 | 3,750 | +| Per APP Per Tenant | [Resource Units](#resource-units) | 1 min | 15,001 - 50,000 | 5,000 | +| Per APP Per Tenant | [Resource Units](#resource-units) | 1 min | 50,000+ | 6,250 | +| Per APP Per Tenant | Ingress | 1 H | no license bound | 400 GB | +| Per APP Per Tenant | Egress | 1 H | no license bound | 400 GB | +| Per APP Per Tenant | Specific Sharing APIs | 5 min | no license bound | 300 | - ![Sporadic throttling](../images/a61afe25-9597-403f-b3fa-d3f630155021.png) +> [!NOTE] +> Displayed limits are default values. Microsoft may change these limits at any time. Your experience may vary -- **Overwhelming traffic** +### Other Limits + +| Category | Type of throttling | Time interval | Limit | +|-------------------------------|--------------------------------------|-------------------|-----------| +| SharePoint Embedded containers| [Resource Units](#resource-units) | 1 min | 3,000 | +| Per Site | Anonymous Link | 5 min | 3,000 | +| Per Site | Anonymous Egress (Download) | 2 H | 100 GB | +| Per Site | External sharing emails | 1 H | 200 | + +> [!NOTE] +> Displayed limits are default values. Microsoft may change these limits at any time. Your experience may vary + +## How to handle throttling? + +Below is a quick summary of the best practices to handle throttling: + +- Reduce the number of concurrent requests +- Avoid request spikes +- Choose [Microsoft Graph APIs](/graph) over CSOM and REST APIs when possible +- Use the `Retry-After` and `RateLimit` HTTP headers +- Decorate your traffic so we know who you are (see section on traffic decoration best practice, more on that below) +- Consider using [Graph Data Connect for SharePoint](https://techcommunity.microsoft.com/blog/microsoft_graph_data_connect_for_sharepo/links-about-microsoft-graph-data-connect-for-sharepoint/4069045) for broad site analytics +- Understand if [service prioritization in SharePoint](https://aka.ms/SharePointPrioritization) is the right fit for your scenario + +As stated earlier, [Microsoft Graph](/graph) is cloud born APIs that have the latest improvements and optimizations. In general, [Microsoft Graph](/graph) consumes fewer resources than CSOM and REST to achieve the same functionality. Hence, adopting [Microsoft Graph](/graph) can improve the application's performance and reduce throttling. + +If you do run into throttling, we require using the `Retry-After` HTTP header to ensure minimum delay until the throttle is removed. The `RateLimit` HTTP headers send you early signals when you're close to limits, and you can proactively reduce requests to avoid hitting the throttle. + +Delta with a token is the most efficient way to scan content in SharePoint, and we talk more in detail at the [best practices for scanning applications](https://aka.ms/ScanGuidance). To help applications that follow the guidance, we lower the resource unit cost of delta requests with a token to 1 resource unit, although it's a multi-item query. The delta request without a token is considered a multi-item query and costs 2 resource units per request. + +In [batching](/graph/json-batching), requests in a batch are evaluated individually by resource units. + +CSOM and REST don't have a predetermined resource unit cost, and they usually consume more resource units than [Microsoft Graph APIs](/graph) to achieve the same functionality. In addition to resource unit limits, CSOM and REST are also subject to other internal resource limits, so if applications call CSOM and REST, they may experience more throttling than the limits described in this document. We highly recommend you choose [Microsoft Graph APIs](/graph) over CSOM and REST APIs when possible. - A single process dramatically exceeds throttling limits, continually, over a long time period. +Since application limits are in resource units, the actual request rate, such as requests per minute, depends on the application’s API choice and the corresponding API resource unit cost. In general, you can estimate the request rate using an average of 2 resource units per request, and divide resource unit limits by 2 to get the estimated request rate. - - You used web services to build a tool to synchronize user profile properties. The tool updates user profile properties based on information from your line-of-business (LOB) human resources (HR) system. The tool makes calls at too high a frequency. - - You're running a load-testing script on SharePoint Online and you get throttled. Load testing isn't allowed on SharePoint Online. - - You customized your team site on SharePoint Online, for example, by adding a status indicator on the Home page. This status indicator updates frequently, which causes the page to make too many calls to the SharePoint Online service - this triggered throttling. - - Running the OneDrive Sync client while also running migration applications or applications that crawl sites and write back data can result in high request volumes that may trigger throttling. +Although each application has its limits within a tenant, and we allow tenants to run more than one application, multiple applications running against the same tenant share the same resource bucket, and in rare occurrences can cause rate limiting when too many applications send requests at the time. - ![Steady throttling](../images/7849d413-381f-4558-9e50-b3cc9990d3e3.png) +### Retry-after header -## Why can't you just tell me the exact throttling limits? +When applications experience throttling, SharePoint Online returns a `Retry-After` HTTP header in the request indicating how long in seconds the calling application should wait before retrying or making a new request. -Setting and publishing exact throttling limits sounds straightforward, but in fact it would result in more restrictive limits. We continually monitor resource usage on SharePoint Online. Depending on usage, we fine-tune thresholds so users can consume the maximum number of resources without degrading the reliability and performance of SharePoint Online. +Honoring the `Retry-After` HTTP header is the fastest way to handle being throttled because SharePoint Online dynamically determines the right time to try again. -That's why it's so important for your code to honor the `Retry-After` HTTP header value; this lets your code run as fast as possible on any given day, and it lets your code back off "just enough" if it hits throttling limits. The code samples later in this article show you how to use the `Retry-After` HTTP header. +Throttled requests count towards usage limits, so failure to honor `Retry-After` may result in more throttling. In other words, aggressive retries work against calling applications because even though the calls fail, they still count toward usage limits. Honoring the `Retry-After` HTTP header will ensure the shortest delay and reduce wasting quotas in throttled requests. -## Search query volume limits when using app-only authentication with Sites.Read.All permission +### RateLimit headers - preview -In SharePoint and OneDrive, we process multiple billions of documents and enable our customers to issue large query volumes per second. When you are using SharePoint Online search APIs with app-only authentication and the app having `Sites.Read.All` permission (or stronger), the app will be registered with full permissions and is allowed to query all your SharePoint Online content (including user’s private ODB content). +In addition to the `Retry-After` header in the response to throttled requests, SharePoint Online also returns the [IETF RateLimit headers](https://github.com/ietf-wg-httpapi/ratelimit-headers) for selected limits in certain conditions to help applications manage rate limiting. We recommend applications to take advantage of these headers to avoid hitting the throttle. -We want to let our customers know that SharePoint Online search queries using such permission will be throttled at 25 QPS. The search query will return with a 429 response and you can retry the query after 2 minutes. When waiting for 429 recovery, you should ensure to pause all search query requests you may be making to the service using similar app-only permission. Making additional calls while receiving throttle responses will extend the time it takes for your app to become unthrottled. +- `RateLimit-Limit` contains the limit in the current time window. +- `RateLimit-Remaining` indicates the remaining quota in the current window. +- `RateLimit-Reset` indicates the number of seconds until the quota is refilled. -As we scale our system, we realize the importance of hardening the system to run it efficiently and also to protect the system and hence this change. This change is expected to roll out to tenants starting Aug into the Fall of 2020. +> [!NOTE] +> These headers are currently in **beta** and subject to change. At the time when the headers were adopted, the IETF specification was in draft. The current implementation is based on the [draft-03](https://datatracker.ietf.org/doc/html/draft-ietf-httpapi-ratelimit-headers-03) of the IETF specification. There is the potential for changes when the specification is final, and we will adapt to those changes in the future. + +The `RateLimit` headers are returned on a **best-efforts** basis, so applications may not receive the headers under all conditions. Additionally, there are other limits that aren't presented in the `RateLimit` headers, so applications can get throttled even before reaching the limit described in the `RateLimit` headers. +Below is the list of limits that we support the `RateLimit` headers for. The policies and values are subject to change: + +| limit | Condition | limit value | Description | +|----------------------------|---------------------------|---------------|------------------------------------------------------------------------------------------------------------------| +| App 1-minute resource unit | Usage >= 80% of the limit | Resource unit | When an application consumes 80% or more of its app 1-minute limit, the limit, remaining, and reset are returned.| -## Best practices to handle throttling +Below are some examples to help you understand the `RateLimit` headers: -- Reduce the number of operations per request -- Reduce the frequency of calls -- Choose Microsoft Graph APIs over CSOM and REST APIs when possible -- Decorate your traffic so we know who you are (see section on traffic decoration best practice more on that below) -- Leverage the `Retry-After` HTTP header +- An application has consumed 90% of its resource unit quota (1,080 out of 1,200), and its consumption is within all the limits that apply to it. The request succeeds and the `RateLimit` headers are returned. -Microsoft Graph is cloud born APIs that have the latest improvements and optimizations. In general, Microsoft Graph consumes less resource than CSOM and REST to achieve the same functionality. Hence, adopting Microsoft Graph can improve application's performance and reduce throttling. + ``` + HTTP/1.1 200 Ok + RateLimit-Limit: 1200 + RateLimit-Remaining: 120 + RateLimit-Reset: 5 + ``` -If you do run into throttling, we require leveraging the `Retry-After` HTTP header to ensure minimum delay until the throttle is removed. +- An application has consumed 100% of its resource unit quota, so it gets throttled due to this policy. The request is throttled, and the `RateLimit` headers are returned. The `Retry-After` matches the `RateLimit-Reset`. There are instances where the `Retry-After` returns a smaller value. In such cases, the general rule of thumb is to honor the greater of the two values. -The `Retry-After` HTTP header is the fastest way to handle being throttled because SharePoint Online dynamically determines the right time to try again. In other words, aggressive retries work against you because even though the calls fail, they still accrue against your usage limits. Following the `Retry-After` HTTP header will ensure the shortest delay. + ``` + HTTP/1.1 429 Too Many Requests + Retry-After: 31 + RateLimit-Limit: 1200 + RateLimit-Remaining: 0 + RateLimit-Reset: 31 + ``` -For information about ways to monitor your SharePoint Online activity, see [Diagnosing performance issues with SharePoint Online](https://support.office.com/article/3c364f9e-b9f6-4da4-a792-c8e8c8cd2e86). +- An application has consumed 90% of its resource unit quota, but its consumption has already reached other limits that the `RateLimit` headers don't support. In this case, the request is throttled and the `RateLimit` headers aren't returned to avoid confusion, although the condition to return the headers is satisfied. -For a broader discussion of throttling on the Microsoft Cloud, see [Throttling Pattern](/previous-versions/msp-n-p/dn589798(v=pandp.10)). + ``` + HTTP/1.1 429 Too Many Requests + Retry-After: 9 + ``` -## How to decorate your http traffic to avoid throttling? +Additional information can be found in [Prevent throttling in your application by using RateLimit headers in SharePoint Online](https://devblogs.microsoft.com/microsoft365dev/prevent-throttling-in-your-application-by-using-ratelimit-headers-in-sharepoint-online/) + +### How to decorate your HTTP traffic? -To ensure and maintain high-availability, some traffic may be throttled. Throttling happens when system health is at stake and one of the criteria used for throttling is traffic decoration, which impacts directly on the prioritization of the traffic. Well-decorated traffic will be prioritized over traffic, which isn't properly decorated. +Well-decorated traffic will be prioritized over traffic that isn't properly decorated. -### What is definition of undecorated traffic? +What is the definition of undecorated traffic? -- Traffic is undecorated if there's no AppID/AppTitle and User Agent string in CSOM or REST API call to SharePoint Online. The User Agent string should be in a specific format as described below. +- Traffic is undecorated if there's no AppID/AppTitle and User Agent string in API calls to SharePoint Online. The User-Agent string should be in a specific format as described below. +- If you're developing a web application executing in the browser, most modern browsers don't allow overwriting the User Agent string, and you don't need to implement it. -### What are the recommendations? +What are the recommendations? -- If you've created an application, the recommendation is to register and use AppID and AppTitle – This will ensure the best overall experience and best path for any future issue resolution. Include also the User Agent string information as defined in following step. +- If you've created an application, the recommendation is to register and use AppID and AppTitle – This will ensure the best overall experience and best path for any future issue resolution. Include also the User Agent string information as defined in the following step. > [!NOTE] - > Refer to the [Microsoft identity documentation](https://docs.microsoft.com/azure/active-directory/develop/), such as the [Quickstart: Register an application with the Microsoft identity platform](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app) page, for information on creating an Azure AD application. + > Refer to the [Microsoft identity documentation](/azure/active-directory/develop/), such as the [Quickstart: Register an application with the Microsoft identity platform](/azure/active-directory/develop/quickstart-register-app) page, for information on creating an Azure AD application. -- Make sure to include User Agent string in your API call to SharePoint with following naming convention +- Make sure to include the User-Agent string in your API call to SharePoint with the following naming convention | Type | User Agent | Description | -| ---------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| ISV Application | ISV|CompanyName|AppName/Version | Identify as ISV and include Company Name, App Name separated by a pipe character and then adding Version number separated with a slash character | +|------------------------|----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| ISV Application | ISV|CompanyName|AppName/Version | Identify as ISV and include Company Name, App Name separated by a pipe character and then add Version number separated with a slash character | | Enterprise application | NONISV|CompanyName|AppName/Version | Identify as NONISV and include Company Name, App Name separated by a pipe character and then adding Version number separated with a slash character | -- If you're building your own JavaScript libraries, which are used to call SharePoint Online APIs, make sure that you include the User Agent information to your http request and potentially register your web application also as an Application, where suitable. +- If you're building your own JavaScript libraries, which are used to call SharePoint Online APIs, make sure that you include the User-Agent information to your HTTP request and potentially register your web application also as an Application, where suitable. > [!NOTE] -> Format of the user agent string is expected to follow [RFC2616](http://www.ietf.org/rfc/rfc2616.txt), so please follow up on the above guidance on the right separators. its also fine to append existing user agent string with the requested information. +> The format of the user agent string is expected to follow [RFC2616](http://www.ietf.org/rfc/rfc2616.txt), so please follow up on the above guidance on the right separators. It is also fine to append the existing user agent string with the requested information. -> [!NOTE] -> If you are developing front end components executing in the browser, most of modern browsers don't allow overwriting the user agent string and you don't need to implement this. - -### Example of decorating traffic with User agent when using Client Side Object Model (CSOM) - -```cs -// Get access to source site -using (var ctx = new ClientContext("https://contoso.sharepoint.com/sites/team")) -{ - //Provide account and pwd for connecting to SharePoint Online - var passWord = new SecureString(); - foreach (char c in pwd.ToCharArray()) passWord.AppendChar(c); - ctx.Credentials = new SharePointOnlineCredentials("contoso@contoso.onmicrosoft.com", passWord); - - // Add our User Agent information - ctx.ExecutingWebRequest += delegate (object sender, WebRequestEventArgs e) - { - e.WebRequestExecutor.WebRequest.UserAgent = "NONISV|Contoso|GovernanceCheck/1.0"; - }; - - // Normal CSOM Call with custom User-Agent information - Web site = ctx.Web; - ctx.Load(site); - ctx.ExecuteQuery(); -} -``` - -### Example of decorating traffic with User agent when using REST APIs - -Following sample is in C# format, but the similar User Agent information is recommended to be used even for the JavaScript libraries used in the SharePoint Online pages. - -```cs -HttpWebRequest endpointRequest = (HttpWebRequest) HttpWebRequest.Create(sharepointUrl.ToString() + "/_api/web/lists"); -endpointRequest.Method = "GET"; -endpointRequest.UserAgent = "NONISV|Contoso|GovernanceCheck/1.0"; -endpointRequest.Accept = "application/json;odata=nometadata"; -endpointRequest.Headers.Add("Authorization", "Bearer " + accessToken); -HttpWebResponse endpointResponse = (HttpWebResponse)endpointRequest.GetResponse(); -``` - -### CSOM Code sample: ExecuteQueryWithIncrementalRetry extension method -> [!NOTE] -> You'll need to use SharePoint Online CSOM version 16.1.8316.1200 (December 2018 version) or higher. - -Add this extension method in a static class and use `ExecuteQueryWithIncrementalRetry` instead of `ExecuteQuery` to make your code handle throttling requests. - -```cs -public static void ExecuteQueryWithIncrementalRetry(this ClientContext clientContext, int retryCount, int delay) -{ - int retryAttempts = 0; - int backoffInterval = delay; - int retryAfterInterval = 0; - bool retry = false; - ClientRequestWrapper wrapper = null; - if (retryCount <= 0) - throw new ArgumentException("Provide a retry count greater than zero."); - if (delay <= 0) - throw new ArgumentException("Provide a delay greater than zero."); - - // Do while retry attempt is less than retry count - while (retryAttempts < retryCount) - { - try - { - if (!retry) - { - clientContext.ExecuteQuery(); - return; - } - else - { - //increment the retry count - retryAttempts++; - - // retry the previous request using wrapper - if (wrapper != null && wrapper.Value != null) - { - clientContext.RetryQuery(wrapper.Value); - return; - } - // retry the previous request as normal - else - { - clientContext.ExecuteQuery(); - return; - } - } - } - catch (WebException ex) - { - var response = ex.Response as HttpWebResponse; - // Check if request was throttled - http status code 429 - // Check is request failed due to server unavailable - http status code 503 - if (response != null && (response.StatusCode == (HttpStatusCode)429 || response.StatusCode == (HttpStatusCode)503)) - { - wrapper = (ClientRequestWrapper)ex.Data["ClientRequest"]; - retry = true; - - // Determine the retry after value - use the `Retry-After` header when available - string retryAfterHeader = response.GetResponseHeader("Retry-After"); - if (!string.IsNullOrEmpty(retryAfterHeader)) - { - if (!Int32.TryParse(retryAfterHeader, out retryAfterInterval)) - { - retryAfterInterval = backoffInterval; - } - } - else - { - retryAfterInterval = backoffInterval; - } - - // Delay for the requested seconds - Thread.Sleep(retryAfterInterval * 1000); - - // Increase counters - backoffInterval = backoffInterval * 2; - } - else - { - throw; - } - } - } - throw new MaximumRetryAttemptedException($"Maximum retry attempts {retryCount}, has be attempted."); -} - -[Serializable] -public class MaximumRetryAttemptedException : Exception -{ - public MaximumRetryAttemptedException(string message) : base(message) { } -} -``` +## Common throttling scenarios in SharePoint Online + +The most common causes of per-user throttling in SharePoint Online are client-side object model (CSOM) or Representational State Transfer (REST) code that performs too many actions too frequently. + +- **Sporadic traffic** + + Constant load or repetitive complex queries against SharePoint Online must be optimized for low impact. Failing to follow [best practices for scanning applications](https://aka.ms/ScanGuidance) that process files in bulk will likely result in throttling. These apps include sync engines, backup providers, search indexers, classification engines, data loss prevention tools, and any other tool, that attempts to reason over the entirety of data and apply changes to it. + +- **Overwhelming traffic** + + A single process dramatically exceeds throttling limits, continually, over a long period. + + - You used web services to build a tool to synchronize user profile properties. The tool updates user profile properties based on information from your line-of-business (LOB) human resources (HR) system. The tool makes calls at too high a frequency. + - You're running a load-testing script on SharePoint Online and you get throttled. Load testing isn't allowed on SharePoint Online. + - You customized your team site on SharePoint Online, for example, by adding a status indicator on the Home page. This status indicator updates frequently, which causes the page to make too many calls to the SharePoint Online service - this triggered throttling. + - Running the OneDrive Sync client while also running migration applications or applications that crawl sites and write back data can result in high request volumes that may trigger throttling. + +- **Unsupported use cases** + + Unsupported use of SharePoint Online may result in throttling. Using SharePoint and OneDrive as an intermediary service between Microsoft 365 and another repository is an example of an unsupported use case. + +- **Creating multiple AppIDs for the same application** + + Don't create separate AppIDs where the applications essentially perform the same operations, such as backup or data loss prevention. Applications running against the same tenant ultimately share the same resources as the tenant. Historically, some applications have tried this approach to get around the application throttling but ended up exhausting the tenant’s resource and causing multiple applications to be throttled in the tenant. + +## Scenario specific limits + +### When using app-only authentication with Sites.Read.All permission + +When you're using SharePoint Online search APIs with app-only authentication and the app has **Sites.Read.All** permission (or stronger), the app will be registered with full permissions, and is allowed to query all your SharePoint Online content (including the user’s private OneDrive for Business content). + +To ensure the service remains fast and reliable, queries using such permission are throttled at 25 requests per second. The search query will return an HTTP 429 response. When waiting for throttling recovery, you should ensure to pause all search query requests you may be making to the service using a similar app-only permission. Making more calls while receiving throttle responses will extend the time it takes for your app to become unthrottled. + +### When searching using delegated user permissions + +Searching with delegated user permissions occurs when an application submits a search query request with the signed-in user's permissions. Examples of delegated requests are as follows: the search box on a SharePoint page, a search-based web part or custom application embedded on a SharePoint page, and a Power Automate workflow querying for item information. + +To ensure service stability, the service will throttle delegated user requests that exceed 10 requests per second per user. This per-user limit aggregates across all requests from all apps. If a single user sends more than 10 search query requests per second, an HTTP 429 is returned. The requesting application should wait the duration of the timeout specified in the response header before sending subsequent requests. When designing search-based applications, SharePoint pages, and workflows, implementors should make sure the page and application do not exceed 10 requests per second in aggregate and handle 429 throttling responses. For more information and guidance on page design and search optimization, see [Optimize search requests in SharePoint Online modern site pages](/microsoft-365/enterprise/modern-search-optimization) and [Use the Page Diagnostics tool for SharePoint Online](/microsoft-365/enterprise/page-diagnostics-for-spo). + +### When searching for people search results + +When searching using a result source that requests people results, we may throttle any requests exceeding an organization-wide limit of 25 requests per second. This limit applies to all SharePoint search CSOM and REST requests using either the out-of-the-box "Local People Results" result source or a custom people search result source. + +If you have applications or components that are causing your people search requests to get throttled, we recommend that you: + +1. Consider if the requests are necessary for your application. For example, if you're using a custom search site, that makes many simultaneous queries, check whether some of those requests can be removed without any significant impact on your organization's search experience. Alternatively, consider trying our modern people search experience in [Microsoft Search](/microsoftsearch/get-started-search-in-sharepoint-online) by searching from the [SharePoint](https://sharepoint.com/) start page. People search in Microsoft Search has been optimized for better performance and more relevant results. +1. Avoid making concurrent requests. For example, instead of issuing 10 requests all at once, issue them consecutively - only issue the next query after the previous one has been completed. You may need to consider caching these results if you need them quickly, for example of a page load. +1. Try consolidating the requests into a single query. For example, instead of making 10 simultaneous queries for `WorkEmail:user1@constoso.com`, `WorkEmail:user2@constoso.com`,..., `WorkEmail:user10@contoso.com`, try the single query, `WorkEmail:user1@constoso.com WorkEmail:user2@constoso.com ... WorkEmail:user10@contoso.com`. +1. Consider using the [Microsoft Graph API](/graph/search-concept-person) if a high-request-volume scenario (in excess of 25 requests per second) is truly necessary. + +### When accessing OneDrive sites + +When a client makes excessive attempts to access many OneDrive site collections that do not exist, we may throttle requests from that client's IP address. The client will receive an HTTP 429 response when accessing any OneDrive site collection during the throttling period. + +### Multi-Geo Customers and throttling + +When a customer enables throttling, each gets their own limits (usage measurement not shared across geos). For the limits that are dependant on licenses count, the total tenant user licenses count is used (total users across all geos). ## What should you do if you get blocked in SharePoint Online? -Blocking is the most extreme form of throttling. We rarely ever block a tenant, unless we detect long-term, excessive traffic that may threaten the overall health of the SharePoint Online service. We apply blocks to prevent excessive traffic from degrading the performance and reliability of SharePoint Online. A block - which is placed at the app or user level - prevents the offending process from running until you fix the problem. If we block your subscription, you must take action to modify the offending processes before the block can be removed. +Blocking is the most extreme form of throttling. We rarely ever block a tenant unless we detect long-term, excessive traffic that may threaten the overall health of the SharePoint Online service. We apply blocks to prevent excessive traffic from degrading the performance and reliability of SharePoint Online. A block - which is placed at the app or user level - prevents the offending process from running until you fix the problem. If we block your subscription, you must take action to modify the offending processes before the block can be removed. -If we block your subscription, we will notify you of the block in the Office 365 Message Center. The message describes what caused the block, provides guidance on how to resolve the offending issue, and tells you who to contact to get the block removed. +If we block your subscription, we'll notify you of the block in the Office 365 Message Center. The message describes what caused the block, provides guidance on how to resolve the offending issue, and tells you who to contact to get the block removed. ## See also +- [Service Prioritization in SharePoint](https://aka.ms/SharePointPrioritization) - [Diagnosing performance issues with SharePoint Online](https://support.office.com/article/3c364f9e-b9f6-4da4-a792-c8e8c8cd2e86) - [Capacity planning and load testing SharePoint Online](https://support.office.com/article/capacity-planning-and-load-testing-sharepoint-online-c932bd9b-fb9a-47ab-a330-6979d03688c0) +- [Microsoft Graph dev center](/graph) +- [Microsoft Graph throttling guidance](/graph/throttling) +- [Prevent throttling in your application by using RateLimit headers in SharePoint Online](https://devblogs.microsoft.com/microsoft365dev/prevent-throttling-in-your-application-by-using-ratelimit-headers-in-sharepoint-online/) +- [Four options for site analytics](https://techcommunity.microsoft.com/blog/microsoft_graph_data_connect_for_sharepo/four-options-for-sharepoint-site-analytics/4076416) diff --git a/docs/general-development/how-to-back-up-and-restore-a-search-service-application-in-sharepoint-using.md b/docs/general-development/how-to-back-up-and-restore-a-search-service-application-in-sharepoint-using.md index 909b472f7..818bbb861 100644 --- a/docs/general-development/how-to-back-up-and-restore-a-search-service-application-in-sharepoint-using.md +++ b/docs/general-development/how-to-back-up-and-restore-a-search-service-application-in-sharepoint-using.md @@ -1,9 +1,9 @@ --- title: Back up and restore a search service application in SharePoint using VSS -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to back up and restore a search service application in SharePoint using VSS and provides prerequisites and steps. +ms.date: 06/09/2022 ms.assetid: 87ee28e6-8170-4dba-8c9d-f04ab9e632dc -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-back-up-and-restore-sharepoint-using-a-vss-requestor.md b/docs/general-development/how-to-back-up-and-restore-sharepoint-using-a-vss-requestor.md index 9feefdf56..045f47664 100644 --- a/docs/general-development/how-to-back-up-and-restore-sharepoint-using-a-vss-requestor.md +++ b/docs/general-development/how-to-back-up-and-restore-sharepoint-using-a-vss-requestor.md @@ -1,9 +1,9 @@ --- title: Back up and restore SharePoint using a VSS requestor -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to back up and restore using a Volume Shadow Copy Service (VSS) requestor for Microsoft SharePoint. +ms.date: 06/09/2022 ms.assetid: cab5ba90-bd23-4cec-82d7-529e3f86ba88 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-brand-snippets-by-using-css-in-sharepoint.md b/docs/general-development/how-to-brand-snippets-by-using-css-in-sharepoint.md index ff2df2fb8..b72aa8ae3 100644 --- a/docs/general-development/how-to-brand-snippets-by-using-css-in-sharepoint.md +++ b/docs/general-development/how-to-brand-snippets-by-using-css-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Brand snippets by using CSS in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to style snippets by using CSS in SharePoint and provides example snippets with instructions on how to use them. +ms.date: 06/09/2022 ms.assetid: d18d07b6-1a6b-4589-a65c-932b67cef595 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/how-to-build-and-deploy-workflow-custom-actions.md b/docs/general-development/how-to-build-and-deploy-workflow-custom-actions.md index 413ca4d87..290823cc4 100644 --- a/docs/general-development/how-to-build-and-deploy-workflow-custom-actions.md +++ b/docs/general-development/how-to-build-and-deploy-workflow-custom-actions.md @@ -1,9 +1,9 @@ --- title: Build and deploy workflow custom actions -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to create custom workflow actions in SharePoint and provides an example that creates, packages, and deploys a custom activity. +ms.date: 06/09/2022 ms.assetid: 9d2fa681-30c2-4549-9df2-ea9ed757fda9 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/how-to-build-search-driven-mobile-apps-with-the-navigation-and-event-logging-res.md b/docs/general-development/how-to-build-search-driven-mobile-apps-with-the-navigation-and-event-logging-res.md index 80eb41f0c..a24fee190 100644 --- a/docs/general-development/how-to-build-search-driven-mobile-apps-with-the-navigation-and-event-logging-res.md +++ b/docs/general-development/how-to-build-search-driven-mobile-apps-with-the-navigation-and-event-logging-res.md @@ -1,9 +1,9 @@ --- title: Build search-driven mobile apps with the Navigation and Event Logging REST interfaces -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to build search-driven mobile apps for mobile devices that run on non-Windows operating systems. +ms.date: 06/09/2022 ms.assetid: 5b313130-500c-4ccf-80ea-b102f30e5afb -localization_priority: Normal +ms.localizationpriority: medium --- @@ -50,7 +50,7 @@ Typically the **Home** page is displayed when the app starts up. The **Home** pa -![Build search-driven mobile apps](../images/SP15_Buildsearch-drivenmobileappspages_home.gif) +![Diagram that shows the Mobile App communicating with a REST navigation HTTP call to Share Point, which gives a Navigation structure response back.](../images/SP15_Buildsearch-drivenmobileappspages_home.gif) @@ -92,7 +92,7 @@ The **Category** page displays many items in a selected category. Each item list -![Build search-driven mobile apps](../images/Buildsearch-drivenmobileappspages.gif) +![Diagram that shows the Mobile App communicating with a REST search query to Share Point, which gives the search results back.](../images/Buildsearch-drivenmobileappspages.gif) diff --git a/docs/general-development/how-to-catch-exceptions.md b/docs/general-development/how-to-catch-exceptions.md index 0211a16cb..e49b400fd 100644 --- a/docs/general-development/how-to-catch-exceptions.md +++ b/docs/general-development/how-to-catch-exceptions.md @@ -1,12 +1,12 @@ --- title: Catch exceptions +description: You place the sections of code that might throw exceptions in a try block and place code that handles exceptions in a catch block. The order of catch statements is important. When an exception occurs, it is passed up the stack and each catch block is given the opportunity to handle it. ms.date: 09/25/2017 keywords: errors,how to,howdoi,howto f1_keywords: - errors,how to,howdoi,howto -ms.prod: sharepoint ms.assetid: de5fdb67-201b-4d7a-90a8-99ab7e51ea4e -localization_priority: Normal +ms.localizationpriority: medium --- @@ -18,7 +18,7 @@ You place the sections of code that might throw exceptions in a try block and pl -```cs +```csharp catch (SoapException e) { @@ -41,7 +41,7 @@ End Try If no type-specific catch block exists, the exception is caught by a general catch block, if one exists. For example, you can catch general exceptions by adding the following code: -```cs +```csharp catch (Exception e) { @@ -63,7 +63,7 @@ You place catch blocks targeted to specific types of exceptions before a general ## Example -```cs +```csharp using System; using System.Text; diff --git a/docs/general-development/how-to-change-the-preview-page-in-sharepoint-design-manager.md b/docs/general-development/how-to-change-the-preview-page-in-sharepoint-design-manager.md index fa060d93e..9e0aa988f 100644 --- a/docs/general-development/how-to-change-the-preview-page-in-sharepoint-design-manager.md +++ b/docs/general-development/how-to-change-the-preview-page-in-sharepoint-design-manager.md @@ -1,9 +1,9 @@ --- title: Change the preview page in SharePoint Design Manager -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to set, create, and change the preview page in Design Manager in SharePoint, and provides additional resources. +ms.date: 06/09/2022 ms.assetid: e5dfd8df-65de-44fc-aa97-23b4685d33ee -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/how-to-configure-and-use-push-notifications-in-sharepoint-apps-for-windows.md b/docs/general-development/how-to-configure-and-use-push-notifications-in-sharepoint-apps-for-windows.md index 9ed489183..34bc54174 100644 --- a/docs/general-development/how-to-configure-and-use-push-notifications-in-sharepoint-apps-for-windows.md +++ b/docs/general-development/how-to-configure-and-use-push-notifications-in-sharepoint-apps-for-windows.md @@ -1,10 +1,9 @@ --- title: Configure and use push notifications in SharePoint apps for Windows Phone description: Create a solution in SharePoint Server for sending push notifications and develop a Windows Phone app for receiving the notifications. -ms.date: 12/22/2020 -ms.prod: sharepoint +ms.date: 06/09/2022 ms.assetid: 68fa2138-86d9-4e35-9c7c-5cd292087b80 -localization_priority: Normal +ms.localizationpriority: medium --- # Configure and use push notifications in SharePoint apps for Windows Phone @@ -1130,5 +1129,5 @@ When you add an item to the Jobs SharePoint list, the code in the event receiver - [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md) - [Windows Phone SDK 8.0](https://www.microsoft.com/download/details.aspx?id=35471) - [Microsoft SharePoint SDK for Windows Phone 8](https://www.microsoft.com/download/details.aspx?id=36818) -- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=27570) +- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=29233) - [Microsoft SharePoint SDK for Windows Phone 7.1](https://www.microsoft.com/download/details.aspx?id=30476) diff --git a/docs/general-development/how-to-configure-item-level-security-in-sharepoint.md b/docs/general-development/how-to-configure-item-level-security-in-sharepoint.md index 6b9ad6ff3..f8e5ffc5c 100644 --- a/docs/general-development/how-to-configure-item-level-security-in-sharepoint.md +++ b/docs/general-development/how-to-configure-item-level-security-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Configure item-level security in SharePoint +description: Learn how to configure item level security when crawling external data with BCS indexing connectors in SharePoint. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: ffd730f2-e7b7-4707-b677-d073da7df7d7 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -139,7 +139,7 @@ The following code is the method signature for the method that is specified in t -```cs +```csharp Public static Byte[]GetItemSecurity (string id) { @@ -156,7 +156,7 @@ If the external system does not support NTLM authentication, but the external sy -```cs +```csharp /// Returns the security descriptor for a user. /// diff --git a/docs/general-development/how-to-configure-msmq-for-sharepoint-workflows.md b/docs/general-development/how-to-configure-msmq-for-sharepoint-workflows.md index f99368596..42a103338 100644 --- a/docs/general-development/how-to-configure-msmq-for-sharepoint-workflows.md +++ b/docs/general-development/how-to-configure-msmq-for-sharepoint-workflows.md @@ -1,9 +1,9 @@ --- title: Configure MSMQ for SharePoint workflows -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to configure Microsoft Message Queuing (MSMQ) for asynchronous event messaging in SharePoint workflows. +ms.date: 06/09/2022 ms.assetid: c0e130f6-c210-44ea-83ed-b327f04551d6 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-convert-an-add-in-scoped-external-content-type-to-tenant-scoped.md b/docs/general-development/how-to-convert-an-add-in-scoped-external-content-type-to-tenant-scoped.md index f67e033fa..6356260f8 100644 --- a/docs/general-development/how-to-convert-an-add-in-scoped-external-content-type-to-tenant-scoped.md +++ b/docs/general-development/how-to-convert-an-add-in-scoped-external-content-type-to-tenant-scoped.md @@ -1,9 +1,9 @@ --- title: Convert an add-in-scoped external content type to tenant-scoped -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to create an OData-based external content type using Visual Studio 2012 and import it into the BCS metadata store. +ms.date: 06/09/2022 ms.assetid: 35c5d670-e402-4641-b3c5-6f61ae1ec69b -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-convert-an-html-file-into-a-master-page-in-sharepoint.md b/docs/general-development/how-to-convert-an-html-file-into-a-master-page-in-sharepoint.md index 04bfe4ada..b5b31ff91 100644 --- a/docs/general-development/how-to-convert-an-html-file-into-a-master-page-in-sharepoint.md +++ b/docs/general-development/how-to-convert-an-html-file-into-a-master-page-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Convert an .html file into a master page in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to convert an .html into a SharePoint master page .master file and provides steps and code examples. +ms.date: 06/09/2022 ms.assetid: a76ab289-3256-45de-ac63-d5112a74e3c7 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/how-to-crawl-associated-external-content-types-in-sharepoint.md b/docs/general-development/how-to-crawl-associated-external-content-types-in-sharepoint.md index d944b9baa..5ad7dcbe7 100644 --- a/docs/general-development/how-to-crawl-associated-external-content-types-in-sharepoint.md +++ b/docs/general-development/how-to-crawl-associated-external-content-types-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Crawl associated external content types in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to use the search properties in the Business Data Connectivity (BDC) service metadata model for crawling associations. +ms.date: 06/09/2022 ms.assetid: 187ec42e-f749-4e22-abef-1df604143063 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-crawl-binary-large-objects-blobs-in-sharepoint.md b/docs/general-development/how-to-crawl-binary-large-objects-blobs-in-sharepoint.md index 9ff908486..ba87852cd 100644 --- a/docs/general-development/how-to-crawl-binary-large-objects-blobs-in-sharepoint.md +++ b/docs/general-development/how-to-crawl-binary-large-objects-blobs-in-sharepoint.md @@ -2,9 +2,8 @@ title: Crawl binary large objects (BLOBs) in SharePoint description: Learn how to modify the BDC model file for a database BCS indexing connector to enable the Search in SharePoint crawler to crawl binary large object (BLOB) data stored in a SQL Server database. ms.date: 12/22/2020 -ms.prod: sharepoint ms.assetid: 99b3dd51-1651-4300-a2de-33681f4cc258 -localization_priority: Normal +ms.localizationpriority: medium --- # Crawl binary large objects (BLOBs) in SharePoint diff --git a/docs/general-development/how-to-create-a-claims-provider-in-sharepoint.md b/docs/general-development/how-to-create-a-claims-provider-in-sharepoint.md index 9b1e82d88..9efdab73d 100644 --- a/docs/general-development/how-to-create-a-claims-provider-in-sharepoint.md +++ b/docs/general-development/how-to-create-a-claims-provider-in-sharepoint.md @@ -1,67 +1,68 @@ --- title: Create a claims provider in SharePoint +description: Learn how to create and implement a SharePoint claims provider that fulfills the requirements for claims augmentation and claims picking. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: 8f3228ca-57fd-4253-a07d-abeb63298c58 -localization_priority: Normal +ms.localizationpriority: medium --- # Create a claims provider in SharePoint Learn how to create and implement a SharePoint claims provider that fulfills the requirements for claims augmentation and claims picking. + A claims provider issues claims and packages claims into security tokens. A claims provider has two roles: augmentation and picking. - - - + + + Claims augmentation enables an application to augment additional claims into the user's token. For example, with Windows-based log-in, the Active Directory directory service can augment all of a user's security groups into the user's Windows token. With claims-based log-in, a customer relationship management (CRM) application can augment roles from a CRM database. By having these claims in the user's token, resources can be authorized against these claims. That is, these claims are used to determine whether a particular user has access to specific resources. Claims can be displayed in the people picker control through claims picking. Claims picking enables an application to surface claims in the people picker, for example, when configuring the security of a SharePoint site or SharePoint service. This functionality enables you to provide search, resolve, and friendly display of claims. - + > [!NOTE] -> A people picker with claims picking functionality is sometimes referred to as a claims picker. For more information, see [People picker and claims provider planning](https://technet.microsoft.com/library/gg602063.aspx). - - - +> A people picker with claims picking functionality is sometimes referred to as a claims picker. For more information, see [People picker and claims provider planning](https://technet.microsoft.com/library/gg602063.aspx). + + + To write a claims provider, your first step is to create a class that derives from the **SPClaimProvider** class. > **Tip:** -> For a code example and more information about the **SPClaimProvider** class and its members, see [SPClaimProvider](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaimProvider.aspx) . For walkthroughs, tips, and code samples, see [Claims and Security: Technical articles and code samples on MSDN](https://msdn.microsoft.com/library/f773fd4a-53ec-4656-bd08-e6c435e6f103%28Office.15%29.aspx). - - - +> For a code example and more information about the **SPClaimProvider** class and its members, see [SPClaimProvider](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaimProvider.aspx) . For walkthroughs, tips, and code samples, see [Claims and Security: Technical articles and code samples on MSDN](https://msdn.microsoft.com/library/f773fd4a-53ec-4656-bd08-e6c435e6f103%28Office.15%29.aspx). + + + ## Required implementations The following are required methods and properties when writing a claims provider. - - - + + + ### Required The following [Name](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaimProvider.Name.aspx) property is a required property. The name should be unique across the farm. - - - -```cs + + + +```csharp public abstract String Name - + ``` ### Required for claims picker Claims can be displayed in the people picker control through claims picking. The following methods in the [SPClaimProvider](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaimProvider.aspx) class are required methods if you want to implement claim picking in the people picker control. - - - -```cs + + + +```csharp protected abstract void FillSchema(SPProviderSchema schema); protected abstract void FillClaimTypes(List claimTypes); @@ -74,11 +75,11 @@ protected abstract void FillSchema(SPProviderSchema schema); ### Required for claims augmentation When you include additional claims in a user's security token, you are augmenting claims. If you want to augment claims, you must implement the following methods in the [SPClaimProvider](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaimProvider.aspx) class. - - - -```cs + + + +```csharp public abstract bool SupportsEntityInformation protected abstract void FillClaimsForEntity(Uri context, SPClaim entity, List claims); @@ -89,11 +90,11 @@ public abstract bool SupportsEntityInformation ### Required for displaying hierarchy on the left pane of the claims picker If you want to display hierarchy on the left pane of the claims picker, you must implement the following methods in the [SPClaimProvider](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaimProvider.aspx) class. - - - -```cs + + + +```csharp public abstract bool SupportsHierarchy protected abstract void FillHierarchy(Uri context, String[] entityTypes, String hierarchyNodeID, int numberOfLevels, bool includeEntityData, SPProviderHierarchyTree hierarchy); @@ -104,11 +105,11 @@ public abstract bool SupportsHierarchy ### Required for resolving claims in the type-in control of the claims picker If you want to be able to resolve claims by using the type-in control of the claims picker, you must implement the following methods in the [SPClaimProvider](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaimProvider.aspx) class. - - - -```cs + + + +```csharp public abstract bool SupportsResolve protected abstract void FillResolve(Uri context, String[] entityTypes, String resolveInput, List resolved); @@ -120,11 +121,11 @@ public abstract bool SupportsResolve ### Required for searching for claims in the claims picker If you want to be able to search for claims in the claims picker, you must implement the following property and method in the [SPClaimProvider](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaimProvider.aspx) class. - - - -```cs + + + +```csharp public abstract bool SupportsSearch protected abstract void FillSearch(Uri context, String[] entityTypes, String searchPattern, String hierarchyNodeID, int maxCount, SPProviderHierarchyTree searchTree); @@ -136,18 +137,18 @@ public abstract bool SupportsSearch You can also implement a helper method to help you create [SPClaim](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaim.aspx) objects. - - - + + + ### Useful helper method for creating SPClaim objects The following is a helper method that you can implement to help you create [SPClaim](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaim.aspx) objects. - - - -```cs + + + +```csharp protected SPClaim CreateClaim(String claimType, String value, String valueType) ``` @@ -158,15 +159,15 @@ protected SPClaim CreateClaim(String claimType, String value, String valueType) - [Claims-based identity in SharePoint](claims-based-identity-in-sharepoint.md) - - + + - [Incoming claims: Signing into SharePoint](incoming-claims-signing-into-sharepoint.md) - - + + - [Claims provider in SharePoint](claims-provider-in-sharepoint.md) - - + + - [How to: Deploy a claims provider in SharePoint](how-to-deploy-a-claims-provider-in-sharepoint.md) - - + + diff --git a/docs/general-development/how-to-create-a-mashup-that-uses-an-embedded-workbook-and-bing-maps.md b/docs/general-development/how-to-create-a-mashup-that-uses-an-embedded-workbook-and-bing-maps.md index 0f0d50bdf..52c8d32d9 100644 --- a/docs/general-development/how-to-create-a-mashup-that-uses-an-embedded-workbook-and-bing-maps.md +++ b/docs/general-development/how-to-create-a-mashup-that-uses-an-embedded-workbook-and-bing-maps.md @@ -2,9 +2,8 @@ title: Create a mashup that uses an embedded workbook and Bing Maps description: This article walks you through a powerful Web-based mashup that combines an embedded Excel workbook and Bing Maps. ms.date: 12/22/2020 -ms.prod: sharepoint ms.assetid: 3cfeb8d7-84b8-4673-bc92-b176cba4ac3e -localization_priority: Normal +ms.localizationpriority: medium --- # Create a mashup that uses an embedded workbook and Bing Maps diff --git a/docs/general-development/how-to-create-a-master-page-preview-file-in-sharepoint.md b/docs/general-development/how-to-create-a-master-page-preview-file-in-sharepoint.md index e93d6d3b2..6706a4a0b 100644 --- a/docs/general-development/how-to-create-a-master-page-preview-file-in-sharepoint.md +++ b/docs/general-development/how-to-create-a-master-page-preview-file-in-sharepoint.md @@ -2,9 +2,8 @@ title: Create a master page preview file in SharePoint description: Learn how to create master page preview files that are used in the SharePoint theming experience to display a preview of selected theme components. ms.date: 01/06/2021 -ms.prod: sharepoint ms.assetid: 6825518d-eeb2-40b0-8a5b-897025f13796 -localization_priority: Normal +ms.localizationpriority: medium --- # Create a master page preview file in SharePoint @@ -157,4 +156,4 @@ To create a master page preview file, use an existing master page preview as a s - [Develop the site design in SharePoint](develop-the-site-design-in-sharepoint.md) - [How to: Deploy a custom theme in SharePoint](how-to-deploy-a-custom-theme-in-sharepoint.md) - [Color palettes and fonts in SharePoint](color-palettes-and-fonts-in-sharepoint.md) -- [SharePoint Team Blog: Show off your style with SharePoint theming](https://www.microsoft.com/en-us/microsoft-365/blog/2012/10/29/show-off-your-style-with-sharepoint-theming/) +- [SharePoint Team Blog: Show off your style with SharePoint theming](https://www.microsoft.com/microsoft-365/blog/2012/10/29/show-off-your-style-with-sharepoint-theming/) diff --git a/docs/general-development/how-to-create-a-minimal-master-page-in-sharepoint.md b/docs/general-development/how-to-create-a-minimal-master-page-in-sharepoint.md index 919eebf0b..b0cb20c99 100644 --- a/docs/general-development/how-to-create-a-minimal-master-page-in-sharepoint.md +++ b/docs/general-development/how-to-create-a-minimal-master-page-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Create a minimal master page in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to create a minimal master page in SharePoint, which contains only elements that SharePoint requires to render the page. +ms.date: 06/09/2022 ms.assetid: 634aa471-07e1-41d6-aa80-27f7ef7e9dc8 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/how-to-create-a-mobile-app-in-sharepoint-that-contains-data-from-an-externa.md b/docs/general-development/how-to-create-a-mobile-app-in-sharepoint-that-contains-data-from-an-externa.md index e1220d8f0..1bd7f6084 100644 --- a/docs/general-development/how-to-create-a-mobile-app-in-sharepoint-that-contains-data-from-an-externa.md +++ b/docs/general-development/how-to-create-a-mobile-app-in-sharepoint-that-contains-data-from-an-externa.md @@ -1,9 +1,9 @@ --- title: Create a mobile app in SharePoint that contains data from an external data source -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to create a mobile app in SharePoint that contains data from an external data source by using Business Connectivity Services. +ms.date: 06/09/2022 ms.assetid: f1d62256-aca0-4a59-8145-0add9e68a449 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -287,7 +287,7 @@ Now that the app is ready to run, you can test it using phone emulator. - [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md) -- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=27570) +- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=29233) - [Microsoft SharePoint SDK for Windows Phone 7.1](https://www.microsoft.com/download/details.aspx?id=30476) diff --git a/docs/general-development/how-to-create-a-page-layout-in-sharepoint.md b/docs/general-development/how-to-create-a-page-layout-in-sharepoint.md index 4f59d95e6..7b226bd53 100644 --- a/docs/general-development/how-to-create-a-page-layout-in-sharepoint.md +++ b/docs/general-development/how-to-create-a-page-layout-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Create a page layout in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to create a page layout using Design Manager in SharePoint and provides steps and code examples. +ms.date: 06/09/2022 ms.assetid: 5447e6a1-2f14-4667-81d0-7514b468be80 -localization_priority: Priority +ms.localizationpriority: high --- @@ -98,7 +98,7 @@ If you're using Design Manager to create page layouts and master pages, the most - **PlaceHolderMain** The master page contains a content placeholder with `ID="PlaceholderMain"`, which contains the **DefaultContentBlock** `
    ` tag with the yellow box that shows **This area will be filled in by content you create in your page layouts.** You should not put any content inside this placeholder on the master page. The page layout contains a content placeholder with the same ID. You should put markup only inside this placeholder, and put no markup outside this placeholder, on a page layout. The IDs for the two placeholders ( **PlaceholderMain**) should match. -- **PlaceHolderAdditionalPageHead** When you work with a page layout, you typically don't insert elements into the **** tag of the page layout. Instead, you add elements to the content placeholder with `id="PlaceHolderAdditionalPageHead"`. When a content page is rendered in the browser, this additional page head gets merged into the end of the head of the master page. +- **PlaceHolderAdditionalPageHead** When you work with a page layout, you typically don't insert elements into the `` tag of the page layout. Instead, you add elements to the content placeholder with `id="PlaceHolderAdditionalPageHead"`. When a content page is rendered in the browser, this additional page head gets merged into the end of the head of the master page. @@ -184,7 +184,7 @@ When you create HTML mockups for your site, you may have HTML files that represe -You can simply put the styles for one or more page layouts into the same style sheet that the master page links to. But, if you want to minimize the weight of the CSS that is loaded per page, you can also use different style sheets for different page layouts. When you do this, it's important to know that a link to a style sheet cannot go in the **** tag of a page layout. Instead, the link must go in the content placeholder named **PlaceHolderAdditionalPageHead**. +You can simply put the styles for one or more page layouts into the same style sheet that the master page links to. But, if you want to minimize the weight of the CSS that is loaded per page, you can also use different style sheets for different page layouts. When you do this, it's important to know that a link to a style sheet cannot go in the `` tag of a page layout. Instead, the link must go in the content placeholder named **PlaceHolderAdditionalPageHead**. > [!NOTE] > In this markup, the attribute `ms-design-css-conversion="no"` excludes the style sheet from theming. Also, the link to the style sheet should appear after the lines commented ** @@ -65,119 +40,60 @@ If you want an HTML **\** tag in the page layout, you should put the form ``` You can also add the HTML Form web part or the InfoPath Form web part to your page from the Snippet Gallery. For more information, see [SharePoint Design Manager snippets](sharepoint-design-manager-snippets.md). - - - ## HTML file must be XML-compliant - - ### Message - **SharePoint requires HTML files to be XML-compliant. Your file isn't XML-compliant, likely because of tag properties without quotes, missing closing tags, or invalid properties in tags. {Type of error, location of error}. Occurred at: {Time}.** - - - +**SharePoint requires HTML files to be XML-compliant. Your file isn't XML-compliant, likely because of tag properties without quotes, missing closing tags, or invalid properties in tags. {Type of error, location of error}. Occurred at: {Time}.** ### Resolution For an HTML file to be converted into the corresponding ASP.NET file, the HTML file must be XML-compliant. This error identifies specific markup in your HTML file that is not XML-compliant. Run the HTML file through an XML validator, fix any issues in your HTML editor, save the file, and then refresh the preview. - -> [!NOTE] -> This requirement overrides some HTML 5 standards. For example, in HTML 5 you can specify the doctype in lowercase, but in XML the doctype must be uppercase. - - - - - - - +> [!NOTE] +> This requirement overrides some HTML 5 standards. For example, in HTML 5 you can specify the doctype in lowercase, but in XML the doctype must be uppercase. ## HTML file contains problematic markup - - ### Message - **SharePoint can't parse this file, most likely because of an incorrectly formatted SharePoint snippet. The markup at the following location is causing problems. Edit the markup manually to fix it, or replace it with a new snippet from the Snippet Gallery. {Type of error, location of error}. Occurred at: {Time}.** - - - +**SharePoint can't parse this file, most likely because of an incorrectly formatted SharePoint snippet. The markup at the following location is causing problems. Edit the markup manually to fix it, or replace it with a new snippet from the Snippet Gallery. {Type of error, location of error}. Occurred at: {Time}.** ### Resolution -You see this error when there is a problem with a SharePoint snippet in your HTML file. To fix this error, undo whatever change caused the error, or replace the problematic snippet with a new one, either from the Snippet Gallery or from a different master page or page layout file that has a working version of the snippet. In your HTML editor, after you fix or replace the snippet, save the page, and then refresh the preview. - - - - -## Master page for a page layout has changed - - +You see this error when there is a problem with a SharePoint snippet in your HTML file. To fix this error, undo whatever change caused the error, or replace the problematic snippet with a new one, either from the Snippet Gallery or from a different master page or page layout file that has a working version of the snippet. In your HTML editor, after you fix or replace the snippet, save the page, and then refresh the preview.## Master page for a page layout has changed ### Message **This page layout's master page has changed, which will cause inconsistencies across your site. Click here to update the sections of your page layout that represent master page regions.** - - - ### Resolution For a page layout to work with a given master page, the two must have the same set of content placeholders. If you create a page layout based on a particular master page, and then edit that HTML master page, you'll see this message. Even if you know that changes to the master page didn't add or remove content placeholders, you should update the content regions of your page layout anyway, so that you can preview any changes from the master page that might affect your page layout. - - - ## Reset the preview - - ### Message - **Your master page (page layout) doesn't have any warnings or errors. Reset the preview to its original state.** - - - +**Your master page (page layout) doesn't have any warnings or errors. Reset the preview to its original state.** ### Explanation This message simply confirms that the conversion process worked with no errors or issues. However, when you preview a page, you may navigate away from that specific page or change the preview in some other way. If this happens, you can always choose **Reset the preview** in the message area. Doing so refreshes the preview so that it uses the specific master page or page layout that you're working on, and whatever page you've selected in the **Change Preview Page** option in the upper-left corner. - - - ## Change the preview page - - ### Message - **You're currently previewing your master page (page layout) without any content. You can change the page you're previewing from the menu above.** - - - +**You're currently previewing your master page (page layout) without any content. You can change the page you're previewing from the menu above.** ### Explanation You see this message when you aren't using a live SharePoint page with which to preview your master page or page layout. For example, if you're previewing a page layout, you can choose **Change Preview Page** in the upper-left corner, and then select a specific content page to preview with your page layout. This way, you can preview the page layout with actual page content in the page fields. If you want the preview to show just the positions of **ContentPlaceHolderMain** or page fields, you can always use **Change Preview Page** to switch back to a generic preview. - - - ## See also - - - -- [Develop the site design in SharePoint](develop-the-site-design-in-sharepoint.md) - - -- [How to: Change the preview page in SharePoint Design Manager](how-to-change-the-preview-page-in-sharepoint-design-manager.md) - - -- [SharePoint Design Manager snippets](sharepoint-design-manager-snippets.md) - - +- [Develop the site design in SharePoint](develop-the-site-design-in-sharepoint.md) +- [How to: Change the preview page in SharePoint Design Manager](how-to-change-the-preview-page-in-sharepoint-design-manager.md) +- [SharePoint Design Manager snippets](sharepoint-design-manager-snippets.md) \ No newline at end of file diff --git a/docs/general-development/how-to-restrict-udf-code-access-security-permissions.md b/docs/general-development/how-to-restrict-udf-code-access-security-permissions.md index c95b9c62c..ccadfd1ac 100644 --- a/docs/general-development/how-to-restrict-udf-code-access-security-permissions.md +++ b/docs/general-development/how-to-restrict-udf-code-access-security-permissions.md @@ -1,12 +1,12 @@ --- title: Restrict UDF code access security permissions +description: "If you do not want a particular user-defined function (UDF) assembly to run with full trust, you must explicitly restrict code access security permissions for it." ms.date: 09/25/2017 keywords: cas,how to,howdoi,howto,UDF list f1_keywords: - cas,how to,howdoi,howto,UDF list -ms.prod: sharepoint ms.assetid: 4f022e0d-1fe3-4fab-b41f-82a0d628f77c -localization_priority: Normal +ms.localizationpriority: medium --- @@ -134,5 +134,5 @@ For more information about configuring code groups, see the following articles o - [How to: Access an External Data Source from a UDF](how-to-access-an-external-data-source-from-a-udf.md) - [How to: Deploy UDFs Using SharePoint Foundation Solutions](how-to-deploy-udfs-using-sharepoint-foundation-solutions.md) - [Walkthrough: Developing a Managed-Code UDF](walkthrough-developing-a-managed-code-udf.md) -- [Frequently Asked Questions About Excel Services UDFs](frequently-asked-questions-about-excel-services-udfs.md) +- [Frequently Asked Questions About Excel Services UDFs](frequently-asked-questions-about-excel-services-udfs.yml) - [Understanding Excel Services UDFs](understanding-excel-services-udfs.md) diff --git a/docs/general-development/how-to-retrieve-the-url-of-a-pages-library.md b/docs/general-development/how-to-retrieve-the-url-of-a-pages-library.md index 2a0c8944d..f8baa97b7 100644 --- a/docs/general-development/how-to-retrieve-the-url-of-a-pages-library.md +++ b/docs/general-development/how-to-retrieve-the-url-of-a-pages-library.md @@ -1,9 +1,9 @@ --- title: Retrieve the URL of a Pages library +description: Learn how to retrieve the URL for the pages list for a publishing web in a site collection that differs from the current context. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: d9922e4b-4948-4c4a-a8ca-1623168143a3 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -61,7 +61,7 @@ The application queries the [SPPropertyBag](https://msdn.microsoft.com/library/ -```cs +```csharp using System; using System.Collections; diff --git a/docs/general-development/how-to-retrieve-user-profile-properties-by-using-the-javascript-object-model-in.md b/docs/general-development/how-to-retrieve-user-profile-properties-by-using-the-javascript-object-model-in.md index 5fb7e3210..9d31446f2 100644 --- a/docs/general-development/how-to-retrieve-user-profile-properties-by-using-the-javascript-object-model-in.md +++ b/docs/general-development/how-to-retrieve-user-profile-properties-by-using-the-javascript-object-model-in.md @@ -1,9 +1,9 @@ --- title: Retrieve user profile properties by using the JavaScript object model in SharePoint +description: Learn how to retrieve user properties and user profile properties programmatically by using the SharePoint JavaScript object model. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: c6e1ca38-134f-428a-8d21-b8b2615b161b -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/how-to-retrieve-user-profile-properties-by-using-the-net-client-object-model-in.md b/docs/general-development/how-to-retrieve-user-profile-properties-by-using-the-net-client-object-model-in.md index 8acafb9d8..8a5a5f069 100644 --- a/docs/general-development/how-to-retrieve-user-profile-properties-by-using-the-net-client-object-model-in.md +++ b/docs/general-development/how-to-retrieve-user-profile-properties-by-using-the-net-client-object-model-in.md @@ -1,9 +1,9 @@ --- title: Retrieve user profile properties by using the .NET client object model in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Learn how to retrieve user profile properties programmatically by using the SharePoint .NET client object model. +ms.date: 06/13/2022 ms.assetid: 236ebaf8-f92e-4192-9b51-0a9de0210885 -localization_priority: Priority +ms.localizationpriority: high --- @@ -90,7 +90,7 @@ To create a console application that uses the .NET client object model to retrie 6. In the **Main** method, define variables for the server URL and the target user name, as shown in the following code. -```cs +```csharp const string serverUrl = "http://serverName/"; const string targetUser = "domainName\\userName"; ``` @@ -99,13 +99,13 @@ const string targetUser = "domainName\\userName"; 7. Initialize the SharePoint client context, as shown in the following code. -```cs +```csharp ClientContext clientContext = new ClientContext(serverUrl); ``` 8. Get the target user's properties from the **PeopleManager** object, as shown in the following code. -```cs +```csharp PeopleManager peopleManager = new PeopleManager(clientContext); PersonProperties personProperties = peopleManager.GetPropertiesFor(targetUser); ``` @@ -115,7 +115,7 @@ PersonProperties personProperties = peopleManager.GetPropertiesFor(targetUser); 9. To initialize the **personProperties** object, register the request that you want to run, and then run the request on the server, as shown in the following code. -```cs +```csharp clientContext.Load(personProperties, p => p.AccountName, p => p.UserProfileProperties); clientContext.ExecuteQuery(); ``` @@ -126,7 +126,7 @@ clientContext.ExecuteQuery(); 10. Iterate through the user profile properties and read the name and value of each property, as shown in the following code. -```cs +```csharp foreach (var property in personProperties.UserProfileProperties) { Console.WriteLine(string.Format("{0}: {1}", @@ -147,7 +147,7 @@ The following code example shows how to retrieve and iterate through all the use -```cs +```csharp using System; using System.Collections.Generic; @@ -203,7 +203,7 @@ The following code example shows how to get, in a SharePoint Add-in, the user pr -```cs +```csharp string contextTokenString = TokenHelper.GetContextTokenFromRequest(Request); @@ -241,7 +241,7 @@ The following code example shows how to retrieve a specific set of user profile -Unlike the previous code example that retrieves a [PersonProperties](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.UserProfiles.PersonProperties.aspx) object for the target user, this example calls the [PeopleManager.GetUserProfilePropertiesFor](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.UserProfiles.PeopleManager.GetUserProfilePropertiesFor.aspx) method and passes in a [UserProfilePropertiesForUser](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.UserProfiles.UserProfilePropertiesForUser.aspx) object that specifies the target user and the user profile properties to retrieve. [GetUserProfilePropertiesFor](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.UserProfiles.PeopleManager.GetUserProfilePropertiesFor.aspx) returns an **IEnumerable** collection that contains the values of the properties that you specify. +Unlike the previous code example that retrieves a [PersonProperties](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.UserProfiles.PersonProperties.aspx) object for the target user, this example calls the [PeopleManager.GetUserProfilePropertiesFor](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.UserProfiles.PeopleManager.GetUserProfilePropertiesFor.aspx) method and passes in a [UserProfilePropertiesForUser](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.UserProfiles.UserProfilePropertiesForUser.aspx) object that specifies the target user and the user profile properties to retrieve. [GetUserProfilePropertiesFor](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.UserProfiles.PeopleManager.GetUserProfilePropertiesFor.aspx) returns an **IEnumerable\** collection that contains the values of the properties that you specify. > [!NOTE] > Replace the `http://serverName/` and `domainName\\\\userName` placeholder values before you run the code. @@ -252,7 +252,7 @@ Unlike the previous code example that retrieves a [PersonProperties](https://ms -```cs +```csharp using System; using System.Collections.Generic; diff --git a/docs/general-development/how-to-save-from-excel-client-to-the-server.md b/docs/general-development/how-to-save-from-excel-client-to-the-server.md index 29454489c..452851cce 100644 --- a/docs/general-development/how-to-save-from-excel-client-to-the-server.md +++ b/docs/general-development/how-to-save-from-excel-client-to-the-server.md @@ -1,12 +1,12 @@ --- title: Save from Excel client to the server -ms.date: 09/25/2017 +description: Describes how to create a workbook with editable ranges, save it to a trusted SharePoint document library, and change values in the workbook. +ms.date: 06/13/2022 keywords: how to,howdoi,howto f1_keywords: - how to,howdoi,howto -ms.prod: sharepoint ms.assetid: 28716ba5-0774-44df-833b-0034d2c63319 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-save-to-the-server-to-prepare-for-programmatic-access.md b/docs/general-development/how-to-save-to-the-server-to-prepare-for-programmatic-access.md index 0d82087b4..482c58790 100644 --- a/docs/general-development/how-to-save-to-the-server-to-prepare-for-programmatic-access.md +++ b/docs/general-development/how-to-save-to-the-server-to-prepare-for-programmatic-access.md @@ -5,9 +5,8 @@ ms.date: 01/05/2020 keywords: how to,howdoi,howto f1_keywords: - how to,howdoi,howto -ms.prod: sharepoint ms.assetid: 80b34a29-3d40-4d11-9ba1-b4886ffcfd42 -localization_priority: Normal +ms.localizationpriority: medium --- # Save to the server to prepare for programmatic access @@ -71,7 +70,7 @@ In this example, _args [1]_ is **MyParam**, **args [2]** is _28_ and _GetSnapsh 1. Following is the signature for the **SetCellA1** method in Excel Web Services: - ```cs + ```csharp public void SetCellA1 ( string sessionId, string sheetName, diff --git a/docs/general-development/how-to-set-the-bing-maps-key-at-the-web-and-farm-level-in-sharepoint.md b/docs/general-development/how-to-set-the-bing-maps-key-at-the-web-and-farm-level-in-sharepoint.md index 64a734e0d..19bc3f0c2 100644 --- a/docs/general-development/how-to-set-the-bing-maps-key-at-the-web-and-farm-level-in-sharepoint.md +++ b/docs/general-development/how-to-set-the-bing-maps-key-at-the-web-and-farm-level-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Set the Bing Maps key at the web and farm level in SharePoint -ms.date: 06/05/2020 -ms.prod: sharepoint +description: Learn how to set the Bing Maps key programmatically at the web (SharePoint Server and SharePoint Online) and farm (SharePoint Server) level by using the SharePoint client object model and Windows PowerShell, to enable the Bing Maps functionality in SharePoint lists and location-based web and mobile apps. +ms.date: 01/06/2023 ms.assetid: 507ed9de-c349-44b5-b182-e838795dd862 -localization_priority: Normal +ms.localizationpriority: medium --- # Set the Bing Maps key at the web and farm level in SharePoint @@ -32,48 +32,48 @@ To follow the steps in this example, you should have the following: The Bing Maps key can be set at the farm or web level. To set the Bing Maps key at the farm level, you need administrator rights on the server; you can then add the key by using the SharePoint Management Shell. To set the Bing Maps key at the web level, write a console application that uses the SharePoint client object model or leverage SharePoint PnP PowerShell. - + > [!TIP] -> The Bing Maps key set at web level has higher precedence order than the Bing Maps key set at farm level. +> The Bing Maps key set at web level has higher precedence order than the Bing Maps key set at farm level. ### To set the Bing Maps key at the farm level using Windows PowerShell 1. Log on to the SharePoint server as an administrator, and open the SharePoint Management Shell. - - -2. Execute the following command: - + + +2. Execute the following command: + `Set-SPBingMapsKey -BingKey ""` - - The Bing Maps key is now set at the farm level in SharePoint. - + + The Bing Maps key is now set at the farm level in SharePoint. + > [!NOTE] -> When you use Windows PowerShell, the Bing Maps key can be set only at the farm level. If you want to set the Bing Maps key at the web level, you can set the key programmatically, as shown in the following section. +> When you use Windows PowerShell, the Bing Maps key can be set only at the farm level. If you want to set the Bing Maps key at the web level, you can set the key programmatically, as shown in the following section. ### To set the Bing Maps key at the web level with SharePoint PnP PowerShell 1. Open the SharePoint Online Management Shell 2. Connect to the site you want to add/update the Bing Maps key -```cs +```powershell Connect-PnPOnline -url "https://TENANT.sharepoint.com/sites/SITEURL" ``` 3. Add the Bing Maps Key to the Site Property Bag (Update "YOURKEYVALUE") -```cs +```powershell Set-PnPPropertyBagValue -Key "BING_MAPS_KEY" -Value "YOURKEYVALUE" ``` 4. If you receive an error regarding NoScript being enabled, you must disable it in the site. Then rerun step 3. -```cs -Set-SPOsite -DenyAddAndCustomizePages 0 +```powershell +Set-PnPSite -NoScriptSite $false ``` - + > [!NOTE] -> Ensure you understand the implications of changing a site's NoScript Policy - https://docs.microsoft.com/sharepoint/allow-or-prevent-custom-script?redirectSourcePath=%252fen-us%252farticle%252fTurn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f +> Ensure you understand the implications of changing a site's NoScript Policy - [Allow or prevent custom script](/sharepoint/allow-or-prevent-custom-script). ### To set the Bing Maps key at the farm or web level using the client object model with Visual Studio @@ -81,13 +81,13 @@ Set-SPOsite -DenyAddAndCustomizePages 0 1. Start Visual Studio. 2. On the menu bar, choose **File**, **New Project**. The **New Project** dialog box opens. - + 3. In the **New Project** dialog box, choose **C#** in the **Installed Templates** box, and then choose the **Console Application** template. 4. Give the project a name, and then choose the **OK** button. - + 5. Visual Studio creates the project. Add a reference to the following assemblies, and choose **OK**. - + - Microsoft.SharePoint.Client.dll - Microsoft.SharePoint.Client.Runtime.dll @@ -96,8 +96,8 @@ Set-SPOsite -DenyAddAndCustomizePages 0 7. Add the following code to the Main method in the .cs file. -```cs - +```csharp + class Program { static void Main(string[] args) @@ -113,19 +113,19 @@ class Program web.AllProperties["BING_MAPS_KEY"] = "" web.Update(); context.ExecuteQuery(); - } + } } ``` -8. Replace the and __ with valid values. +8. Replace the \; and _\_ with valid values. 9. Set the target framework in Project Properties as .NET Framework 4.0, and run the example. -10. The key should now be set at the web level. +10. The key should now be set at the web level. ## Next steps To learn more about working with location and map functionality in SharePoint, see the following: -- [How to: Add a Geolocation column to a list programmatically in SharePoint](how-to-add-a-geolocation-column-to-a-list-programmatically-in-sharepoint.md) -- [How to: Extend the Geolocation field type using client-side rendering](how-to-extend-the-geolocation-field-type-using-client-side-rendering.md) +- [How to: Add a Geolocation column to a list programmatically in SharePoint](how-to-add-a-geolocation-column-to-a-list-programmatically-in-sharepoint.md) +- [How to: Extend the Geolocation field type using client-side rendering](how-to-extend-the-geolocation-field-type-using-client-side-rendering.md) diff --git a/docs/general-development/how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md b/docs/general-development/how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md index 94fd15b8d..3895eb84c 100644 --- a/docs/general-development/how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md +++ b/docs/general-development/how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md @@ -1,9 +1,9 @@ --- title: Set up an environment for developing mobile apps for SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes the system requirements and configuring a development environment for SharePoint mobility projects. +ms.date: 06/13/2022 ms.assetid: acaf556d-e20d-478d-8c59-2efd8efb9dcb -localization_priority: Normal +ms.localizationpriority: medium --- @@ -87,7 +87,7 @@ To develop SharePoint Add-ins for use on Windows Phone 7, you need to set up you -1. On a computer with a supported client operating system, install [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=27570). +1. On a computer with a supported client operating system, install [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=29233). > [!NOTE] > An earlier version of the Windows Phone SDK was named the Windows Phone Developer Tools. diff --git a/docs/general-development/how-to-set-values-of-ranges.md b/docs/general-development/how-to-set-values-of-ranges.md index 86c792077..808e527e8 100644 --- a/docs/general-development/how-to-set-values-of-ranges.md +++ b/docs/general-development/how-to-set-values-of-ranges.md @@ -1,12 +1,12 @@ --- title: Set values of ranges +description: "Excel Web Services exposes four methods for setting values into an Excel workbook: SetCell, SetCellA1, SetRange, and SetRangeA1." ms.date: 09/25/2017 keywords: how to,howdoi,howto,set range f1_keywords: - how to,howdoi,howto,set range -ms.prod: sharepoint ms.assetid: ccc7e204-f857-45a9-81ec-3a8484e6d454 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -29,7 +29,7 @@ Use the **SetCell** and **SetCellA1** methods to set values in a single cell. If Methods that have the A1 suffix ( **SetCellA1** and **SetRangeA1**) use a different coordinate system than those that do not ( **SetCell** and **SetRange**). If you want to use Excel-style references to cells, such as range references (for example, H8, A3:D5, Sheet2!A12:G18) or named ranges, you should use the methods with the A1 suffix. Those methods allow you to pass in the name of a sheet and range.If you want to access an Excel range by using a numeric coordinate system, you should use the methods that do not have the A1 suffix. It is easier to use range coordinates when you have code that iterates through a set of cells in a loop, or when the range coordinates are calculated dynamically as part of the algorithm.The row and column coordinates of a cell are 0-based. Therefore, "0,0" will return cell A1, as in this example: -```cs +```csharp // Call the SetCell method to set a value, 8, into a cell. // The cell is in the first row and first column; that is, cell A1. @@ -52,7 +52,7 @@ If you are getting values from multiple adjacent cells, you may want to consider 1. Use the **SetCell** method to set a value in a cell in the open workbook by using numeric range coordinates: -```cs +```csharp // Instantiate the Web service and make a status array object. ExcelService xlservice = new ExcelService(); @@ -104,7 +104,7 @@ xlservice.SetCell(sessionId, sheetName, 8, 1, 28) 2. Use the **SetRange** method to set values in a range in the open workbook by using numeric range coordinates: -```cs +```csharp // Instantiate the Web service and make a status array object. ExcelService xlservice = new ExcelService(); @@ -229,7 +229,7 @@ End Sub 1. Use the **SetCellA1** method to set a value in a cell in the open workbook, using the Excel "A1" range specification: -```cs +```csharp // Instantiate the Web service and make a status array object. ExcelService xlservice = new ExcelService(); @@ -250,7 +250,7 @@ xlservice.SetCellA1(sessionId, String.Empty, "InterestRateParam", 8) 2. Use the **SetRangeA1** method to get a value from a range in the open workbook, using the Excel "A1" range specification: -```cs +```csharp // Instantiate the Web service and make a status array object. ExcelService xlservice = new ExcelService(); diff --git a/docs/general-development/how-to-set-various-credentials.md b/docs/general-development/how-to-set-various-credentials.md index 8b044c8cf..3682a32fe 100644 --- a/docs/general-development/how-to-set-various-credentials.md +++ b/docs/general-development/how-to-set-various-credentials.md @@ -1,9 +1,9 @@ --- title: Set various credentials +description: You must set credentials for your users before they can call Excel Web Services by using your custom application. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: eb819681-5a4f-49ae-b7f4-334366c51112 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -22,7 +22,7 @@ The following code uses the current user's logon credentials to make a request t -```cs +```csharp //Instantiate the Web service. ExcelService xlService = new ExcelService(); @@ -54,7 +54,7 @@ The following code uses the current user's logon credentials to make a request t -```cs +```csharp protected string farmURL, docLibPath, workbookPath, uiCulture, dataCulture, localTempFolder, authenticationType; protected Cookie authCookie; @@ -184,7 +184,7 @@ The following code uses the current user's logon credentials to make a request t -```cs +```csharp //Instantiate the Web service. ExcelService xlService = new ExcelService(); diff --git a/docs/general-development/how-to-specify-a-range-address-and-sheet-name.md b/docs/general-development/how-to-specify-a-range-address-and-sheet-name.md index 651853f86..12f840246 100644 --- a/docs/general-development/how-to-specify-a-range-address-and-sheet-name.md +++ b/docs/general-development/how-to-specify-a-range-address-and-sheet-name.md @@ -1,12 +1,12 @@ --- title: Specify a range address and sheet name +description: This example shows how to specify range addresses by using range coordinates, named ranges, rows, and columns. It also shows how to specify a sheet name and the relationship between a sheet name and a range address. ms.date: 09/25/2017 keywords: how to,howdoi,howto,set range f1_keywords: - how to,howdoi,howto,set range -ms.prod: sharepoint ms.assetid: 8bfefc48-1fbc-4b65-8156-1b7d0a8453ee -localization_priority: Normal +ms.localizationpriority: medium --- @@ -26,7 +26,7 @@ A range specification must contain a sheet name; Excel Web Services does not rec - As part of the range address—for example, "Sheet3!B12:D18"—in which case the sheet name argument can be empty: -```cs +```csharp object[] rangeResult1 = xlservice.GetRangeA1(sessionId, String.Empty, "Sheet2!A12:G18", true, out outStatus); ``` @@ -38,7 +38,7 @@ object[] rangeResult1 = xlservice.GetRangeA1(sessionId, String.Empty, "Sheet2!A1 - In a separate sheet name argument, in which case the range address argument does not have to include the sheet name: -```cs +```csharp xlservice.SetCell(sessionId, "Sheet3", 0, 11, 1000); ``` @@ -49,7 +49,7 @@ object[] rangeResult1 = xlservice.GetRangeA1(sessionId, String.Empty, "Sheet2!A1 - In both the sheet name and range address, in which case the name of the sheet must match: -```cs +```csharp object[] rangeResult = xlservice.GetCellA1(sessionId, "Sheet3", "Sheet3!G18", true, out outStatus); ``` @@ -61,7 +61,7 @@ object[] rangeResult1 = xlservice.GetRangeA1(sessionId, String.Empty, "Sheet2!A1 The only case that does not require a sheet name is a named range, because some named ranges have a workbook scope. For example, you can refer to named ranges without specifying the sheet name argument: -```cs +```csharp xlServices.SetCellA1(sessionId, String.Empty, "MyNamedRange", 8); ``` @@ -82,7 +82,7 @@ If you specify a sheet name, the ranges you reference must exist on the sheet yo -```cs +```csharp using System; using System.Text; using System.Web.Services.Protocols; diff --git a/docs/general-development/how-to-store-and-retrieve-sharepoint-list-items-on-a-windows-phone.md b/docs/general-development/how-to-store-and-retrieve-sharepoint-list-items-on-a-windows-phone.md index 9396268ea..256b3804e 100644 --- a/docs/general-development/how-to-store-and-retrieve-sharepoint-list-items-on-a-windows-phone.md +++ b/docs/general-development/how-to-store-and-retrieve-sharepoint-list-items-on-a-windows-phone.md @@ -1,12 +1,10 @@ --- title: Store and retrieve SharePoint list items on a Windows Phone description: Learn about the Windows Phone application life cycle and storing network data locally. -ms.date: 12/29/2020 -ms.prod: sharepoint +ms.date: 06/13/2022 ms.assetid: 14ca37a2-5b45-430d-9004-ff3016f89834 -localization_priority: Normal +ms.localizationpriority: medium --- - # Store and retrieve SharePoint list items on a Windows Phone Learn about the Windows Phone application life cycle and storing network data locally. @@ -188,10 +186,9 @@ For the procedures in this section, we assume you're working in the context of a The namespace specified in this code is based on the name of the project (SPListAppLocalStorage in this case). You might want to specify a different namespace, based on the name of your project. - 1. Save the file. -A specific instance of the **EditItemViewModel** class represents a SharePoint list item that is being edited on the phone. You can consider a list item that was edited as a "draft item" before changes to the item are saved to the server. In the code in this class, the **AddDraftItem** method adds a specific instance of the **EditItemViewModel** class (that is, a draft item) as a value to a **Dictionary** object, associating the **EditItemViewModel** in the **Dictionary** with a key based on the identifier for the given list item. (An identifier is assigned by SharePoint Server to each item in a list. In a project based on the Windows Phone SharePoint List Application template, that identifier is stored in the **ID** property of the given **ViewModel** class, such as **EditItemViewModel** or **DisplayItemViewModel**, which represents the list item.) The **RemoveDraftItem** method removes an **EditItemViewModel** from the **Dictionary** object based on a specified identifier. Both of these methods use the **GetDraftItemCollection** method to retrieve the **Dictionary** object containing the **EditItemViewModel** objects from isolated storage and both methods use the **SaveDrafts** method to save the modified **Dictionary** object (with a draft item either added to it or removed from it) back to isolated storage. The **GetDraftItemCollection** method first determines whether a "Drafts" **Dictionary** object has been saved to isolated storage. If so, the method returns that **Dictionary** object; otherwise, the method initializes and returns a new **Dictionary** object. The **Drafts** property of the class provides access to the **Dictionary** of draft items by returning a list (that is, an object based on the **List** generic) of draft items as **EditItemViewModel** objects. The **GetDraftItemById** method returns a given draft item from the **Dictionary** object based on a specified identifier value. +A specific instance of the **EditItemViewModel** class represents a SharePoint list item that is being edited on the phone. You can consider a list item that was edited as a "draft item" before changes to the item are saved to the server. In the code in this class, the **AddDraftItem** method adds a specific instance of the **EditItemViewModel** class (that is, a draft item) as a value to a **Dictionary** object, associating the **EditItemViewModel** in the **Dictionary** with a key based on the identifier for the given list item. (An identifier is assigned by SharePoint Server to each item in a list. In a project based on the Windows Phone SharePoint List Application template, that identifier is stored in the **ID** property of the given **ViewModel** class, such as **EditItemViewModel** or **DisplayItemViewModel**, which represents the list item.) The **RemoveDraftItem** method removes an **EditItemViewModel** from the **Dictionary** object based on a specified identifier. Both of these methods use the **GetDraftItemCollection** method to retrieve the **Dictionary** object containing the **EditItemViewModel** objects from isolated storage and both methods use the **SaveDrafts** method to save the modified **Dictionary** object (with a draft item either added to it or removed from it) back to isolated storage. The **GetDraftItemCollection** method first determines whether a "Drafts" **Dictionary** object has been saved to isolated storage. If so, the method returns that **Dictionary** object; otherwise, the method initializes and returns a new **Dictionary** object. The **Drafts** property of the class provides access to the **Dictionary** of draft items by returning a list (that is, an object based on the **List\** generic) of draft items as **EditItemViewModel** objects. The **GetDraftItemById** method returns a given draft item from the **Dictionary** object based on a specified identifier value. Now you can add elements to the user interface of the phone app and configure them to use the **DraftItemStore** class for editing list items offline. In the following procedures, you will: @@ -664,7 +661,7 @@ Now you can add elements to the user interface of the phone app and configure th The file is opened for editing in the designer. -1. In the XAML pane of the designer, add another button to the **** tag (in addition to the existing **New** and **Refresh** buttons), as shown in the following XAML markup. +1. In the XAML pane of the designer, add another button to the **\** tag (in addition to the existing **New** and **Refresh** buttons), as shown in the following XAML markup. ```xml @@ -739,5 +736,5 @@ Notice the similarity between the Draft Item Edit form (Figure 4) and the standa - [Windows Phone SDK 8.0](https://www.microsoft.com/download/details.aspx?id=35471) - [Microsoft SharePoint SDK for Windows Phone 8](https://www.microsoft.com/download/details.aspx?id=36818) - [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md) -- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=27570) +- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=29233) - [Microsoft SharePoint SDK for Windows Phone 7.1](https://www.microsoft.com/download/details.aspx?id=30476) diff --git a/docs/general-development/how-to-support-and-convert-sharepoint-field-types-for-windows-phone-apps.md b/docs/general-development/how-to-support-and-convert-sharepoint-field-types-for-windows-phone-apps.md index 8459cfb4a..98e127672 100644 --- a/docs/general-development/how-to-support-and-convert-sharepoint-field-types-for-windows-phone-apps.md +++ b/docs/general-development/how-to-support-and-convert-sharepoint-field-types-for-windows-phone-apps.md @@ -1,10 +1,9 @@ --- title: Support and convert SharePoint field types for Windows Phone apps description: Implement data-conversion logic to support SharePoint field types in Windows Phone apps. -ms.date: 12/29/2020 -ms.prod: sharepoint +ms.date: 06/09/2022 ms.assetid: 301e6e58-5153-4ca9-a419-8ae0535ebbed -localization_priority: Normal +ms.localizationpriority: medium --- # Support and convert SharePoint field types for Windows Phone apps @@ -462,5 +461,5 @@ Now the Identifier field is shown on the Display form as well as on the List for - [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md) - [Windows Phone SDK 8.0](https://www.microsoft.com/download/details.aspx?id=35471) - [Microsoft SharePoint SDK for Windows Phone 8](https://www.microsoft.com/download/details.aspx?id=36818) -- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=27570) +- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=29233) - [Microsoft SharePoint SDK for Windows Phone 7.1](https://www.microsoft.com/download/details.aspx?id=30476) diff --git a/docs/general-development/how-to-trust-a-location.md b/docs/general-development/how-to-trust-a-location.md index d9d4ed81b..fe7a5a2bc 100644 --- a/docs/general-development/how-to-trust-a-location.md +++ b/docs/general-development/how-to-trust-a-location.md @@ -1,12 +1,12 @@ --- title: Trust a location -ms.date: 09/25/2017 +description: Describes trusted locations, provides steps on how to trust a location, and provides links to related articles. +ms.date: 06/13/2022 keywords: how to,howdoi,howto,trusted location f1_keywords: - how to,howdoi,howto,trusted location -ms.prod: sharepoint ms.assetid: 0f396c0b-f578-4d1a-9e6b-a75f352265ab -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-use-a-custom-security-trimmer-for-sharepoint-server-search-results.md b/docs/general-development/how-to-use-a-custom-security-trimmer-for-sharepoint-server-search-results.md index 6c5055458..1ac94d865 100644 --- a/docs/general-development/how-to-use-a-custom-security-trimmer-for-sharepoint-server-search-results.md +++ b/docs/general-development/how-to-use-a-custom-security-trimmer-for-sharepoint-server-search-results.md @@ -2,9 +2,8 @@ title: Use a custom security trimmer for SharePoint Server search results description: This how-to guides you through the steps to implement—create, deploy, and register—a custom security trimmer for Search in SharePoint by using Microsoft Visual Studio 2010. ms.date: 12/29/2020 -ms.prod: sharepoint ms.assetid: e1a8664e-fb43-45c2-83aa-9635fe1efc99 -localization_priority: Normal +ms.localizationpriority: medium --- # Use a custom security trimmer for SharePoint Server search results @@ -274,7 +273,7 @@ Your custom security trimmer must implement the **ISecurityTrimmerPost** interfa 1. Set the return value of the **CheckAccess** method to **urlStatusArray**, as shown in the following code. - ```cs + ```csharp return urlStatusArray; ``` diff --git a/docs/general-development/how-to-use-code-to-pin-terms-to-navigation-term-sets-in-sharepoint.md b/docs/general-development/how-to-use-code-to-pin-terms-to-navigation-term-sets-in-sharepoint.md index e3459953d..2490fc272 100644 --- a/docs/general-development/how-to-use-code-to-pin-terms-to-navigation-term-sets-in-sharepoint.md +++ b/docs/general-development/how-to-use-code-to-pin-terms-to-navigation-term-sets-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Use code to pin terms to navigation term sets in SharePoint +description: Learn how to use code to pin terms to navigation term sets. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: 4a2811dc-25fd-4eb2-b0ab-1edded64c556 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -49,7 +49,7 @@ You can use custom code from the .NET server, .NET client (CSOM), Silverlight, o -```cs +```csharp public void TermPinningTest() { diff --git a/docs/general-development/how-to-use-multiple-sharepoint-lists-in-a-windows-phone-app.md b/docs/general-development/how-to-use-multiple-sharepoint-lists-in-a-windows-phone-app.md index f2f81d6cb..955351d14 100644 --- a/docs/general-development/how-to-use-multiple-sharepoint-lists-in-a-windows-phone-app.md +++ b/docs/general-development/how-to-use-multiple-sharepoint-lists-in-a-windows-phone-app.md @@ -1,10 +1,9 @@ --- title: Use multiple SharePoint lists in a Windows Phone app description: Create Windows Phone apps that use data from multiple SharePoint lists. -ms.date: 01/06/2021 -ms.prod: sharepoint +ms.date: 06/09/2022 ms.assetid: 5251d35a-d659-49b3-8e0d-dfd4a7faee6b -localization_priority: Normal +ms.localizationpriority: medium --- # Use multiple SharePoint lists in a Windows Phone app @@ -676,5 +675,5 @@ From this form (the List form for the Orders list) you can add, edit, or delete - [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md) - [Windows Phone SDK 8.0](https://www.microsoft.com/download/details.aspx?id=35471) - [Microsoft SharePoint SDK for Windows Phone 8](https://www.microsoft.com/download/details.aspx?id=36818) -- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=27570) +- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=29233) - [Microsoft SharePoint SDK for Windows Phone 7.1](https://www.microsoft.com/download/details.aspx?id=30476) diff --git a/docs/general-development/how-to-use-sap-reporting-with-duet-enterprise-2-0.md b/docs/general-development/how-to-use-sap-reporting-with-duet-enterprise-2-0.md index 43e6646e3..04908dcad 100644 --- a/docs/general-development/how-to-use-sap-reporting-with-duet-enterprise-2-0.md +++ b/docs/general-development/how-to-use-sap-reporting-with-duet-enterprise-2-0.md @@ -1,9 +1,9 @@ --- title: Use SAP Reporting with Duet Enterprise 2.0 -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to use SAP reporting with Duet Enterprise 2.0 and provides steps on how to enable the Duet reporting features. +ms.date: 06/13/2022 ms.assetid: a54c6cd2-2283-440d-af55-e98e3212caa1 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-use-sap-workflow-with-duet-enterprise-2-0.md b/docs/general-development/how-to-use-sap-workflow-with-duet-enterprise-2-0.md index cc946f3c4..27c72fb4b 100644 --- a/docs/general-development/how-to-use-sap-workflow-with-duet-enterprise-2-0.md +++ b/docs/general-development/how-to-use-sap-workflow-with-duet-enterprise-2-0.md @@ -1,9 +1,9 @@ --- title: Use SAP workflow with Duet Enterprise 2.0 -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to use SAP workflows and provides steps on how to create and configure an app using information from SAP workflows. +ms.date: 06/13/2022 ms.assetid: 816e28ed-8cea-4e33-98e5-d3d27136e2e6 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-use-the-client-code-library-to-access-external-data-in-sharepoint.md b/docs/general-development/how-to-use-the-client-code-library-to-access-external-data-in-sharepoint.md index e0c61eaa5..3bf87fe42 100644 --- a/docs/general-development/how-to-use-the-client-code-library-to-access-external-data-in-sharepoint.md +++ b/docs/general-development/how-to-use-the-client-code-library-to-access-external-data-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Use the client code library to access external data in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to use the SharePoint client object model to work with BCS objects in SharePoint using browser-based scripting. +ms.date: 06/13/2022 ms.assetid: c280ae92-c52b-4658-b0f3-805fb215ef8e -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/how-to-use-the-closeworkbook-method-call-asynchronously.md b/docs/general-development/how-to-use-the-closeworkbook-method-call-asynchronously.md index 0ae02c932..a2ee24480 100644 --- a/docs/general-development/how-to-use-the-closeworkbook-method-call-asynchronously.md +++ b/docs/general-development/how-to-use-the-closeworkbook-method-call-asynchronously.md @@ -1,12 +1,12 @@ --- title: Use the CloseWorkbook method call asynchronously +description: When you are using Excel Web Services, it is good practice to close the workbook by calling the CloseWorkbook method if you are finished using the session. This closes the session and allows Excel Services to free resources in a predictable manner. This could potentially improve your server performance and robustness. ms.date: 09/25/2017 keywords: async,how to,howdoi,howto f1_keywords: - async,how to,howdoi,howto -ms.prod: sharepoint ms.assetid: 6febe7dc-a552-4c79-aa3e-203d882286e3 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -59,7 +59,7 @@ The following example shows how to close a workbook asynchronously using Visual -```cs +```csharp using System; using SampleApplication.ExcelWebService; diff --git a/docs/general-development/how-to-use-the-content-enrichment-web-service-callout-for-sharepoint-server.md b/docs/general-development/how-to-use-the-content-enrichment-web-service-callout-for-sharepoint-server.md index d4f1c7714..78b79dcd1 100644 --- a/docs/general-development/how-to-use-the-content-enrichment-web-service-callout-for-sharepoint-server.md +++ b/docs/general-development/how-to-use-the-content-enrichment-web-service-callout-for-sharepoint-server.md @@ -2,9 +2,8 @@ title: Use the Content Enrichment web service callout for SharePoint Server description: Learn how to implement the Content Enrichment web service in SharePoint to modify the managed properties of crawled items before they are indexed. ms.date: 01/06/2021 -ms.prod: sharepoint ms.assetid: d4e44498-9a3d-4f2f-b5ba-6ebef9971dcb -localization_priority: Normal +ms.localizationpriority: medium --- # Use the Content Enrichment web service callout for SharePoint Server diff --git a/docs/general-development/how-to-use-the-subcode-property-to-capture-error-codes.md b/docs/general-development/how-to-use-the-subcode-property-to-capture-error-codes.md index ed52c8f3e..28b4bf1f5 100644 --- a/docs/general-development/how-to-use-the-subcode-property-to-capture-error-codes.md +++ b/docs/general-development/how-to-use-the-subcode-property-to-capture-error-codes.md @@ -1,12 +1,12 @@ --- title: Use the SubCode property to capture error codes +description: Excel Services generates errors in the SOAP exception based on errors that occur in Excel Services. To make it easier for the developer to catch specific error conditions, an Excel Calculation Services alert has an associated error code. ms.date: 09/25/2017 keywords: how to,howdoi,howto,subcode f1_keywords: - how to,howdoi,howto,subcode -ms.prod: sharepoint ms.assetid: 8ce4d5b2-111b-49e7-9d07-8c2c586221ec -localization_priority: Normal +ms.localizationpriority: medium --- @@ -14,7 +14,7 @@ localization_priority: Normal Excel Services generates errors in the SOAP exception based on errors that occur in Excel Services. To make it easier for the developer to catch specific error conditions, an Excel Calculation Services alert has an associated error code. The Excel Web Services then returns the error using properties from the **SoapException** class. -The following examples show how to capture the error codes by using the [SubCode](https://docs.microsoft.com/dotnet/api/system.web.services.protocols.soapexception.subcode?view=netframework-4.7.2) property of the **SoapException** class. +The following examples show how to capture the error codes by using the [SubCode](/dotnet/api/system.web.services.protocols.soapexception.subcode) property of the **SoapException** class. > [!NOTE] > To be able to use the **SubCode** property, you must use Microsoft Visual Studio 2005. The **SubCode** property does not exist in earlier versions of Visual Studio. @@ -25,7 +25,7 @@ For a list of error codes, see [Excel Services Error Codes](excel-services-error 1. After adding a Web reference to the Excel Web Services, add the following using directive so that you can use the **SoapException** class without having to qualify it with a full namespace: - ```cs + ```csharp using System.Web.Services.Protocols; ``` @@ -37,7 +37,7 @@ For a list of error codes, see [Excel Services Error Codes](excel-services-error 2. To capture the Excel Services error codes using the **SubCode** property, you must use the SOAP12 protocol version. After instantiating the Excel Web Services proxy class, set the SOAP protocol version as follows: - ```cs + ```csharp // Instantiate the Web service. ExcelService xlservice = new ExcelService(); @@ -57,7 +57,7 @@ For a list of error codes, see [Excel Services Error Codes](excel-services-error 3. To catch the error codes using the **SubCode** property, add a SOAP exception catch block to your code, for example: - ```cs + ```csharp catch (SoapException e) { @@ -85,7 +85,7 @@ For a list of error codes, see [Excel Services Error Codes](excel-services-error 2. After you add a reference, add the following **using** directive to your code so that you can use the **SoapException** class without having to qualify it with a full namespace: - ```cs + ```csharp using System.Web.Services.Protocols; ``` @@ -100,7 +100,7 @@ For a list of error codes, see [Excel Services Error Codes](excel-services-error 4. To catch the error codes using the **SubCode** property, add a SOAP exception catch block to your code, for example: - ```cs + ```csharp catch (SoapException e) { Console.WriteLine("SOAP Exception Message: {0}", e.Message); @@ -128,7 +128,7 @@ The sheet that was requested could not be found. Please try a different one. ``` -```cs +```csharp using System; using System.Collections.Generic; using System.Text; diff --git a/docs/general-development/how-to-work-with-user-profiles-and-organization-profiles-by-using-the-server-obj.md b/docs/general-development/how-to-work-with-user-profiles-and-organization-profiles-by-using-the-server-obj.md index ba3139723..58e3dc48b 100644 --- a/docs/general-development/how-to-work-with-user-profiles-and-organization-profiles-by-using-the-server-obj.md +++ b/docs/general-development/how-to-work-with-user-profiles-and-organization-profiles-by-using-the-server-obj.md @@ -1,9 +1,9 @@ --- title: Work with user profiles and organization profiles by using the server object model in SharePoint +description: Learn how to create, retrieve, and change SharePoint user profiles and user profile properties programmatically by using the SharePoint server object model. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: 13f16dc3-f652-4fb3-996b-5f2166236d2b -localization_priority: Normal +ms.localizationpriority: medium --- @@ -96,7 +96,7 @@ The following code example creates a [UserProfile](https://msdn.microsoft.com/l -```cs +```csharp using System; using System.Collections.Generic; @@ -164,7 +164,7 @@ The following code example creates a [CoreProperty](https://msdn.microsoft.com/ -```cs +```csharp using System; using System.Collections.Generic; @@ -255,7 +255,7 @@ The following code example retrieves all user profiles within the context and ch -```cs +```csharp using System; using System.Collections; @@ -325,7 +325,7 @@ The following code example retrieves the set of properties that represent a spec -```cs +```csharp using System; using System.Collections.Generic; @@ -400,7 +400,7 @@ The following code example retrieves all **UserProfile** type properties and ret -```cs +```csharp using System; using System.Collections.Generic; diff --git a/docs/general-development/how-tos-for-sharepoint.md b/docs/general-development/how-tos-for-sharepoint.md index 700e83a94..5acfb2ba5 100644 --- a/docs/general-development/how-tos-for-sharepoint.md +++ b/docs/general-development/how-tos-for-sharepoint.md @@ -2,221 +2,201 @@ title: How-tos for SharePoint Development description: Find how-to articles and related code examples that show how to perform basic development tasks in SharePoint, including how to set up your development environment and start building sites, mobile apps, and SharePoint Add-ins. ms.date: 04/13/2017 -ms.prod: sharepoint ms.assetid: ca78b080-0be4-4da4-b112-b86b1bde66e4 -localization_priority: Priority +ms.localizationpriority: high --- - - # How-tos for SharePoint Development ![SharePoint](../images/mod_logo_sharepoint.png) Find how-to articles and related code examples that show how to perform basic development tasks in SharePoint, including how to set up your development environment and start building sites, SharePoint Framework and SharePoint Add-ins. - ## Getting started how-tos for SharePoint Framework -|**Title**|**Summary**| +|Title|Summary| |:-----|:-----| -| [Set up your SharePoint Framework development environment](../spfx/set-up-your-development-environment.md)
    |Learn how to set up a development environment for SharePoint Framework development.
    | -| [Building your first SharePoint client-side web part](../spfx/web-parts/get-started/build-a-hello-world-web-part.md)
    |Learn how to get started with developing SharePoint Framework client-side web parts.
    | -| [Build your first SharePoint Framework Extension](../spfx/extensions/get-started/build-a-hello-world-extension.md)
    |Learn how to get started with developing SharePoint Framework Extensions.
    | +| [Set up your SharePoint Framework development environment](../spfx/set-up-your-development-environment.md) |Learn how to set up a development environment for SharePoint Framework development. | +| [Building your first SharePoint client-side web part](../spfx/web-parts/get-started/build-a-hello-world-web-part.md) |Learn how to get started with developing SharePoint Framework client-side web parts. | +| [Build your first SharePoint Framework Extension](../spfx/extensions/get-started/build-a-hello-world-extension.md) |Learn how to get started with developing SharePoint Framework Extensions. | - ## Getting started how-tos for SharePoint Add-ins -|**Title**|**Summary**| +|Title|Summary| |:-----|:-----| -| [Set up an on-premises development environment for SharePoint Add-ins](../sp-add-ins/set-up-an-on-premises-development-environment-for-sharepoint-add-ins.md)
    |Learn how to set up a development environment that is specifically suited to developing SharePoint Add-ins with an on-premises installation of SharePoint.
    | -| [Get started creating provider-hosted SharePoint Add-ins](../sp-add-ins/get-started-creating-provider-hosted-sharepoint-add-ins.md)
    |Learn how to create a basic provider-hosted SharePoint Add-in with the Office Developer Tools for Visual Studio 2012, how to interact with SharePoint sites by using the SharePoint CSOM, and how to implement OAuth in an SharePoint Add-in.
    | -| [Get started creating SharePoint-hosted SharePoint Add-ins](../sp-add-ins/get-started-creating-sharepoint-hosted-sharepoint-add-ins.md)
    |Learn how to create a basic SharePoint-hosted SharePoint Add-in with the Office Developer Tools for Visual Studio 2012.
    | - - +| [Set up an on-premises development environment for SharePoint Add-ins](../sp-add-ins/set-up-an-on-premises-development-environment-for-sharepoint-add-ins.md) |Learn how to set up a development environment that is specifically suited to developing SharePoint Add-ins with an on-premises installation of SharePoint. | +| [Get started creating provider-hosted SharePoint Add-ins](../sp-add-ins/get-started-creating-provider-hosted-sharepoint-add-ins.md) |Learn how to create a basic provider-hosted SharePoint Add-in with the Office Developer Tools for Visual Studio 2012, how to interact with SharePoint sites by using the SharePoint CSOM, and how to implement OAuth in an SharePoint Add-in. | +| [Get started creating SharePoint-hosted SharePoint Add-ins](../sp-add-ins/get-started-creating-sharepoint-hosted-sharepoint-add-ins.md) |Learn how to create a basic SharePoint-hosted SharePoint Add-in with the Office Developer Tools for Visual Studio 2012. | + ## Development how-tos for SharePoint Add-ins -|**Title**|**Summary**| -|:-----|:-----| -| [Complete basic operations using SharePoint client library code](../sp-add-ins/complete-basic-operations-using-sharepoint-client-library-code.md)
    |Learn how to write code to perform basic operations with the SharePoint .NET Framework client object model (CSOM).
    | -| [Complete basic operations using JavaScript library code in SharePoint](../sp-add-ins/complete-basic-operations-using-javascript-library-code-in-sharepoint.md)
    |Learn how to write code to perform basic operations using the JavaScript client object model in SharePoint.
    | -| [Complete basic operations using SharePoint REST endpoints](../sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints.md)
    |Learn how to perform basic create, read, update, and delete (CRUD) operations with the SharePoint REST interface.
    | -| [Use a SharePoint website's style sheet in SharePoint Add-ins](../sp-add-ins/use-a-sharepoint-website-s-style-sheet-in-sharepoint-add-ins.md)
    |Learn how to use a SharePoint website's style sheet in an SharePoint Add-in.
    | -| [Use the client chrome control in SharePoint Add-ins](../sp-add-ins/use-the-client-chrome-control-in-sharepoint-add-ins.md)
    |Learn how to use the chrome control in apps in SharePoint.
    | -| [Create add-in parts to install with your SharePoint Add-in](../sp-add-ins/create-add-in-parts-to-install-with-your-sharepoint-add-in.md)
    |Learn how to create an app part in SharePoint that is available in the Web Part Gallery of the host web when you deploy your SharePoint Add-in.
    | -| [Create custom actions to deploy with SharePoint Add-ins](../sp-add-ins/create-custom-actions-to-deploy-with-sharepoint-add-ins.md)
    |Learn how to create a custom action in SharePoint that deploys to the host web when you deploy an SharePoint Add-in.
    | -| [Customize a list view in SharePoint Add-ins using client-side rendering](../sp-add-ins/customize-a-list-view-in-sharepoint-add-ins-using-client-side-rendering.md)
    |Learn how to customize a list view in a SharePoint-hosted app by using the client-side rendering technology in SharePoint.
    | -| [Use the client-side People Picker control in SharePoint-hosted SharePoint Add-ins](../sp-add-ins/use-the-client-side-people-picker-control-in-sharepoint-hosted-sharepoint-add-in.md)
    |Learn how to use the client-side People Picker control in SharePoint Add-ins.
    | -| [Create a custom proxy page for the cross-domain library in SharePoint](../sp-add-ins/create-a-custom-proxy-page-for-the-cross-domain-library-in-sharepoint.md)
    |Learn how to create a custom proxy page to access data in a remote service from a SharePoint webpage by using the cross domain library in SharePoint.
    | -| [Query a remote service using the web proxy in SharePoint](../sp-add-ins/query-a-remote-service-using-the-web-proxy-in-sharepoint.md)
    |Learn how to access data in a remote domain from a page that is hosted in SharePoint by using the web proxy.
    | -| [Access SharePoint data from add-ins using the cross-domain library](../sp-add-ins/access-sharepoint-data-from-add-ins-using-the-cross-domain-library.md)
    |Learn how to access data in a SharePoint website from a remote app by using the cross domain library in SharePoint.
    | -| [Create a remote event receiver in SharePoint Add-ins](../sp-add-ins/create-a-remote-event-receiver-in-sharepoint-add-ins.md)
    |Learn the basics about how to handle, add, and remove events in an SharePoint Add-in by using the Office Developer Tools for Visual Studio 2012.
    | -| [Create an add-in event receiver in SharePoint Add-ins](../sp-add-ins/create-an-add-in-event-receiver-in-sharepoint-add-ins.md)
    |Learn the basics about how to create a receiver and add or remove handlers for events that occur to an SharePoint Add-in by using the Office Developer Tools for Visual Studio 2012.
    | -| [Create a provider-hosted add-in that includes a custom SharePoint list and content type](../sp-add-ins/create-a-provider-hosted-add-in-that-includes-a-custom-sharepoint-list-and-conte.md)
    |Create an SharePoint Add-in that combines a cloud-hosted web application with custom SharePoint-hosted list templates, list instances, and custom content types by using the Office Developer Tools for Visual Studio 2012. Learn how to interact with SharePoint app webs by using the REST/OData web service, and how to implement OAuth in an SharePoint Add-in.
    | -| [Get user identity and properties in SharePoint](../sp-add-ins/get-user-identity-and-properties-in-sharepoint.md)
    |Learn the different ways to retrieve user identity and user information in SharePoint.
    | -| [Localize SharePoint Add-ins](../sp-add-ins/localize-sharepoint-add-ins.md)
    |Localize an SharePoint Add-in by using resource files, JavaScript "resource" files, and other techniques.
    | -| [Create high-trust SharePoint Add-ins](../sp-add-ins/create-high-trust-sharepoint-add-ins.md)
    |Learn how to create a high-trust app for SharePoint. A high-trust app is a provider-hosted app for use on-premises that uses the server-to-server protocol.
    | -| [Package and publish high-trust SharePoint Add-ins](../sp-add-ins/package-and-publish-high-trust-sharepoint-add-ins.md)
    |Learn how to package and publish a high-trust SharePoint Add-in for on-premises use.
    | - - +|Title|Summary| +|:-----|:-----| +| [Complete basic operations using SharePoint client library code](../sp-add-ins/complete-basic-operations-using-sharepoint-client-library-code.md) |Learn how to write code to perform basic operations with the SharePoint .NET Framework client object model (CSOM). | +| [Complete basic operations using JavaScript library code in SharePoint](../sp-add-ins/complete-basic-operations-using-javascript-library-code-in-sharepoint.md) |Learn how to write code to perform basic operations using the JavaScript client object model in SharePoint. | +| [Complete basic operations using SharePoint REST endpoints](../sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints.md) |Learn how to perform basic create, read, update, and delete (CRUD) operations with the SharePoint REST interface. | +| [Use a SharePoint website's style sheet in SharePoint Add-ins](../sp-add-ins/use-a-sharepoint-website-s-style-sheet-in-sharepoint-add-ins.md) |Learn how to use a SharePoint website's style sheet in an SharePoint Add-in. | +| [Use the client chrome control in SharePoint Add-ins](../sp-add-ins/use-the-client-chrome-control-in-sharepoint-add-ins.md) |Learn how to use the chrome control in apps in SharePoint. | +| [Create add-in parts to install with your SharePoint Add-in](../sp-add-ins/create-add-in-parts-to-install-with-your-sharepoint-add-in.md) |Learn how to create an app part in SharePoint that is available in the Web Part Gallery of the host web when you deploy your SharePoint Add-in. | +| [Create custom actions to deploy with SharePoint Add-ins](../sp-add-ins/create-custom-actions-to-deploy-with-sharepoint-add-ins.md) |Learn how to create a custom action in SharePoint that deploys to the host web when you deploy an SharePoint Add-in. | +| [Customize a list view in SharePoint Add-ins using client-side rendering](../sp-add-ins/customize-a-list-view-in-sharepoint-add-ins-using-client-side-rendering.md) |Learn how to customize a list view in a SharePoint-hosted app by using the client-side rendering technology in SharePoint. | +| [Use the client-side People Picker control in SharePoint-hosted SharePoint Add-ins](../sp-add-ins/use-the-client-side-people-picker-control-in-sharepoint-hosted-sharepoint-add-in.md) |Learn how to use the client-side People Picker control in SharePoint Add-ins. | +| [Create a custom proxy page for the cross-domain library in SharePoint](../sp-add-ins/create-a-custom-proxy-page-for-the-cross-domain-library-in-sharepoint.md) |Learn how to create a custom proxy page to access data in a remote service from a SharePoint webpage by using the cross domain library in SharePoint. | +| [Query a remote service using the web proxy in SharePoint](../sp-add-ins/query-a-remote-service-using-the-web-proxy-in-sharepoint.md) |Learn how to access data in a remote domain from a page that is hosted in SharePoint by using the web proxy. | +| [Access SharePoint data from add-ins using the cross-domain library](../sp-add-ins/access-sharepoint-data-from-add-ins-using-the-cross-domain-library.md) |Learn how to access data in a SharePoint website from a remote app by using the cross domain library in SharePoint. | +| [Create a remote event receiver in SharePoint Add-ins](../sp-add-ins/create-a-remote-event-receiver-in-sharepoint-add-ins.md) |Learn the basics about how to handle, add, and remove events in an SharePoint Add-in by using the Office Developer Tools for Visual Studio 2012. | +| [Create an add-in event receiver in SharePoint Add-ins](../sp-add-ins/create-an-add-in-event-receiver-in-sharepoint-add-ins.md) |Learn the basics about how to create a receiver and add or remove handlers for events that occur to an SharePoint Add-in by using the Office Developer Tools for Visual Studio 2012. | +| [Create a provider-hosted add-in that includes a custom SharePoint list and content type](../sp-add-ins/create-a-provider-hosted-add-in-that-includes-a-custom-sharepoint-list-and-conte.md) |Create an SharePoint Add-in that combines a cloud-hosted web application with custom SharePoint-hosted list templates, list instances, and custom content types by using the Office Developer Tools for Visual Studio 2012. Learn how to interact with SharePoint app webs by using the REST/OData web service, and how to implement OAuth in an SharePoint Add-in. | +| [Get user identity and properties in SharePoint](../sp-add-ins/get-user-identity-and-properties-in-sharepoint.md) |Learn the different ways to retrieve user identity and user information in SharePoint. | +| [Localize SharePoint Add-ins](../sp-add-ins/localize-sharepoint-add-ins.md) |Localize an SharePoint Add-in by using resource files, JavaScript "resource" files, and other techniques. | +| [Create high-trust SharePoint Add-ins](../sp-add-ins/create-high-trust-sharepoint-add-ins.md) |Learn how to create a high-trust app for SharePoint. A high-trust app is a provider-hosted app for use on-premises that uses the server-to-server protocol. | +| [Package and publish high-trust SharePoint Add-ins](../sp-add-ins/package-and-publish-high-trust-sharepoint-add-ins.md) |Learn how to package and publish a high-trust SharePoint Add-in for on-premises use. | + ## Publishing how-tos for Office and SharePoint Add-ins -|**Title**|**Summary**| +|Title|Summary| |:-----|:-----| -| [Publish SharePoint Add-ins by using Visual Studio](../sp-add-ins/publish-sharepoint-add-ins-by-using-visual-studio.md)
    |Learn how to package your SharePoint Add-in by using Visual Studio 2012.
    | -| [Create or edit a Seller Dashboard seller account and add payout information](https://developer.microsoft.com/store/register)
    |The Microsoft Seller Dashboard is the central location for app developers to submit Office and SharePoint Add-ins. Learn how to create a seller account, including a marketing profile, so that you can submit apps for inclusion in the Office Store.
    | -| [Create or update client IDs and secrets in the Seller Dashboard](https://docs.microsoft.com/office/dev/store/create-or-update-client-ids-and-secrets)
    |Learn how to create Client IDs and secrets, and associate them with your apps in the Seller Dashboard to enable Open Authorization (OAuth) authorization services in your Office and SharePoint Add-ins.
    | -| [Use the Seller Dashboard to submit Office and SharePoint Add-ins and Office 365 apps to the Office Store](https://docs.microsoft.com/office/dev/store/use-the-seller-dashboard-to-submit-to-the-office-store)
    |The Microsoft Seller Dashboard enables software developers to submit apps for SharePoint and Office to the Office Store. Learn how to submit your apps for approval and inclusion in the Office Store.
    | -| [Create effective Office Store apps and add-ins](https://docs.microsoft.com/office/dev/store/create-effective-office-store-listings)
    |Get guidance on how to create an effective Office Store listing: name your app appropriately, write effective, engaging app descriptions for your app, and include consistent, properly formatted logos with your app submission to the Seller Dashboard.
    | - - +| [Publish SharePoint Add-ins by using Visual Studio](../sp-add-ins/publish-sharepoint-add-ins-by-using-visual-studio.md) |Learn how to package your SharePoint Add-in by using Visual Studio 2012. | +| [Create or edit a Seller Dashboard seller account and add payout information](https://developer.microsoft.com/store/register) |The Microsoft Seller Dashboard is the central location for app developers to submit Office and SharePoint Add-ins. Learn how to create a seller account, including a marketing profile, so that you can submit apps for inclusion in the Office Store. | +| [Create or update client IDs and secrets in the Seller Dashboard](/office/dev/store/create-or-update-client-ids-and-secrets) |Learn how to create Client IDs and secrets, and associate them with your apps in the Seller Dashboard to enable Open Authorization (OAuth) authorization services in your Office and SharePoint Add-ins. | +| [Use the Seller Dashboard to submit Office and SharePoint Add-ins and Office 365 apps to the Office Store](/office/dev/store/use-the-seller-dashboard-to-submit-to-the-office-store) |The Microsoft Seller Dashboard enables software developers to submit apps for SharePoint and Office to the Office Store. Learn how to submit your apps for approval and inclusion in the Office Store. | +| [Create effective Office Store apps and add-ins](/office/dev/store/create-effective-office-store-listings) |Get guidance on how to create an effective Office Store listing: name your app appropriately, write effective, engaging app descriptions for your app, and include consistent, properly formatted logos with your app submission to the Seller Dashboard. | + ## Licensing how-tos for Office and SharePoint Add-ins -|**Title**|**Summary**| +|Title|Summary| |:-----|:-----| -| [Add license checks to your apps for Office](https://msdn.microsoft.com/library/fp161347.aspx)
    |Learn how to add code to your Office Add-in that checks the validity of a user's app license, and takes action based on the app license properties. Load test app license tokens to test your license checking code.
    | -| [Add license checks to Office and SharePoint Add-ins](https://docs.microsoft.com/office/dev/store/add-license-checks-to-office-and-sharepoint-add-ins)
    |Learn how to add code to your SharePoint Add-in that checks the validity of a user's app license, and takes action based on the app license properties. Load test app license tokens to test your license checking code.
    | - - +| [Add license checks to your apps for Office](https://msdn.microsoft.com/library/fp161347.aspx) |Learn how to add code to your Office Add-in that checks the validity of a user's app license, and takes action based on the app license properties. Load test app license tokens to test your license checking code. | +| [Add license checks to Office and SharePoint Add-ins](/office/dev/store/add-license-checks-to-office-and-sharepoint-add-ins) |Learn how to add code to your SharePoint Add-in that checks the validity of a user's app license, and takes action based on the app license properties. Load test app license tokens to test your license checking code. | + ## Setting up your dev environment how-tos for developing sites and solutions in SharePoint -|**Title**|**Summary**| +|Title|Summary| |:-----|:-----| -| [Detect the installed SKU of SharePoint](how-to-detect-the-installed-sku-of-sharepoint.md)
    |If the behavior of your solutions depends on the locally installed SKU of SharePoint or Project Server 2013, use the code sample in this article to find the SKU information you need.
    | -| [Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md)
    |Learn about the system requirements and configuring a development environment for SharePoint mobility projects.
    | - - +| [Detect the installed SKU of SharePoint](how-to-detect-the-installed-sku-of-sharepoint.md) |If the behavior of your solutions depends on the locally installed SKU of SharePoint or Project Server 2013, use the code sample in this article to find the SKU information you need. | +| [Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md) |Learn about the system requirements and configuring a development environment for SharePoint mobility projects. | + ## Customization how-tos for SharePoint -|**Title**|**Summary**| +|Title|Summary| |:-----|:-----| -| [Customize a field type using client-side rendering](how-to-customize-a-field-type-using-client-side-rendering.md)
    |Learn how to customize a field type by using the client-side rendering technology in SharePoint.
    | -| [Customize list item queries and filter data for Windows Phone apps](how-to-customize-list-item-queries-and-filter-data-for-windows-phone-apps.md)
    |Customize the data queries on which the views in a Windows Phone app are based.
    | -| [Customize the user interface of a SharePoint list app for Windows Phone](how-to-customize-the-user-interface-of-a-sharepoint-list-app-for-windows-ph.md)
    |Customize the Windows Phone user interface generated by the Windows Phone SharePoint List Application template.
    | - - +| [Customize a field type using client-side rendering](how-to-customize-a-field-type-using-client-side-rendering.md) |Learn how to customize a field type by using the client-side rendering technology in SharePoint. | +| [Customize list item queries and filter data for Windows Phone apps](how-to-customize-list-item-queries-and-filter-data-for-windows-phone-apps.md) |Customize the data queries on which the views in a Windows Phone app are based. | +| [Customize the user interface of a SharePoint list app for Windows Phone](how-to-customize-the-user-interface-of-a-sharepoint-list-app-for-windows-ph.md) |Customize the Windows Phone user interface generated by the Windows Phone SharePoint List Application template. | + ## Building mobile apps how-tos for SharePoint -|**Title**|**Summary**| -|:-----|:-----| -| [Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md)
    |Learn about the system requirements and configuring a development environment for SharePoint mobility projects.
    | -| [Create a Windows Phone SharePoint list app](how-to-create-a-windows-phone-sharepoint-list-app.md)
    |Create a Windows Phone app in Visual Studio based on the Windows Phone SharePoint List Application template.
    | -| [Store and retrieve SharePoint list items on a Windows Phone](how-to-store-and-retrieve-sharepoint-list-items-on-a-windows-phone.md)
    |Learn about the Windows Phone application life cycle and storing network data locally.
    | -| [Implement business logic and data validation in a Windows Phone app for SharePoint](how-to-implement-business-logic-and-data-validation-in-a-windows-phone-app-for-s.md)
    |Implement data validation in a Windows Phone app created by using the Windows Phone SharePoint List Application template.
    | -| [Support and convert SharePoint field types for Windows Phone apps](how-to-support-and-convert-sharepoint-field-types-for-windows-phone-apps.md)
    |Implement data-conversion logic to support SharePoint field types in Windows Phone apps.
    | -| [Customize list item queries and filter data for Windows Phone apps](how-to-customize-list-item-queries-and-filter-data-for-windows-phone-apps.md)
    |Customize the data queries on which the views in a Windows Phone app are based.
    | -| [Customize the user interface of a SharePoint list app for Windows Phone](how-to-customize-the-user-interface-of-a-sharepoint-list-app-for-windows-ph.md)
    |Customize the Windows Phone user interface generated by the Windows Phone SharePoint List Application template.
    | -| [Use multiple SharePoint lists in a Windows Phone app](how-to-use-multiple-sharepoint-lists-in-a-windows-phone-app.md)
    |Create Windows Phone apps that use data from multiple SharePoint lists.
    | -| [Configure and use push notifications in SharePoint apps for Windows Phone](how-to-configure-and-use-push-notifications-in-sharepoint-apps-for-windows.md)
    |Create a solution in SharePoint Server for sending push notifications and develop a Windows Phone app for receiving the notifications.
    | -| [Create a mobile app in SharePoint that contains data from an external data source](how-to-create-a-mobile-app-in-sharepoint-that-contains-data-from-an-externa.md)
    |Learn how to create a simple mobile app in SharePoint that contains data from external data source by using Business Connectivity Services (BCS) and connecting to an external list.
    | -| [Integrate maps with Windows Phone apps and SharePoint lists](how-to-integrate-maps-with-windows-phone-apps-and-sharepoint-lists.md)
    |Learn how to integrate location information and maps in SharePoint lists and location-based web and mobile SharePoint Add-ins, by using the new Geolocation field, and by creating your own geolocation-based field types.
    | -| [Build search-driven mobile apps with the Navigation and Event Logging REST interfaces](how-to-build-search-driven-mobile-apps-with-the-navigation-and-event-logging-res.md)
    |SharePoint introduces the Navigation and Event Logging REST interfaces, enabling you to create a search-driven mobile app for mobile devices such as phones and tablets that run on operating systems other than Windows???for example, Android and iOS.
    | -| [Export the Name field in a Document Library list to a mobile app](how-to-export-the-name-field-in-a-document-library-list-to-a-mobile-app.md)
    |Export the Name field of a Document Library list to a mobile app by using the Visual Studio SharePoint List wizard. The Name field does not appear automatically when a user creates a mobile app for a document library in SharePoint.
    | - - +|Title|Summary| +|:-----|:-----| +| [Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md) |Learn about the system requirements and configuring a development environment for SharePoint mobility projects. | +| [Create a Windows Phone SharePoint list app](how-to-create-a-windows-phone-sharepoint-list-app.md) |Create a Windows Phone app in Visual Studio based on the Windows Phone SharePoint List Application template. | +| [Store and retrieve SharePoint list items on a Windows Phone](how-to-store-and-retrieve-sharepoint-list-items-on-a-windows-phone.md) |Learn about the Windows Phone application life cycle and storing network data locally. | +| [Implement business logic and data validation in a Windows Phone app for SharePoint](how-to-implement-business-logic-and-data-validation-in-a-windows-phone-app-for-s.md) |Implement data validation in a Windows Phone app created by using the Windows Phone SharePoint List Application template. | +| [Support and convert SharePoint field types for Windows Phone apps](how-to-support-and-convert-sharepoint-field-types-for-windows-phone-apps.md) |Implement data-conversion logic to support SharePoint field types in Windows Phone apps. | +| [Customize list item queries and filter data for Windows Phone apps](how-to-customize-list-item-queries-and-filter-data-for-windows-phone-apps.md) |Customize the data queries on which the views in a Windows Phone app are based. | +| [Customize the user interface of a SharePoint list app for Windows Phone](how-to-customize-the-user-interface-of-a-sharepoint-list-app-for-windows-ph.md) |Customize the Windows Phone user interface generated by the Windows Phone SharePoint List Application template. | +| [Use multiple SharePoint lists in a Windows Phone app](how-to-use-multiple-sharepoint-lists-in-a-windows-phone-app.md) |Create Windows Phone apps that use data from multiple SharePoint lists. | +| [Configure and use push notifications in SharePoint apps for Windows Phone](how-to-configure-and-use-push-notifications-in-sharepoint-apps-for-windows.md) |Create a solution in SharePoint Server for sending push notifications and develop a Windows Phone app for receiving the notifications. | +| [Create a mobile app in SharePoint that contains data from an external data source](how-to-create-a-mobile-app-in-sharepoint-that-contains-data-from-an-externa.md) |Learn how to create a simple mobile app in SharePoint that contains data from external data source by using Business Connectivity Services (BCS) and connecting to an external list. | +| [Integrate maps with Windows Phone apps and SharePoint lists](how-to-integrate-maps-with-windows-phone-apps-and-sharepoint-lists.md) |Learn how to integrate location information and maps in SharePoint lists and location-based web and mobile SharePoint Add-ins, by using the new Geolocation field, and by creating your own geolocation-based field types. | +| [Build search-driven mobile apps with the Navigation and Event Logging REST interfaces](how-to-build-search-driven-mobile-apps-with-the-navigation-and-event-logging-res.md) |SharePoint introduces the Navigation and Event Logging REST interfaces, enabling you to create a search-driven mobile app for mobile devices such as phones and tablets that run on operating systems other than Windows???for example, Android and iOS. | +| [Export the Name field in a Document Library list to a mobile app](how-to-export-the-name-field-in-a-document-library-list-to-a-mobile-app.md) |Export the Name field of a Document Library list to a mobile app by using the Visual Studio SharePoint List wizard. The Name field does not appear automatically when a user creates a mobile app for a document library in SharePoint. | + ## Building sites using Design Manager how-tos for SharePoint -|**Title**|**Summary**| -|:-----|:-----| -| [Use code to pin terms to navigation term sets in SharePoint](how-to-use-code-to-pin-terms-to-navigation-term-sets-in-sharepoint.md)
    |Learn how to use code to pin terms to navigation term sets.
    | -| [Create device channels in SharePoint](https://msdn.microsoft.com/library/339c7dba-95ee-46e0-8c76-0fe1adb6f366.aspx)
    |Learn how to create a device channel, change a device channel, delete a device channel, and reorder device channels in SharePoint.
    | -| [Map a network drive to the SharePoint Master Page Gallery](how-to-map-a-network-drive-to-the-sharepoint-master-page-gallery.md)
    |Learn how to map a network drive to the Master Page Gallery so that you can use Design Manager to upload design files in SharePoint.
    | -| [Convert an HTML file into a master page in SharePoint](how-to-convert-an-html-file-into-a-master-page-in-sharepoint.md)
    |With Design Manager, you can convert an .html file into a SharePoint master page, a .master file. After the conversion, the HTML file and master page are associated, so that when you edit and save the HTML file, the changes are synced to the associated master page.
    | -| [Apply a master page to a site in SharePoint](how-to-apply-a-master-page-to-a-site-in-sharepoint.md)
    |Learn how to map a master page to a SharePoint site.
    | -| [Create a page layout in SharePoint](how-to-create-a-page-layout-in-sharepoint.md)
    |When you use Design Manager to create a page layout, two files are created: an .aspx file that SharePoint uses, and an HTML version of that page layout that you can edit in your HTML editor. The HTML file and page layout are associated, so that whenever you edit and save the HTML file, your changes are synced to the associated page layout.
    | -| [Resolve errors and warnings when previewing a page in SharePoint](how-to-resolve-errors-and-warnings-when-previewing-a-page-in-sharepoint.md)
    |After you convert an HTML file into a SharePoint master page, or after you create a page layout, you can preview that page in the browser. But before you can preview a master page or page layout, you may have to resolve any issues that prevent the server-side preview from rendering your page.
    | -| [Change the preview page in SharePoint Design Manager](how-to-change-the-preview-page-in-sharepoint-design-manager.md)
    |Learn how to set, create, and change the preview page in Design Manager in SharePoint.
    | -| [Add a Device Channel Panel snippet in SharePoint](how-to-add-a-device-channel-panel-snippet-in-sharepoint.md)
    |A Device Channel Panel is a snippet that you can add to a master page or page layout to control what content is rendered for each channel that you create. The primary purpose of a Device Channel Panel is to selectively display different page fields on different channels from a single page layout.
    | -| [Add an Edit Mode Panel snippet in SharePoint](how-to-add-an-edit-mode-panel-snippet-in-sharepoint.md)
    |An Edit Mode Panel is a snippet that you can use to display instructions or other content to content authors, who see the contents of that panel only when they edit a page. Conversely, this snippet can also be configured to display its contents only in regular (view) mode instead of in edit mode.
    | -| [Add a web part zone snippet in SharePoint](how-to-add-a-web-part-zone-snippet-in-sharepoint.md)
    |A web part zone is a snippet that you can add to a page layout so that content authors can add, edit, or delete web parts in that zone.
    | -| [Add a Security Trim snippet in SharePoint](how-to-add-a-security-trim-snippet-in-sharepoint.md)
    |You can use a Security Trim snippet to display content only to specific users, based on a specific permission that those users must have and whether the users are authenticated or anonymous.
    | -| [SharePoint Design Manager image renditions](sharepoint-design-manager-image-renditions.md)
    |Learn how to create, edit, or delete image renditions. An image rendition defines the dimensions that are used to display images in SharePoint publishing sites.
    | -| [Add an image rendition to a page in SharePoint](https://msdn.microsoft.com/library/fp161347.aspx)
    |Learn how to use image renditions in a SharePoint publishing site.
    | -| [Crop an image rendition in SharePoint](https://msdn.microsoft.com/library/fp161347.aspx)
    |Learn how to specify the portion of the image to use in an image rendition.
    | - - +|Title|Summary| +|:-----|:-----| +| [Use code to pin terms to navigation term sets in SharePoint](how-to-use-code-to-pin-terms-to-navigation-term-sets-in-sharepoint.md) |Learn how to use code to pin terms to navigation term sets. | +| [Create device channels in SharePoint](https://msdn.microsoft.com/library/339c7dba-95ee-46e0-8c76-0fe1adb6f366.aspx) |Learn how to create a device channel, change a device channel, delete a device channel, and reorder device channels in SharePoint. | +| [Map a network drive to the SharePoint Master Page Gallery](how-to-map-a-network-drive-to-the-sharepoint-master-page-gallery.md) |Learn how to map a network drive to the Master Page Gallery so that you can use Design Manager to upload design files in SharePoint. | +| [Convert an HTML file into a master page in SharePoint](how-to-convert-an-html-file-into-a-master-page-in-sharepoint.md) |With Design Manager, you can convert an .html file into a SharePoint master page, a .master file. After the conversion, the HTML file and master page are associated, so that when you edit and save the HTML file, the changes are synced to the associated master page. | +| [Apply a master page to a site in SharePoint](how-to-apply-a-master-page-to-a-site-in-sharepoint.md) |Learn how to map a master page to a SharePoint site. | +| [Create a page layout in SharePoint](how-to-create-a-page-layout-in-sharepoint.md) |When you use Design Manager to create a page layout, two files are created: an .aspx file that SharePoint uses, and an HTML version of that page layout that you can edit in your HTML editor. The HTML file and page layout are associated, so that whenever you edit and save the HTML file, your changes are synced to the associated page layout. | +| [Resolve errors and warnings when previewing a page in SharePoint](how-to-resolve-errors-and-warnings-when-previewing-a-page-in-sharepoint.md) |After you convert an HTML file into a SharePoint master page, or after you create a page layout, you can preview that page in the browser. But before you can preview a master page or page layout, you may have to resolve any issues that prevent the server-side preview from rendering your page. | +| [Change the preview page in SharePoint Design Manager](how-to-change-the-preview-page-in-sharepoint-design-manager.md) |Learn how to set, create, and change the preview page in Design Manager in SharePoint. | +| [Add a Device Channel Panel snippet in SharePoint](how-to-add-a-device-channel-panel-snippet-in-sharepoint.md) |A Device Channel Panel is a snippet that you can add to a master page or page layout to control what content is rendered for each channel that you create. The primary purpose of a Device Channel Panel is to selectively display different page fields on different channels from a single page layout. | +| [Add an Edit Mode Panel snippet in SharePoint](how-to-add-an-edit-mode-panel-snippet-in-sharepoint.md) |An Edit Mode Panel is a snippet that you can use to display instructions or other content to content authors, who see the contents of that panel only when they edit a page. Conversely, this snippet can also be configured to display its contents only in regular (view) mode instead of in edit mode. | +| [Add a web part zone snippet in SharePoint](how-to-add-a-web-part-zone-snippet-in-sharepoint.md) |A web part zone is a snippet that you can add to a page layout so that content authors can add, edit, or delete web parts in that zone. | +| [Add a Security Trim snippet in SharePoint](how-to-add-a-security-trim-snippet-in-sharepoint.md) |You can use a Security Trim snippet to display content only to specific users, based on a specific permission that those users must have and whether the users are authenticated or anonymous. | +| [SharePoint Design Manager image renditions](sharepoint-design-manager-image-renditions.md) |Learn how to create, edit, or delete image renditions. An image rendition defines the dimensions that are used to display images in SharePoint publishing sites. | +| [Add an image rendition to a page in SharePoint](https://msdn.microsoft.com/library/fp161347.aspx) |Learn how to use image renditions in a SharePoint publishing site. | +| [Crop an image rendition in SharePoint](https://msdn.microsoft.com/library/fp161347.aspx) |Learn how to specify the portion of the image to use in an image rendition. | + ## Workflow how-tos for SharePoint -|**Title**|**Summary**| +|Title|Summary| |:-----|:-----| -| [Build and deploy workflow custom actions](how-to-build-and-deploy-workflow-custom-actions.md)
    |Learn how to model business processes whose requirements are not met by the existing library of workflow actions in SharePoint Designer by creating custom workflow actions in SharePoint.
    | - - +| [Build and deploy workflow custom actions](how-to-build-and-deploy-workflow-custom-actions.md) |Learn how to model business processes whose requirements are not met by the existing library of workflow actions in SharePoint Designer by creating custom workflow actions in SharePoint. | + ## Social and collaboration how-tos for SharePoint -|**Title**|**Summary**| -|:-----|:-----| -| [Read and write to the social feed by using the .NET client object model in SharePoint](how-to-learn-to-read-and-write-to-the-social-feed-by-using-the-net-client-object.md)
    |Create a console application that reads and writes to the social feed by using the SharePoint .NET client object model.
    | -| [Read and write to the social feed by using the REST service in SharePoint](how-to-learn-to-read-and-write-to-the-social-feed-by-using-the-rest-service-in-s.md)
    |Create a SharePoint-hosted app that uses the REST service to publish a post and get the personal feed for the current user.
    | -| [Create and delete posts and retrieve the social feed by using the .NET client object model in SharePoint](how-to-create-and-delete-posts-and-retrieve-the-social-feed-by-using-the-net-cli.md)
    |Learn how to create and delete microblog posts and retrieve social feeds by using the SharePoint .NET client object model.
    | -| [Create and delete posts and retrieve the social feed by using the JavaScript object model in SharePoint](how-to-create-and-delete-posts-and-retrieve-the-social-feed-by-using-the-javascr.md)
    |Learn how to create and delete microblog posts and retrieve social feeds by using the SharePoint JavaScript object model.
    | -| [Include mentions, tags, and links to sites and documents in posts in SharePoint](how-to-include-mentions-tags-and-links-to-sites-and-documents-in-posts-in-sharep.md)
    |Learn how to add [SocialDataItem](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialDataItem.aspx) objects to microblog posts, which render as mentions, tags, or links in SharePoint social feeds.
    | -| [Embed images, videos, and documents in posts in SharePoint](how-to-embed-images-videos-and-documents-in-posts-in-sharepoint-server.md)
    |Learn how to add [SocialAttachment](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialAttachment.aspx) objects to microblog posts, which render as embedded pictures, videos, and documents in SharePoint social feeds.
    | -| [Follow people by using the .NET client object model in SharePoint](how-to-follow-people-by-using-the-net-client-object-model-in-sharepoint.md)
    |Learn how to work with Following People features by using the SharePoint .NET client object model.
    | -| [Follow people by using the JavaScript object model in SharePoint](how-to-follow-people-by-using-the-javascript-object-model-in-sharepoint.md)
    |Learn how to work with Following People features by using the SharePoint JavaScript object model.
    | -| [Follow documents and sites by using the .NET client object model in SharePoint](how-to-follow-documents-and-sites-by-using-the-net-client-object-model-in-sharep.md)
    |Learn how to work with Following Content features by using the SharePoint .NET client object model.
    | -| [Follow documents, sites, and tags by using the REST service in SharePoint](how-to-follow-documents-sites-and-tags-by-using-the-rest-service-in-sharepoint-2.md)
    |Learn how to work with Following Content features by using the SharePoint REST service.
    | -| [Retrieve user profile properties by using the .NET client object model in SharePoint](how-to-retrieve-user-profile-properties-by-using-the-net-client-object-model-in.md)
    |Learn how to retrieve user profile properties programmatically by using the SharePoint .NET client object model.
    | -| [Retrieve user profile properties by using the JavaScript object model in SharePoint](how-to-retrieve-user-profile-properties-by-using-the-javascript-object-model-in.md)
    |Learn how to retrieve user properties and user profile properties programmatically by using the SharePoint JavaScript object model.
    | -| [Work with user profiles and organization profiles by using the server object model in SharePoint](how-to-work-with-user-profiles-and-organization-profiles-by-using-the-server-obj.md)
    |Learn how to create, retrieve, and change SharePoint user profiles and user profile properties programmatically by using the SharePoint server object model.
    | - - +|Title|Summary| +|:-----|:-----| +| [Read and write to the social feed by using the .NET client object model in SharePoint](how-to-learn-to-read-and-write-to-the-social-feed-by-using-the-net-client-object.md) |Create a console application that reads and writes to the social feed by using the SharePoint .NET client object model. | +| [Read and write to the social feed by using the REST service in SharePoint](how-to-learn-to-read-and-write-to-the-social-feed-by-using-the-rest-service-in-s.md) |Create a SharePoint-hosted app that uses the REST service to publish a post and get the personal feed for the current user. | +| [Create and delete posts and retrieve the social feed by using the .NET client object model in SharePoint](how-to-create-and-delete-posts-and-retrieve-the-social-feed-by-using-the-net-cli.md) |Learn how to create and delete microblog posts and retrieve social feeds by using the SharePoint .NET client object model. | +| [Create and delete posts and retrieve the social feed by using the JavaScript object model in SharePoint](how-to-create-and-delete-posts-and-retrieve-the-social-feed-by-using-the-javascr.md) |Learn how to create and delete microblog posts and retrieve social feeds by using the SharePoint JavaScript object model. | +| [Include mentions, tags, and links to sites and documents in posts in SharePoint](how-to-include-mentions-tags-and-links-to-sites-and-documents-in-posts-in-sharep.md) |Learn how to add [SocialDataItem](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialDataItem.aspx) objects to microblog posts, which render as mentions, tags, or links in SharePoint social feeds. | +| [Embed images, videos, and documents in posts in SharePoint](how-to-embed-images-videos-and-documents-in-posts-in-sharepoint-server.md) |Learn how to add [SocialAttachment](https://msdn.microsoft.com/library/Microsoft.SharePoint.Client.Social.SocialAttachment.aspx) objects to microblog posts, which render as embedded pictures, videos, and documents in SharePoint social feeds. | +| [Follow people by using the .NET client object model in SharePoint](how-to-follow-people-by-using-the-net-client-object-model-in-sharepoint.md) |Learn how to work with Following People features by using the SharePoint .NET client object model. | +| [Follow people by using the JavaScript object model in SharePoint](how-to-follow-people-by-using-the-javascript-object-model-in-sharepoint.md) |Learn how to work with Following People features by using the SharePoint JavaScript object model. | +| [Follow documents and sites by using the .NET client object model in SharePoint](how-to-follow-documents-and-sites-by-using-the-net-client-object-model-in-sharep.md) |Learn how to work with Following Content features by using the SharePoint .NET client object model. | +| [Follow documents, sites, and tags by using the REST service in SharePoint](how-to-follow-documents-sites-and-tags-by-using-the-rest-service-in-sharepoint-2.md) |Learn how to work with Following Content features by using the SharePoint REST service. | +| [Retrieve user profile properties by using the .NET client object model in SharePoint](how-to-retrieve-user-profile-properties-by-using-the-net-client-object-model-in.md) |Learn how to retrieve user profile properties programmatically by using the SharePoint .NET client object model. | +| [Retrieve user profile properties by using the JavaScript object model in SharePoint](how-to-retrieve-user-profile-properties-by-using-the-javascript-object-model-in.md) |Learn how to retrieve user properties and user profile properties programmatically by using the SharePoint JavaScript object model. | +| [Work with user profiles and organization profiles by using the server object model in SharePoint](how-to-work-with-user-profiles-and-organization-profiles-by-using-the-server-obj.md) |Learn how to create, retrieve, and change SharePoint user profiles and user profile properties programmatically by using the SharePoint server object model. | + ## Integrating location and map functionality how-tos for SharePoint -|**Title**|**Summary**| +|Title|Summary| |:-----|:-----| -| [Add a Geolocation column to a list programmatically in SharePoint](how-to-add-a-geolocation-column-to-a-list-programmatically-in-sharepoint.md)
    |Learn how to programmatically add a Geolocation column to a list in SharePoint. Integrate location information and maps in SharePoint lists and location-based websites by using the new Geolocation field creating your own geolocation-based field type.
    | -| [Set the Bing Maps key at the web and farm level in SharePoint](how-to-set-the-bing-maps-key-at-the-web-and-farm-level-in-sharepoint.md)
    |Learn how to set the Bing Maps key programmatically at the web and farm level by using the SharePoint client object model and Windows PowerShell, to enable the Bing Maps functionality in SharePoint lists and location-based web and mobile apps.
    | -| [Extend the Geolocation field type using client-side rendering](how-to-extend-the-geolocation-field-type-using-client-side-rendering.md)
    |Learn how to customize the SharePoint Geolocation field type programmatically using client-side rendering.
    | - - +| [Add a Geolocation column to a list programmatically in SharePoint](how-to-add-a-geolocation-column-to-a-list-programmatically-in-sharepoint.md) |Learn how to programmatically add a Geolocation column to a list in SharePoint. Integrate location information and maps in SharePoint lists and location-based websites by using the new Geolocation field creating your own geolocation-based field type. | +| [Set the Bing Maps key at the web and farm level in SharePoint](how-to-set-the-bing-maps-key-at-the-web-and-farm-level-in-sharepoint.md) |Learn how to set the Bing Maps key programmatically at the web and farm level by using the SharePoint client object model and Windows PowerShell, to enable the Bing Maps functionality in SharePoint lists and location-based web and mobile apps. | +| [Extend the Geolocation field type using client-side rendering](how-to-extend-the-geolocation-field-type-using-client-side-rendering.md) |Learn how to customize the SharePoint Geolocation field type programmatically using client-side rendering. | + ## Search how-tos for SharePoint -|**Title**|**Summary**| +|Title|Summary| |:-----|:-----| -| [Crawl associated external content types in SharePoint](how-to-crawl-associated-external-content-types-in-sharepoint.md)
    |Learn how to use the search specific properties in the Business Data Connectivity (BDC) service metadata model for crawling associations, and the different user experiences that you can enable.
    | -| [Crawl binary large objects (BLOBs) in SharePoint](how-to-crawl-binary-large-objects-blobs-in-sharepoint.md)
    |Learn how to modify the BDC model file for a database BCS indexing connector to enable the Search in SharePoint crawler to crawl binary large object (BLOB) data stored in a SQL Server database.
    | -| [Configure item-level security in SharePoint](how-to-configure-item-level-security-in-sharepoint.md)
    |Learn how to configure item level security when crawling external data with BCS indexing connectors in SharePoint.
    | -| [Use the Content Enrichment web service callout for SharePoint Server](how-to-use-the-content-enrichment-web-service-callout-for-sharepoint-server.md)
    |Learn how to implement the Content Enrichment web service in SharePoint to modify the managed properties of crawled items before they are indexed.
    | -| [Use a custom security trimmer for SharePoint Server search results](how-to-use-a-custom-security-trimmer-for-sharepoint-server-search-results.md)
    |This how-to guides you through the steps to implement???create, deploy, and register???a custom security trimmer for Search in SharePoint by using Visual Studio 2010.
    | - - +| [Crawl associated external content types in SharePoint](how-to-crawl-associated-external-content-types-in-sharepoint.md) |Learn how to use the search specific properties in the Business Data Connectivity (BDC) service metadata model for crawling associations, and the different user experiences that you can enable. | +| [Crawl binary large objects (BLOBs) in SharePoint](how-to-crawl-binary-large-objects-blobs-in-sharepoint.md) |Learn how to modify the BDC model file for a database BCS indexing connector to enable the Search in SharePoint crawler to crawl binary large object (BLOB) data stored in a SQL Server database. | +| [Configure item-level security in SharePoint](how-to-configure-item-level-security-in-sharepoint.md) |Learn how to configure item level security when crawling external data with BCS indexing connectors in SharePoint. | +| [Use the Content Enrichment web service callout for SharePoint Server](how-to-use-the-content-enrichment-web-service-callout-for-sharepoint-server.md) |Learn how to implement the Content Enrichment web service in SharePoint to modify the managed properties of crawled items before they are indexed. | +| [Use a custom security trimmer for SharePoint Server search results](how-to-use-a-custom-security-trimmer-for-sharepoint-server-search-results.md) |This how-to guides you through the steps to implement???create, deploy, and register???a custom security trimmer for Search in SharePoint by using Visual Studio 2010. | + ## BCS how-tos for SharePoint -|**Title**|**Summary**| -|:-----|:-----| -| [Create external content types for SQL Server in SharePoint](how-to-create-external-content-types-for-sql-server-in-sharepoint.md)
    |Learn how to create an external content type for SQL Server in SharePoint.
    | -| [Create an external content type from an OData source in SharePoint](how-to-create-an-external-content-type-from-an-odata-source-in-sharepoint.md)
    |Learn how to use Visual Studio 2012 to discover a published OData source and create a reusable external content type for use in BCS in SharePoint.
    | -| [Create an OData data service for use as a BCS external system](how-to-create-an-odata-data-service-for-use-as-a-bcs-external-system.md)
    |Learn how to create an Internet-addressable WCF service that uses OData to send notifications to SharePoint when the underlying data changes. These notifications are used to trigger events that are attached to external lists.
    | -| [Create an external list using an OData data source in SharePoint](how-to-create-an-external-list-using-an-odata-data-source-in-sharepoint.md)
    |Learn how to create an external list programmatically and bind it to an OData-based external content type in SharePoint.
    | -| [Create an add-in-scoped external content type in SharePoint](how-to-create-an-add-in-scoped-external-content-type-in-sharepoint.md)
    |Learn how to create external content types that can be installed, secured, and used in an SharePoint Add-in.
    | -| [Access external data with REST in SharePoint](how-to-access-external-data-with-rest-in-sharepoint.md)
    |Learn how to access external data from SharePoint by using Representational State Transfer (REST) URLs for BCS.
    | -| [Use the client code library to access external data in SharePoint](how-to-use-the-client-code-library-to-access-external-data-in-sharepoint.md)
    |Learn how to use the SharePoint client object model to work with BCS objects in SharePoint using browser-based scripting.
    | - - +|Title|Summary| +|:-----|:-----| +| [Create external content types for SQL Server in SharePoint](how-to-create-external-content-types-for-sql-server-in-sharepoint.md) |Learn how to create an external content type for SQL Server in SharePoint. | +| [Create an external content type from an OData source in SharePoint](how-to-create-an-external-content-type-from-an-odata-source-in-sharepoint.md) |Learn how to use Visual Studio 2012 to discover a published OData source and create a reusable external content type for use in BCS in SharePoint. | +| [Create an OData data service for use as a BCS external system](how-to-create-an-odata-data-service-for-use-as-a-bcs-external-system.md) |Learn how to create an Internet-addressable WCF service that uses OData to send notifications to SharePoint when the underlying data changes. These notifications are used to trigger events that are attached to external lists. | +| [Create an external list using an OData data source in SharePoint](how-to-create-an-external-list-using-an-odata-data-source-in-sharepoint.md) |Learn how to create an external list programmatically and bind it to an OData-based external content type in SharePoint. | +| [Create an add-in-scoped external content type in SharePoint](how-to-create-an-add-in-scoped-external-content-type-in-sharepoint.md) |Learn how to create external content types that can be installed, secured, and used in an SharePoint Add-in. | +| [Access external data with REST in SharePoint](how-to-access-external-data-with-rest-in-sharepoint.md) |Learn how to access external data from SharePoint by using Representational State Transfer (REST) URLs for BCS. | +| [Use the client code library to access external data in SharePoint](how-to-use-the-client-code-library-to-access-external-data-in-sharepoint.md) |Learn how to use the SharePoint client object model to work with BCS objects in SharePoint using browser-based scripting. | + ## Office and SharePoint application services how-tos for SharePoint -|**Title**|**Summary**| -|:-----|:-----| -| [Create report renderers for PerformancePoint Services in SharePoint](how-to-create-report-renderers-for-performancepoint-services-in-sharepoint.md)
    |Learn how to create the renderer component in a custom report extension for PerformancePoint Services.
    | -| [Create report editors for PerformancePoint Services in SharePoint](how-to-create-report-editors-for-performancepoint-services-in-sharepoint.md)
    |Learn how to create the editor component of a custom report extension for PerformancePoint Services.
    | -| [Create filter data providers for PerformancePoint Services in SharePoint](how-to-create-filter-data-providers-for-performancepoint-services-in-sharepoint.md)
    |Learn how to create the data provider component in a custom filter extension for PerformancePoint Services.
    | -| [Create filter editors for PerformancePoint Services in SharePoint](how-to-create-filter-editors-for-performancepoint-services-in-sharepoint.md)
    |Learn how to create the editor component of a custom filter extension for PerformancePoint Services.
    | -| [Create tabular data source providers for PerformancePoint Services in SharePoint](how-to-create-tabular-data-source-providers-for-performancepoint-services-in-sha.md)
    |Learn how to create the data source provider component in a custom tabular data source extension for PerformancePoint Services.
    | -| [Create tabular data source editors for PerformancePoint Services in SharePoint](how-to-create-tabular-data-source-editors-for-performancepoint-services-in-share.md)
    |Learn how to create the editor component of a custom tabular data source extension for PerformancePoint Services.
    | -| [Create scorecard transforms for PerformancePoint Services in SharePoint](how-to-create-scorecard-transforms-for-performancepoint-services-in-sharepoint-2.md)
    |Learn how to create custom scorecard transforms for PerformancePoint Services in SharePoint.
    | - - +|Title|Summary| +|:-----|:-----| +| [Create report renderers for PerformancePoint Services in SharePoint](how-to-create-report-renderers-for-performancepoint-services-in-sharepoint.md) |Learn how to create the renderer component in a custom report extension for PerformancePoint Services. | +| [Create report editors for PerformancePoint Services in SharePoint](how-to-create-report-editors-for-performancepoint-services-in-sharepoint.md) |Learn how to create the editor component of a custom report extension for PerformancePoint Services. | +| [Create filter data providers for PerformancePoint Services in SharePoint](how-to-create-filter-data-providers-for-performancepoint-services-in-sharepoint.md) |Learn how to create the data provider component in a custom filter extension for PerformancePoint Services. | +| [Create filter editors for PerformancePoint Services in SharePoint](how-to-create-filter-editors-for-performancepoint-services-in-sharepoint.md) |Learn how to create the editor component of a custom filter extension for PerformancePoint Services. | +| [Create tabular data source providers for PerformancePoint Services in SharePoint](how-to-create-tabular-data-source-providers-for-performancepoint-services-in-sha.md) |Learn how to create the data source provider component in a custom tabular data source extension for PerformancePoint Services. | +| [Create tabular data source editors for PerformancePoint Services in SharePoint](how-to-create-tabular-data-source-editors-for-performancepoint-services-in-share.md) |Learn how to create the editor component of a custom tabular data source extension for PerformancePoint Services. | +| [Create scorecard transforms for PerformancePoint Services in SharePoint](how-to-create-scorecard-transforms-for-performancepoint-services-in-sharepoint-2.md) |Learn how to create custom scorecard transforms for PerformancePoint Services in SharePoint. | + ## Authentication, authorization, and security how-tos in SharePoint -|**Title**|**Summary**| +|Title|Summary| |:-----|:-----| -| [Create a claims provider in SharePoint](how-to-create-a-claims-provider-in-sharepoint.md)
    |Learn how to create and implement a SharePoint claims provider that fulfills the requirements for claims augmentation and claims picking.
    | -| [Deploy a claims provider in SharePoint](how-to-deploy-a-claims-provider-in-sharepoint.md)
    |Learn how to deploy a SharePoint claims provider by using the features infrastructure and creating a class that inherits from [SPClaimProviderFeatureReceiver](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaimProviderFeatureReceiver.aspx) .
    | - - +| [Create a claims provider in SharePoint](how-to-create-a-claims-provider-in-sharepoint.md) |Learn how to create and implement a SharePoint claims provider that fulfills the requirements for claims augmentation and claims picking. | +| [Deploy a claims provider in SharePoint](how-to-deploy-a-claims-provider-in-sharepoint.md) |Learn how to deploy a SharePoint claims provider by using the features infrastructure and creating a class that inherits from [SPClaimProviderFeatureReceiver](https://msdn.microsoft.com/library/Microsoft.SharePoint.Administration.Claims.SPClaimProviderFeatureReceiver.aspx). | + ## See also -- [SharePoint development](https://docs.microsoft.com/sharepoint/dev/) -- [SharePoint Dev Center](https://developer.microsoft.com/sharepoint) -- [SharePoint Code Samples](https://developer.microsoft.com/SharePoint/gallery?filterBy=SharePoint,Samples) -- [Microsoft SharePoint Team Blog](https://developer.microsoft.com/en-us/office/blogs/) +- [SharePoint development](/sharepoint/dev/) +- [SharePoint Dev Center](https://developer.microsoft.com/sharepoint) +- [SharePoint Code Samples](https://developer.microsoft.com/SharePoint/gallery?filterBy=SharePoint,Samples) +- [Microsoft SharePoint Team Blog](https://developer.microsoft.com/office/blogs/) diff --git a/docs/general-development/incoming-claims-signing-into-sharepoint.md b/docs/general-development/incoming-claims-signing-into-sharepoint.md index 7c8ee1eb2..ad0994eab 100644 --- a/docs/general-development/incoming-claims-signing-into-sharepoint.md +++ b/docs/general-development/incoming-claims-signing-into-sharepoint.md @@ -1,9 +1,9 @@ --- title: Incoming claims Signing into SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how sign-ins work with SharePoint Server and provides details on several types of sign-ins. +ms.date: 06/13/2022 ms.assetid: 08c687aa-e485-4269-aea8-4333da3588a5 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/integrating-location-and-map-functionality-in-sharepoint.md b/docs/general-development/integrating-location-and-map-functionality-in-sharepoint.md index 735d8a8ac..12b4debe8 100644 --- a/docs/general-development/integrating-location-and-map-functionality-in-sharepoint.md +++ b/docs/general-development/integrating-location-and-map-functionality-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Integrating location and map functionality in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to integrate location and map functionality in SharePoint lists by using the new Geolocation field. +ms.date: 06/13/2022 ms.assetid: 10d4a904-ed27-4513-8c20-d2098aebf22c -localization_priority: Priority +ms.localizationpriority: high --- @@ -19,7 +19,7 @@ SharePoint introduces a new field type named Geolocation that enables you to ann > JSLink based customizations (client-side rendering) are not supported in modern experiences. This includes modern lists and libraries, including JSLink support in the list view web parts of the modern pages. Client-side rendering is supported in the classic experiences in SharePoint Online or in on-premises. > [!NOTE] -> An MSI package named SQLSysClrTypes.msi must be installed on every SharePoint front-end web server to view the geolocation field value or data in a list. This package installs components that implement the new geometry, geography, and hierarchy ID types in SQL Server 2008. By default, this file is installed for SharePoint Online. However, it is not for an on-premises deployment of SharePoint. You must be a member of the Farm Administrators group to perform this operation. To download SQLSysClrTypes.msi, see [Microsoft SQL Server 2008 R2 SP1 Feature Pack](https://www.microsoft.com/download/details.aspx?id=26728) for SQL Server 2008, or [Microsoft SQL Server 2012 Feature Pack](https://www.microsoft.com/download/details.aspx?id=29065)for SQL Server 2012 in the Microsoft Download Center. +> An MSI package named SQLSysClrTypes.msi must be installed on every SharePoint front-end web server to view the geolocation field value or data in a list. This package installs components that implement the new geometry, geography, and hierarchy ID types in SQL Server 2008. By default, this file is installed for SharePoint Online. However, it is not for an on-premises deployment of SharePoint. You must be a member of the Farm Administrators group to perform this operation. To download SQLSysClrTypes.msi, see [Microsoft SQL Server 2008 R2 SP1 Feature Pack](https://www.microsoft.com/download/details.aspx?id=30437) for SQL Server 2008, or [Microsoft SQL Server 2012 Feature Pack](https://www.microsoft.com/download/details.aspx?id=29065)for SQL Server 2012 in the Microsoft Download Center. diff --git a/docs/general-development/javascript-user-defined-functions-overview.md b/docs/general-development/javascript-user-defined-functions-overview.md index e8eefa662..03800bacc 100644 --- a/docs/general-development/javascript-user-defined-functions-overview.md +++ b/docs/general-development/javascript-user-defined-functions-overview.md @@ -1,9 +1,9 @@ --- title: JavaScript user-defined functions overview -ms.date: 12/21/2020 -ms.prod: sharepoint +description: Provides an overview of JavaScript user-defined functions (UDFs), including basic information on how they work in Excel Services. +ms.date: 06/13/2022 ms.assetid: fee38837-1985-4319-ba4e-b99c6ec66336 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/keyword-query-language-kql-syntax-reference.md b/docs/general-development/keyword-query-language-kql-syntax-reference.md index 440656a75..372ff30c7 100644 --- a/docs/general-development/keyword-query-language-kql-syntax-reference.md +++ b/docs/general-development/keyword-query-language-kql-syntax-reference.md @@ -1,9 +1,9 @@ --- title: Keyword Query Language (KQL) syntax reference -ms.date: 07/22/2019 -ms.prod: sharepoint +description: Describes how to construct KQL queries for Search in SharePoint and steps on how to use property restrictions and operators in KQL queries. +ms.date: 04/16/2023 ms.assetid: d8489f59-522f-433c-b9c1-69e597be51c7 -localization_priority: Priority +ms.localizationpriority: high --- @@ -82,7 +82,7 @@ For example, the following KQL queries return content items that contain the ter -KQL queries don't support suffix matching. +KQL queries don't support prefix matching with the wildcard * as prefix. @@ -93,7 +93,7 @@ When you use phrases in a free-text KQL query, Search in SharePoint returns only -KQL queries don't support suffix matching, so you can't use the wildcard operator before a phrase in free-text queries. However, you can use the wildcard operator after a phrase. +KQL queries don't support prefix matching with the wildcard * as prefix, so you can't use the wildcard operator before a phrase in free-text queries. However, you can use the wildcard operator after a phrase. @@ -390,7 +390,6 @@ Matches would include Microsoft Word documents authored by John Smith. This is t `author:"John Smith" AND filetype:docx` - ### Grouping property restrictions within a KQL query _**Applies to:** Office 365 | SharePoint Online | SharePoint 2019_ @@ -430,13 +429,30 @@ can be rewritten as: > `title:page` return matches with the exact term *page* while `title:(page)` also return matches for the term *pages*. +### Filter on items where a text property is empty or contains a value +_**Applies to:** Office 365 | SharePoint Online_ + +For managed properties of type [Text](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedDataType#Text) in the search schema which are set to be [Queryable](https://msdn.microsoft.com/library/Microsoft.Office.Server.Search.Administration.ManagedProperty.Queryable.aspx) you can use the wildcard operator (*) as the property expression to filter on items which either have a value or does not have a value. + +Syntax to return items where a text property has a value: + +`:*` + +Syntax to return items where a text property does not have a value: + +`NOT :*` + +The following example will return sites which are associated to a hub site, excluding the hub sites themselves: + +`(DepartmentId:* OR RelatedHubSites:*) AND contentclass:sts_site NOT IsHubSite:true` + + ## KQL operators for complex queries KQL syntax includes several operators that you can use to construct complex queries. - - + ### Boolean operators @@ -715,6 +731,4 @@ You can combine different parts of a keyword query by using the opening parenthe -- [Building search queries in SharePoint](building-search-queries-in-sharepoint.md) - - +- [Building search queries in SharePoint](building-search-queries-in-sharepoint.md) \ No newline at end of file diff --git a/docs/general-development/language-support-for-windows-phone-in-sharepoint.md b/docs/general-development/language-support-for-windows-phone-in-sharepoint.md index 305fdd8b3..4050a3a23 100644 --- a/docs/general-development/language-support-for-windows-phone-in-sharepoint.md +++ b/docs/general-development/language-support-for-windows-phone-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Language support for Windows Phone in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes the language support for the Windows Phone mobile app development Visual Studio templates installed by the SharePoint SDK. +ms.date: 06/13/2022 ms.assetid: 2c396a91-0fc1-4e25-942b-fffad49bd2c6 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -14,7 +14,7 @@ To develop your mobile application for more than one language, you need to globa -The Windows Phone SDK includes Visual Studio 2010 Express for Windows Phone, Windows Phone Emulator, XNA Game Studio, and Expression Blend. To get started, install the [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=27570) for Windows Phone development. Then install the [Microsoft SharePoint SDK for Windows Phone 7.1](https://www.microsoft.com/download/details.aspx?id=30476) to install the SharePoint templates for Windows Phone. +The Windows Phone SDK includes Visual Studio 2010 Express for Windows Phone, Windows Phone Emulator, XNA Game Studio, and Expression Blend. To get started, install the [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=29233) for Windows Phone development. Then install the [Microsoft SharePoint SDK for Windows Phone 7.1](https://www.microsoft.com/download/details.aspx?id=30476) to install the SharePoint templates for Windows Phone. After you set up your development environment and install the SharePoint SDK for Windows Phone, see [How to: Set up an environment for developing mobile apps for SharePoint](how-to-set-up-an-environment-for-developing-mobile-apps-for-sharepoint.md). diff --git a/docs/general-development/loop-back-soap-calls-and-direct-linking.md b/docs/general-development/loop-back-soap-calls-and-direct-linking.md index 38633b73c..8169965cd 100644 --- a/docs/general-development/loop-back-soap-calls-and-direct-linking.md +++ b/docs/general-development/loop-back-soap-calls-and-direct-linking.md @@ -1,9 +1,9 @@ --- title: Loop-Back SOAP Calls and Direct Linking -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes loop-back SOAP calls and directly linking to Microsoft.Office.Excel.Server.WebServices.dll for writing code within SharePoint Foundation. +ms.date: 06/13/2022 ms.assetid: bffc6565-636f-40d4-ba17-2511070ba5db -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/machine-translation-services-in-sharepoint.md b/docs/general-development/machine-translation-services-in-sharepoint.md index 9205e5ab7..d762c90dd 100644 --- a/docs/general-development/machine-translation-services-in-sharepoint.md +++ b/docs/general-development/machine-translation-services-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Machine Translation Services in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Learn about the Machine Translation Service, which is a new service application in SharePoint that provides automatic machine translation of files and sites. +ms.date: 03/03/2022 ms.assetid: 15a81428-da94-40b8-8ed4-6a12f05661e2 -localization_priority: Priority +ms.localizationpriority: high --- @@ -13,9 +13,11 @@ Learn about the Machine Translation Service, which is a new service application > [!NOTE] -> Using machine translation will allow users to send content to Microsoft for translation. Microsoft may use content users send us to improve the quality of translations. If you use the Machine Translation Service in your application, you are responsible for informing users that this application will allow users to send content to Microsoft for translation and that Microsoft may use content users send us to improve the quality of translations. See Microsoft Translator Privacy for more information. - - +> - In September 2018 it was announced that Machine Translation Services would be deprecated in SharePoint for Microsoft 365 but would remain supported. This service will become unavailable and unsupported entirely by the end of July 2022. +> - The Machine Translation Service API is marked as deprecated and will not be available through the SharePoint CSOM. +> - All existing instances of Machine Translation Server APIs will no longer display multilingual functionality in your Microsoft 365 environment by the end of July 2022. +> - This article will be retired in December of 2022. +> - If you're using modern communication sites in SharePoint, we recommend that you use the [modern multilingual sites and pages feature](https://support.microsoft.com/office/create-multilingual-communication-sites-pages-and-news-2bb7d610-5453-41c6-a0e8-6f40b3ed750c) instead of the variations Machine Translation Services feature. Machine Translation Service is a new service application in SharePoint that provides automatic machine translation of files and sites. When the Machine Translation Service application processes a translation request, it forwards the request to the [Microsoft Translator](https://www.microsoft.com/translator/) cloud-hosted machine translation service, where the actual translation work is performed. This cloud-service also powers the Microsoft Office, Lync, Yammer and Bing translation features. @@ -89,7 +91,7 @@ The following code shows how to translate a single file asynchronously. -```cs +```csharp SPServiceContext sc = SPServiceContext.GetContext(new SPSite(site)); TranslationJob job = new TranslationJob(sc, CultureInfo.GetCultureInfo(culture)); @@ -131,7 +133,7 @@ The following code shows how to translate every file within a document library a -```cs +```csharp SPServiceContext sc = SPServiceContext.GetContext(new SPSite(site)); TranslationJob job = new TranslationJob(sc, CultureInfo.GetCultureInfo(culture)); @@ -167,7 +169,7 @@ The following code shows how to translate a single file synchronously. -```cs +```csharp SPServiceContext sc = SPServiceContext.GetContext(new SPSite(site)); SyncTranslator job = new SyncTranslator(sc, CultureInfo.GetCultureInfo(jobCulture)); @@ -182,7 +184,7 @@ The following code shows how to translate a stream synchronously. -```cs +```csharp SPServiceContext sc = SPServiceContext.GetContext(new SPSite(site)); SyncTranslator job = new SyncTranslator(sc, CultureInfo.GetCultureInfo(jobCulture)); @@ -202,7 +204,7 @@ The following code shows how to translate a sequence of bytes synchronously. -```cs +```csharp SPServiceContext sc = SPServiceContext.GetContext(new SPSite(site)); SyncTranslator job = new SyncTranslator(sc, CultureInfo.GetCultureInfo(jobCulture)); @@ -302,7 +304,7 @@ To translate a single file asynchronously: -```cs +```csharp ClientContext clientContext = new ClientContext("http://serverName/sites/siteCollectionPath"); string culture = "cultureID"; @@ -326,7 +328,7 @@ To translate a folder asynchronously: -```cs +```csharp ClientContext clientContext = new ClientContext("http://serverName/sites/siteCollectionPath"); string culture = "cultureID"; @@ -350,7 +352,7 @@ To translate a library asynchronously: -```cs +```csharp ClientContext clientContext = new ClientContext("http://serverName/sites/siteCollectionPath"); string culture = "cultureID"; @@ -374,7 +376,7 @@ To translate a single file synchronously: -```cs +```csharp ClientContext clientContext = new ClientContext("http://serverName/sites/siteCollectionPath"); string culture = "cultureID" @@ -402,7 +404,7 @@ To retrieve all languages that are supported by the Machine Translation Service: -```cs +```csharp ClientContext clientContext = new ClientContext("http://serverName/sites/siteCollectionPath"); IEnumerable supportedLanguages = TranslationJob.EnumerateSupportedLanguages(clientContext); @@ -420,7 +422,7 @@ To check whether a specific language is supported: -```cs +```csharp ClientContext clientContext = new ClientContext("http://serverName/sites/siteCollectionPath"); clientResult isSupported; @@ -435,7 +437,7 @@ To retrieve all the file name extensions that are supported by the Machine Trans -```cs +```csharp ClientContext clientContext = new ClientContext("http://serverName/sites/siteCollectionPath"); IEnumerable fileExt = TranslationJob.EnumerateSupportedFileExtensions(clientContext); @@ -453,7 +455,7 @@ To check whether a specific file name extension is supported: -```cs +```csharp ClientContext clientContext = new ClientContext("http://serverName/sites/siteCollectionPath"); clientResult isSupported; @@ -469,7 +471,7 @@ To check the file size limit for a specific file name extension: -```cs +```csharp ClientContext clientContext = new ClientContext("http://serverName/sites/siteCollectionPath"); clientResult maxSize; diff --git a/docs/general-development/managed-metadata-and-navigation-in-sharepoint.md b/docs/general-development/managed-metadata-and-navigation-in-sharepoint.md index c41f3bd03..51a34ee49 100644 --- a/docs/general-development/managed-metadata-and-navigation-in-sharepoint.md +++ b/docs/general-development/managed-metadata-and-navigation-in-sharepoint.md @@ -2,9 +2,8 @@ title: Managed metadata and navigation in SharePoint description: Learn about enterprise managed metadata (EMM) and navigation features in SharePoint. ms.date: 05/18/2021 -ms.prod: sharepoint ms.assetid: b66d4ec1-a2ef-49cc-8ca5-a6b516bff02e -localization_priority: Normal +ms.localizationpriority: medium --- # Managed metadata and navigation in SharePoint @@ -32,7 +31,7 @@ Developing customizations with CSOM is very similar to developing .NET server ta You can use the following code examples to complete basic operations with the taxonomy CSOM. The first example creates a **Group** object, a **TermSet** object, and **Term** objects. The second example iterates on a **Group** object and writes its contents. -```cs +```csharp private void CreateColorsTermSet(string siteUrl) { ClientContext clientContext = new ClientContext(siteUrl); diff --git a/docs/general-development/managed-navigation-in-sharepoint.md b/docs/general-development/managed-navigation-in-sharepoint.md index 8da8b585a..d5a4cfc42 100644 --- a/docs/general-development/managed-navigation-in-sharepoint.md +++ b/docs/general-development/managed-navigation-in-sharepoint.md @@ -1,8 +1,8 @@ --- title: Managed navigation in SharePoint +description: Learn about the taxonomy-driven managed navigation feature in SharePoint. ms.date: 09/25/2017 -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium --- @@ -86,7 +86,7 @@ When you use the .NET client object model for taxonomy, you can create a new nav -```cs +```csharp public class NavigationTermSetTests { public void CreateNavigationTermSet() @@ -183,7 +183,7 @@ You can use the .NET server taxonomy classes and methods in the [Microsoft.Shar -```cs +```csharp ///Create a navigation term set. using (SPSite site = new SPSite(TestConfig.ServerUrl)) { diff --git a/docs/general-development/master-pages-the-master-page-gallery-and-page-layouts-in-sharepoint.md b/docs/general-development/master-pages-the-master-page-gallery-and-page-layouts-in-sharepoint.md index 8c9a23934..9a007a3d1 100644 --- a/docs/general-development/master-pages-the-master-page-gallery-and-page-layouts-in-sharepoint.md +++ b/docs/general-development/master-pages-the-master-page-gallery-and-page-layouts-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Master pages, the Master Page Gallery, and page layouts in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides article links about using Design Manager to work with master pages, page layouts, and display templates in publishing sites in SharePoint. +ms.date: 06/13/2022 ms.assetid: 80b9a360-bc2e-46c6-b0ca-1bc487b73db6 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/matching-the-sharepoint-designer-version-with-the-farm-version.md b/docs/general-development/matching-the-sharepoint-designer-version-with-the-farm-version.md index 3ea12dbe9..7768f9bf9 100644 --- a/docs/general-development/matching-the-sharepoint-designer-version-with-the-farm-version.md +++ b/docs/general-development/matching-the-sharepoint-designer-version-with-the-farm-version.md @@ -1,9 +1,9 @@ --- title: Matching the SharePoint Designer version with the farm version -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides information on different versions of SharePoint Designer and provides links to related articles. +ms.date: 06/13/2022 ms.assetid: 6ea44d3f-0b05-43d4-99ae-98886b6909f0 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/minimal-download-strategy-overview.md b/docs/general-development/minimal-download-strategy-overview.md index 6a9305c15..f7234028c 100644 --- a/docs/general-development/minimal-download-strategy-overview.md +++ b/docs/general-development/minimal-download-strategy-overview.md @@ -2,8 +2,7 @@ title: Minimal Download Strategy overview description: Learn about Minimal Download Strategy (MDS), a new feature in SharePoint that reduces page load time by sending only the differences when users navigate to a new page. ms.date: 01/27/2021 -ms.prod: sharepoint -localization_priority: Priority +ms.localizationpriority: high --- # Minimal Download Strategy overview diff --git a/docs/general-development/modify-sharepoint-components-for-mds.md b/docs/general-development/modify-sharepoint-components-for-mds.md index 940666892..42dff178e 100644 --- a/docs/general-development/modify-sharepoint-components-for-mds.md +++ b/docs/general-development/modify-sharepoint-components-for-mds.md @@ -1,9 +1,9 @@ --- title: Modify SharePoint components for MDS +description: Learn how to modify the components in your SharePoint project to take advantage of Minimal Download Strategy (MDS) in SharePoint. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: c967be7c-f29f-481a-9ce2-915ead315dcd -localization_priority: Normal +ms.localizationpriority: medium --- @@ -69,7 +69,7 @@ HTML regions and controls are MDS compatible if they are wrapped in **SharePoint -```cs +```csharp @@ -133,7 +133,7 @@ Your master page can also include style sheets and JavaScript files. The server -```cs +```csharp @@ -146,7 +146,7 @@ Note that you can have only one **CssLink** tag per master page, but you can hav -```cs +```csharp ``` @@ -196,7 +196,7 @@ Besides referencing JavaScript files, your ASP.NET pages can have inline JavaScr -```cs +```csharp // Your JavaScript code here. @@ -211,7 +211,7 @@ You also need to mark your controls and web parts as MDS compliant. The followin -```cs +```csharp [assembly: Microsoft.SharePoint.WebControls.MdsCompliantAttribute(IsCompliant = true)] namespace VisualWebPartProject2.VisualWebPart1 diff --git a/docs/general-development/office-365-cdn.md b/docs/general-development/office-365-cdn.md deleted file mode 100644 index ebf298b72..000000000 --- a/docs/general-development/office-365-cdn.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Use the Office 365 content delivery network -ms.date: 1/11/2018 -ms.prod: sharepoint -ms.assetid: 21ac1941-6a8b-4f33-8408-0c1f36295893 -localization_priority: Priority ---- - -# Use the Office 365 content delivery network (CDN) - -_**Applies to:** Office 365_ - -This page has been moved to: [Use the Office 365 Content Delivery Network (CDN) with SharePoint Online](https://docs.microsoft.com/office365/enterprise/use-office-365-cdn-with-spo). \ No newline at end of file diff --git a/docs/general-development/office-and-sharepoint-application-services.md b/docs/general-development/office-and-sharepoint-application-services.md index 5a8e20b26..a19e4582b 100644 --- a/docs/general-development/office-and-sharepoint-application-services.md +++ b/docs/general-development/office-and-sharepoint-application-services.md @@ -2,9 +2,8 @@ title: Office 2013 and SharePoint application services description: Learn about Access Services, Excel Services, Machine Translation Service, PerformancePoint Services, PowerPoint Automation Services, Visio Services, and Word Automation Services. ms.date: 12/14/2020 -ms.prod: sharepoint ms.assetid: f962922c-2967-492f-9a89-5ad10a1a6dd3 -localization_priority: Normal +ms.localizationpriority: medium --- # Office 2013 and SharePoint application services diff --git a/docs/general-development/office-documentation-copyright-notice.md b/docs/general-development/office-documentation-copyright-notice.md index 66b91e978..de8b51d00 100644 --- a/docs/general-development/office-documentation-copyright-notice.md +++ b/docs/general-development/office-documentation-copyright-notice.md @@ -1,9 +1,9 @@ --- title: Office 2013 documentation copyright notice -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides a documentation copyright notice for Microsoft Office 2013, which includes trademark information for various Microsoft applications. +ms.date: 06/13/2022 ms.assetid: a9c2f3d9-cea2-49a3-b709-40dc614b9f86 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/optimize-page-performance-in-sharepoint.md b/docs/general-development/optimize-page-performance-in-sharepoint.md index 83e73e3f6..3da27e05c 100644 --- a/docs/general-development/optimize-page-performance-in-sharepoint.md +++ b/docs/general-development/optimize-page-performance-in-sharepoint.md @@ -1,10 +1,9 @@ --- title: Optimize page performance in SharePoint -description: Learn about features to improve performance in pages in SharePoint. These features can be used to enhance the experience in geographically distributed implementations. -ms.date: 12/14/2020 -ms.prod: sharepoint +description: Learn about features to improve performance in SharePoint pages and enhance experiences in geographically distributed implementations. +ms.date: 03/28/2023 ms.assetid: 262caeef-64fd-4e02-b947-d772faf01159 -localization_priority: Priority +ms.localizationpriority: high --- # Optimize page performance in SharePoint @@ -244,7 +243,7 @@ To use MDS, controls and web parts have to register page resources by using the | Common practice for rendering content | MDS-compliant alternative | | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- | -| `output.Write("`output.Write(SPHttpUtility.NoEncode("HiddenField));`
    `output.Write("\\" value=\\"");`
    `output.Write(DigestValue);`
    `output.Write("\\" />");` | `SPPageContentManager.RegisterHiddenField(this, "HiddenField", DigestValue);` | +| `output.Write("`output.Write(SPHttpUtility.NoEncode("HiddenField));`
    `output.Write("\\" value=\\"");`
    `output.Write(DigestValue);`
    `output.Write("\\" />");` | `SPPageContentManager.RegisterHiddenField(this, "HiddenField", DigestValue);` | | `Page.ClientScript.RegisterClientScriptBlock(typeof(MyType), "MyKey", "var myvar=1", true);` | `SPPageContentManager.RegisterClientScriptBlock(this, typeof(MyType), "MyKey", "var myvar=1");` | > [!NOTE] @@ -490,7 +489,7 @@ The Developer Dashboard is rebuilt for SharePoint to provide more information, i To learn more about the Developer Dashboard: -- [Use the developer dashboard](https://docs.microsoft.com/sharepoint/dev/spfx/use-developer-dashboard). +- [Use the developer dashboard](/sharepoint/dev/spfx/use-developer-dashboard). - [Renewed Developer Dashboard](https://download.microsoft.com/download/7/7/3/773CA2C2-579B-408C-808E-A6F561194E20/Ig15_SP_IT_M10V3_devdash.pptx) (PowerPoint slide deck). To enable the Developer Dashboard, use the following Windows PowerShell snippet code. diff --git a/docs/general-development/optimize-sharepoint-site-accessibility.md b/docs/general-development/optimize-sharepoint-site-accessibility.md index 531af956c..668f10386 100644 --- a/docs/general-development/optimize-sharepoint-site-accessibility.md +++ b/docs/general-development/optimize-sharepoint-site-accessibility.md @@ -1,9 +1,9 @@ --- title: Optimize SharePoint site accessibility -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to improve SharePoint page accessibility and the SharePoint site experience for users with a variety of accessibility needs. +ms.date: 06/13/2022 ms.assetid: 0a3fbfb3-1a0b-4902-9317-525cf2f63d98 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/overview-of-design-manager-in-sharepoint.md b/docs/general-development/overview-of-design-manager-in-sharepoint.md index 7d08d6b9b..7efc7b2f2 100644 --- a/docs/general-development/overview-of-design-manager-in-sharepoint.md +++ b/docs/general-development/overview-of-design-manager-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Overview of Design Manager in SharePoint -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides an overview of the Design Manager in SharePoint, which is a publishing feature that brands SharePoint websites. +ms.date: 06/13/2022 ms.assetid: 29834b3f-3815-4347-91d3-296387663114 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/overview-of-sharepoint-and-the-volume-shadow-copy-service.md b/docs/general-development/overview-of-sharepoint-and-the-volume-shadow-copy-service.md index 457668c8c..0e2d05564 100644 --- a/docs/general-development/overview-of-sharepoint-and-the-volume-shadow-copy-service.md +++ b/docs/general-development/overview-of-sharepoint-and-the-volume-shadow-copy-service.md @@ -1,9 +1,9 @@ --- title: Overview of SharePoint and the Volume Shadow Copy Service -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides an overview of SharePoint and the Volume Shadow Copy Service (VSS), which simplifies backing up server solutions. +ms.date: 06/13/2022 ms.assetid: d1cb6653-bfc0-4af2-b221-d7d30cb40d84 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/overview-of-the-sharepoint-mobile-client-authentication-object-model.md b/docs/general-development/overview-of-the-sharepoint-mobile-client-authentication-object-model.md index d9bbe3fcc..a4d8050d7 100644 --- a/docs/general-development/overview-of-the-sharepoint-mobile-client-authentication-object-model.md +++ b/docs/general-development/overview-of-the-sharepoint-mobile-client-authentication-object-model.md @@ -1,9 +1,9 @@ --- title: Overview of the SharePoint mobile client authentication object model +description: Get an overview of development with the authentication APIs of the SharePoint client object model for Silverlight. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: 00ee657f-a32a-495e-80b4-83ac0f60df44 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -51,7 +51,7 @@ The following code shows these steps. -```cs +```csharp ClientContext context = new ClientContext(ListUrl); @@ -146,7 +146,7 @@ The following code shows these steps. -```cs +```csharp ODataAuthenticator oat = new ODataAuthenticator(); @@ -187,7 +187,7 @@ The following is an example of an implementation of an **OnAuthenticationComplet -```cs +```csharp void OnAuthenticationCompleted(object sender, AuthenticationCompletedEventArgs e) { @@ -220,7 +220,7 @@ All that the **OnSendingRequest** handler needs to do is set the cookie containe -```cs +```csharp void OnSendingRequest(object sender, SendingRequestEventArgs e) { @@ -245,7 +245,7 @@ void OnSendingRequest(object sender, SendingRequestEventArgs e) -```cs +```csharp Authenticator at = new Authenticator(); at.AuthenticationMode = ClientAuthenticationMode.MicrosoftOnline; @@ -274,7 +274,7 @@ To authenticate against a SharePoint Online URL, set the **AuthenticationMode** -```cs +```csharp Authenticator auth = new Authenticator("domain\\\\name", "xyz"); auth.FederationPassiveAuthUri = "urn:oasis:names:tc:SAML:2.0:ac:classes:Password"; diff --git a/docs/general-development/overview-of-the-sharepoint-mobile-object-model.md b/docs/general-development/overview-of-the-sharepoint-mobile-object-model.md index cd0f3e517..334fba6a5 100644 --- a/docs/general-development/overview-of-the-sharepoint-mobile-object-model.md +++ b/docs/general-development/overview-of-the-sharepoint-mobile-object-model.md @@ -1,9 +1,9 @@ --- title: Overview of the SharePoint mobile object model +description: Learn about the new public classes in the SharePoint server object model and Silverlight client object model that are used to develop integrated solutions for SharePoint and Windows Phone 7.5. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: 72319846-d02d-49e7-b830-48eb8f5715cb -localization_priority: Normal +ms.localizationpriority: medium --- @@ -13,18 +13,18 @@ Learn about the new public classes in the SharePoint server object model and Sil All classes in this section are in the **Microsoft.SharePoint.Client** namespace. In addition to the APIs in this section, most of the classes and members in the section Server Object Model for SharePoint Mobility are also callable in the client object model. For classes that begin with "SP", the client object model name has the "SP" removed. In other cases, the client object model name is specified. Member names are the same in the client object model except where specified otherwise. - + > [!IMPORTANT] > JSLink based customizations (client-side rendering) are not supported in modern experiences. This includes modern lists and libraries, including JSLink support in the list view web parts of the modern pages. Client-side rendering is supported in the classic experiences in SharePoint Online or in on-premises. ### AlternateUrl class Represents an alternative URL for a web application and the zone to which it applies. - - - -```cs + + + +```csharp public class AlternateUrl ``` @@ -33,28 +33,28 @@ public class AlternateUrl #### Properties **Uri** (read-only) - - - + + + Gets the URI of the alternate URL. - - - -```cs + + + +```csharp public String Uri ``` **UrlZone** (read-only) - - - + + + Gets the zone of the alternate URL. - - - + + + @@ -63,18 +63,18 @@ public UrlZone UrlZone ``` The UrlZone class is the client object model version of the SPUrlZone class in the server object model. For more information about it, see the [SharePoint 2010 Software Development Kit (SDK)](https://msdn.microsoft.com/library/ee557253.aspx). - - - + + + ### AuthenticationCompletedEventArgs class Provides data about an **AuthenticationCompleted** event. - - - -```cs + + + +```csharp public sealed class AuthenticationCompletedEventArgs : AsyncCompletedEventArgs ``` @@ -83,44 +83,44 @@ public sealed class AuthenticationCompletedEventArgs : AsyncCompletedEventArgs #### Constructors Initializes a new instance of the AuthenticationCompletedEventArgs class. - - - -```cs + + + +```csharp public AuthenticationCompletedEventArgs(Exception error, bool canceled, HttpStatusCode userState) ``` **Parameters** - - - + + + - _error_ is the Exception object if there was an exception thrown in the authentication attempt. - - + + - _canceled_ is true if the authentication attempt was canceled before it could succeed or fail. - - + + - _userState_ is the HttpStatusCode returned by the server. - - + + #### Properties **HttpStatusCode** (read-only) - - - + + + Gets the status returned by the server after an authentication attempt. - - - -```cs + + + +```csharp public HttpStatusCode HttpStatusCode ``` @@ -128,29 +128,29 @@ public HttpStatusCode HttpStatusCode ### AuthenticationStatus enum Specifies the current state of an authentication attempt. - - - + + + - **NotStarted** - - + + - **InProgress** - - + + - **CompletedSuccess** - - + + - **CompletedException** - - + + ### Authenticator class Provides methods for authenticating a user on a SharePoint website. - - - + + + ``` public class Authenticator : ICredentials @@ -160,173 +160,173 @@ public class Authenticator : ICredentials #### Constructors Initializes a new instance of the class. - - - -```cs + + + +```csharp public Authenticator() public Authenticator(Uri uagServerUrl) ``` **Parameters** - - - + + + _uagServerUrl_ is the absolute URL of a United Access Gateway (UAG) server. - - - -```cs + + + +```csharp public Authenticator(string userName, string password) ``` **Parameters** - - - + + + _userName_ is the name for the credentials. - - - + + + _password_ is the password for the credentials. - - - -```cs + + + +```csharp public Authenticator(string userName, string password, string domain) ``` **Parameters** - - - + + + _userName_ is the name for the credentials. - - - + + + _password_ is the password for the credentials. - - - + + + _domain_ is the name of the domain or computer where the credentials are verified, typically the domain of the current user. - - - -```cs + + + +```csharp public Authenticator(string userName, string password, Uri uagServerUrl) ``` **Parameters** - - - + + + _userName_ is the name for the credentials. - - - + + + _password_ is the password for the credentials. - - - + + + _uagServerUrl_ is the absolute URL of a United Access Gateway (UAG) server. - - - -```cs + + + +```csharp public Authenticator(string userName, string password, string domain, Uri uagServerUrl) ``` **Parameters** - - - + + + _userName_ is the name for the credentials. - - - + + + _password_ is the password for the credentials. - - - + + + _domain_ is the name of the domain or computer where the credentials are verified, typically the domain of the current user. - - - + + + _uagServerUrl_ is the absolute URL of a United Access Gateway (UAG) server. - - - + + + #### Methods **ClearAllApplicationSettings** - - - + + + Clears all cookies, credentials, and UAG settings from the cache. - - - -```cs + + + +```csharp public static void ClearAllApplicationSettings ``` **ClearAllCookies** - - - + + + Clears all stored cookies and sets the **Status** property of all **Authenticator** objects to **NotStarted**. - - - -```cs + + + +```csharp public static void ClearAllCookies() ``` **ClearAllCredentials** - - - + + + Clears all credentials from the cache and sets the **Status** property of all **Authenticator** objects to **NotStarted**. - - - -```cs + + + +```csharp public static void ClearAllCredentials() ``` **GetCredential** - - - + + + Gets a credential object for the specified uri and authentication type. - - - + + + @@ -335,32 +335,32 @@ public NetworkCredential GetCredential(Uri uri, string authType) ``` **Parameters** - - - + + + - _uri_ is the URI, including port, for which the client is providing authentication. - - + + - _authType_ is the type of authentication requested. - - + + This method is only used for anonymous authentication. If _authType_ is not "Basic", an empty object is returned. For more information about the **NetworkCredential** class, see [NetworkCredential Class](https://msdn.microsoft.com/library/system.net.networkcredential.aspx). - - - + + + **IsRequestUnauthorized** - - - + + + Returns true if the authorization request failed because of an invalid cookie or credentials. - - - -```cs + + + +```csharp public static bool IsRequestUnauthorized(ClientRequestFailedEventArgs failedEventArgs) ``` @@ -368,13 +368,13 @@ public static bool IsRequestUnauthorized(ClientRequestFailedEventArgs failedEven #### Properties **AllowSmartRouting** - - - + + + Gets or sets an indicator of whether smart routing is enabled. - - - + + + @@ -383,36 +383,36 @@ public bool AllowSmartRouting ``` When smart routing is enabled, the **Authenticator** object tries to connect to the server that is running SharePoint and the UAG server and uses whichever responds first as its communication channel. If there is no UAG server, this property is ignored. The default is **true**. If set to **false**, the UAG server is always used. - - - + + + **AuthenticatorMode** - - - + + + Gets or sets the authentication mode. - - - -```cs + + + +```csharp public ClientAuthenticationMode AuthenticationMode ``` For more information about the **ClientAuthenticationMode** enum, see later in this document. - - - + + + **CookieCachingEnabled** - - - + + + Gets or sets an indicator of whether cookies are cached. - - - + + + @@ -421,13 +421,13 @@ public bool CookieCachingEnabled ``` If you enable caching of cookies, consider that the cookies expire at some point. If they are expired when **ExecuteQueryAsync** is called, then it fails and the callback for failure runs. Accordingly, if you set this property to true, you must add code to the callback for failure that clears the cache if this happens. Here is an example, where `execQueryArgs` is of the type **ClientRequestFailedEventArgs** passed in the failure callback of **ExecuteQueryAsync**. - - - -```cs + + + +```csharp if (Authenticator.IsRequestUnauthorized(execQueryArgs)) { (sender as Authenticator).ClearCookies(); @@ -435,157 +435,157 @@ if (Authenticator.IsRequestUnauthorized(execQueryArgs)) ``` **CredentialCachingEnabled** - - - + + + Gets or sets an indicator of whether credentials are cached. - - - -```cs + + + +```csharp public bool CredentialCachingEnabled ``` **Domain** - - - + + + Gets or sets the domain or computer for the credential, usually this is the domain of the current user. - - - -```cs + + + +```csharp public string Domain ``` When this property is set to a new value, the **Status** property is set to NotStarted. - - - + + + **NavigateBackAfterAuthentication** - - - + + + Gets or sets a indicator of whether the user should be navigated back to the previous page from the login page. - - - -```cs + + + +```csharp public bool NavigateBackAfterAuthentication ``` **Password** - - - + + + Gets or sets the password for the credential. - - - -```cs + + + +```csharp public string Password ``` When this property is set to a new value, the **Status** property is set to **NotStarted**. - - - + + + **PromptOnFailure** - - - + + + Gets or sets an indicator of whether the user should be prompted to enter a name and password if initial authentication fails. - - - -```cs + + + +```csharp public bool PromptOnFailure ``` **Status** (read-only) - - - + + + Gets the status of the attempt to authenticate. - - - -```cs + + + +```csharp public AuthenticationStatus Status ``` See earlier in this document for information about the **AuthenticationStatus** class. - - - + + + **UagServerUrl** - - - + + + Gets or sets the URL of the UAG server. - - - -```cs + + + +```csharp public Uri UagServerUrl ``` **UserName** - - - + + + Gets or sets the user name for the credential. - - - -```cs + + + +```csharp public string UserName ``` When this property is set to a new value, the **Status** property is set to **NotStarted**. - - - + + + #### Events **AuthenticationCompleted** - - - + + + Raised when the authentication attempt is completed, regardless of whether it succeeded. - - - -```cs + + + +```csharp public event EventHandler AuthenticationCompleted; ``` @@ -593,26 +593,22 @@ public event EventHandler AuthenticationComple ### ClientAuthenticationMode enum Specifies an authentication mode for an **Authenticator** object. This is an existing enum to which a new value, **BrowserBasedAuthentication** has been added. - - - +| Type | Description | +| :----------------------------- | :------------------------------------------------------------------- | +| **FormsAuthentication** | Represents forms-based authentication mode | +| **Anonymous** | Represents anonymous access mode | +| **BrowserBasedAuthentication** | Represents Microsoft Office Forms Based Authentication (MSOFBA) mode | -|**Default**|| -|:-----|:-----| -|**FormsAuthentication**
    |Represents forms-based authentication mode
    | -|**Anonymous**
    |Represents anonymous access mode
    | -|**BrowserBasedAuthentication**
    |Represents Microsoft Office Forms Based Authentication (MSOFBA) mode
    | - ### ODataAuthenticator class Provides methods for authenticating a user on a SharePoint website. - - - -```cs + + + +```csharp public class ODataAuthenticator : Authenticator ``` @@ -620,65 +616,65 @@ public class ODataAuthenticator : Authenticator #### Constructors The constructors are identical to the parent class constructors. For more information, see Authenticator Class earlier in this document. - - - + + + #### Methods **Authenticate** - - - -Authenticates a user to the specified website. - - - -```cs -public new void Authenticate(Uri serverUrl) -``` +Authenticates a user to the specified website. + + + + + + +```csharp +public new void Authenticate(Uri serverUrl) +``` + +The `new` keyword is used because the parent class has an internal method of the same name. + + -The `new` keyword is used because the parent class has an internal method of the same name. - - - #### Properties **CookieContainer** (read-only) - - - + + + Gets a container with the cookies for requests to the website. - - - -```cs + + + +```csharp public new CookieContainer CookieContainer ``` The `new` keyword is used because the parent class has an internal method of the same name. - - - + + + **ResolvedUrl** (read-only) - - - + + + Gets the URL that is used for communication to the server that is running SharePoint when an **ODataAuthenticator** is being used. This may be the URL published on the UAG server or, if the **AllowSmartRouting** property is true, this may be the SharePoint intranet URL if it is reached first when the **Authenticate** method is called. - - - -```cs + + + +```csharp public Uri ResolvedUrl ``` @@ -686,11 +682,11 @@ public Uri ResolvedUrl ### ServerSettings class Provides a method for getting the Alternate URLs of the web application that contains a website. - - - -```cs + + + +```csharp public static class ServerSettings ``` @@ -698,71 +694,71 @@ public static class ServerSettings #### Methods **GetAlternateUrls** - - - + + + Gets the alternate URLs of the specified website. - - - -```cs + + + +```csharp public static ClientObjectList GetAlternateUrls(ClientRuntimeContext context) ``` **Parameters** - - - + + + _context_ is the an object that represents the current client context. - - - + + + See earlier in this document for information about the **AlternateUrl** class. - - - + + + ## Server object model for SharePoint mobility All classes in this section are in the **Microsoft.SharePoint** namespace. Except where specified, these are all available also in the client object model. For classes that begin with "SP", the client object model name has the "SP" removed. In other cases, the client object model name is specified. Member names are the same in the client object model except where specified otherwise. - - - + + + ### GeolocationFieldControl class -(Not available in client object model.) - - - +(Not available in client object model.) + + + Governs the rendering of **SPFieldGeolocation** fields. An object of this type is used as the value of the **FieldRenderingControl** property of a **SPFieldGeolocation** object. - - - -```cs + + + +```csharp public class GeolocationFieldControl : BaseFieldControl ``` In connection with this class, note also that there are two rendering templates, one for Display mode and one for New and Edit mode. They are defined in the file %SHAREPOINTROOT%\\TEMPLATE\\ControlTemplates\\DefaultTemplates.ascx. - - - + + + #### Fields The following are used to render the field in the New and Edit modes. - - - -```cs + + + +```csharp protected TextBox m_latitudeBox; protected TextBox m_longitudeBox; protected Label m_longitudeLabel; @@ -773,9 +769,9 @@ protected Label m_latitudeLabel; #### Methods No non-derived public properties are introduced with this class. There are standard overrides of some derived methods as indicated in the following table. - - - + + + |**Method**|**This override???**| @@ -784,14 +780,14 @@ No non-derived public properties are introduced with this class. There are stand |Focus
    |Gives focus to the longitude textbox child control.
    | |OnPreRender
    |Calls the base method.
    | |Validate
    |Validates the latitude and longitude values that appear in the user interface (UI). This does not validate the **Longitude** and **Latitude** properties of the underlying **SPFieldGeolocatonValue** object, which will differ if the user has changed one or more of these values in the UI and not yet saved the changes.
    | - + #### Properties No non-derived public properties are introduced with this class. There are standard overrides of some derived properties as indicated in the following table. - - - + + + |**Property**|**This override...**| @@ -800,134 +796,134 @@ No non-derived public properties are introduced with this class. There are stand |DefaultTemplateName
    |Returns "GeolocationField"
    | |DisplayTemplateName
    |Returns "GeolocationDisplayField"
    | |Value
    |Gets or sets the value that is rendered by using a **SPFieldGeolocationValue** object.
    | - + ### SPFieldGeolocation class Represents a field (column) that holds a location on the globe defined by longitude, latitude, and possibly altitude. - - - -```cs + + + +```csharp public class SPFieldGeolocation : SPField ``` In connection with this class, the **Geolocation** field type is defined in % _SHAREPOINTROOT%_\\TEMPLATE\\XML\\fldtypes.xml. - - - + + + #### Constructors (overloaded) Initializes a new instance of the **SPFieldGeolocation** class. - - - -```cs + + + +```csharp public SPFieldGeolocation(SPFieldCollection fields, string fieldName) public SPFieldGeolocation(SPFieldCollection fields, string fieldName, string displayName) ``` **Parameters** - - - + + + - _fields_ is the collection of field types to which the new field type object is added. - - + + - _fieldName_ is an internal name of the new field type. - - + + - _displayName_ is a friendly name of the new field type. - - + + #### Methods **GetFieldValueForClientRender** - - - + + + Gets the value of the field so that it can be rendered on the client. - - - -```cs + + + +```csharp public override object GetFieldValueForClientRender(SPItem item, SPControlMode mode) ``` Parameters - - - + + + - _item_ is the current list item. - - + + - _mode_ is the current rendering mode such as New, Edit, or Display. - - + + **GetJsonClientFormFieldSchema** - - - + + + Gets the field schema as JavaScript Object Notation (JSON). - - - -```cs + + + +```csharp public override Dictionary GetJsonClientFormFieldSchema(SPControlMode mode) ``` **Parameters** - - - + + + _mode_ is the current rendering mode such as New, Edit, or Display. - - - + + + **ValidateAndParseValue** - - - + + + Verifies that the specified list item is not null and then verifies that the string is structured in compliance with Open Geospatial Consortium (OGC) standards and returns it as an object that is castable to the **SPFieldGeolocationValue** type. - - - -```cs + + + +```csharp public override object ValidateAndParseValue(SPListItem item, string value) ``` **Parameters** - - - + + + - _item_ is a list item that is to be updated with the value. - - + + - _value_ is a string representation of a geolocation value. - - + + The following methods are standard overrides of inherited methods that were in SharePoint 2010. The specific information for this class is in the following table. - - - + + + |**Method**|**This override...**| @@ -935,56 +931,56 @@ The following methods are standard overrides of inherited methods that were in S |GetFieldValue(String s)
    |Returns the specified value as an Object that is castable to SPFieldGeolocationValue.
    | |GetFieldValueAsText(Object o)
    |Wraps GetValidatedString.
    | |GetValidatedString(Object o)
    |Verifies that the specified value is structured in compliance with Open Geospatial Consortium (OGC) standards and returns it as a string.
    | - + #### Properties **JSLink** - - - + + + Gets or sets the name of the JavaScript file that renders the fields of the **SPFieldGeolocation** type. - + > [!NOTE] -> The JSLink property is not supported on Survey or Events lists. A SharePoint calendar is an Events list. - - - +> The JSLink property is not supported on Survey or Events lists. A SharePoint calendar is an Events list. + + + -```cs +```csharp public override string JSLink ``` The default value is "clienttemplates.js|Geolocationfieldtemplate.js|sp.map.js". - - - + + + **FieldRenderingMobileWebControl** - - - + + + Gets the **SPMobileGeolocationField** object that renders the field. - - - -```cs + + + +```csharp public override SPMobileBaseFieldControl FieldRenderingMobileControl ``` This property replaces the obsolete **FieldRenderingMobileControl**. - - - + + + The other properties are standard overrides of inherited properties that were in SharePoint 2010. The specific information for this class is in the following table. - - - + + + |**Property**|**The override...**| @@ -994,16 +990,16 @@ The other properties are standard overrides of inherited properties that were in |Filterable
    |Returns **false**.
    | |Sortable
    |Returns **false**.
    | |[Obsolete]
    FieldRenderingMobileControl
    |Returns a **SPMobileGeolocationField** object.
    | - + ### SPFieldGeolocationValue class Represents a location on the globe defined by longitude, latitude, and possibly altitude too. - - - -```cs + + + +```csharp public class SPFieldGeolocationValue : SPFieldGeographyValue ``` @@ -1011,11 +1007,11 @@ public class SPFieldGeolocationValue : SPFieldGeographyValue #### Constructors (overloaded) Initializes a new instance of the **SPFieldGeolocationValue** class. - - - -```cs + + + +```csharp public SPFieldGeolocationValue() public SPFieldGeolocationValue(string fieldValue) public SPFieldGeolocationValue(double latitude, double longitude) @@ -1024,72 +1020,72 @@ public SPFieldGeolocationValue(double latitude, double longitude, double altitud ``` **Parameters** - - - + + + - _fieldValue_ is a string in one of the following Well-Known Text (WKT) formats: - + - "Point( _longitude_ _latitude_)", where _longitude_ and _latitude_ are strings of one or more numerals, optionally including one period (which is interpreted as a decimal point) and optionally beginning with a hyphen (which is interpreted as a negative sign). - - + + - "Point( _longitude_ _latitude_ _altitude_ _measure_)", where _longitude_, _latitude_, _altitude_, and _measure_ are strings of one or more numerals, optionally including one period (which is interpreted as a decimal point) and optionally beginning with a hyphen (which is interpreted as a negative sign). - - + + - _latitude_ is the latitude and must be between -90.0 and 90.0. - - + + - _longitude_ is the longitude and must be between -180.0 and 180.0. - - + + - _altitude_ is the altitude. - - + + - _measure_ is an alternate designation of the point. See the **Measure** property later in this section for more information. - - + + #### Methods **ToString** - - - + + + This override returns one of the following, depending on whether the **Altitude** or **Measure** properties have been assigned a non-null value. - - - + + + - If neither Altitude nor Measure have been assigned a non-null value: - + "Point( _longitude_ _latitude_)", where _longitude_ and _latitude_ are strings of one or more numerals, optionally including one period (which is interpreted as a decimal point) and optionally beginning with a hyphen (which is interpreted as a negative sign). - - + + - Otherwise (at least one of **Altitude** or **Measure** have been assigned a non-null value): - + "Point(longitude latitude altitude measure)", where _longitude_, _latitude_, _altitude_, and _measure_ are strings of one or more numerals, optionally including one period (which is interpreted as a decimal point) and optionally beginning with a hyphen (which is interpreted as a negative sign). If either **Altitude** or **Measure** has not been assigned a non-null value, it is reported as "0" in the value of the **WellKnownText** property. The converse does not hold: if either **Altitude** or **Measure** is reported as 0, that might be because it was never assigned a non-null value, but it might be because it was assigned 0. - - -```cs + + +```csharp public override string ToString() ``` **ToWellKnownText** - - - + + + Wraps **ToString**. - - - -```cs + + + +```csharp public string ToWellKnownText() ``` @@ -1097,70 +1093,70 @@ public string ToWellKnownText() #### Properties **Altitude** - - - + + + Gets or sets the altitude of the location. Use of this property is optional and the assumed unit-of-measure (for example, meters) and zero-point (for example, sea level or center-of-the-earth) is user-defined. - - - -```cs + + + +```csharp public double Altitude ``` **Latitude** - - - + + + Gets or sets the latitude of the location. - - - -```cs + + + +```csharp public double Latitude ``` The value must be between -90.0 and 90.0. - - - + + + **Longitude** - - - + + + Gets or sets the longitude of the location. - - - -```cs + + + +```csharp public double Longitude ``` The value must be between -180.0 and 180.0.. - - - + + + **Measure** - - - + + + Gets or sets a user-defined alternate designation of the location point. For example, if the point is along a highway with milestone markers, this property could be used to hold the number of the milestone that is nearest to the point. If the point is in a public camping area with numbered campsites, this property could be used to hold the number of the nearest campsite. The semantics of the property are entirely user-determined and its use is optional. - - - -```cs + + + +```csharp public double Measure ``` @@ -1168,11 +1164,11 @@ public double Measure ### SPFieldType enum A new value has been added to this enum: - - - -```cs + + + +```csharp Geolocation ``` @@ -1180,11 +1176,11 @@ Geolocation ### SPPhoneNotificationContent class A base class for classes that represent the content of a phone notification. Derived classes must declare one or more fields or properties to hold the content and must implement the **PreparePayload** method to transform the content into a byte array. - - - -```cs + + + +```csharp public abstract class SPPhoneNotificationContent ``` @@ -1192,17 +1188,17 @@ public abstract class SPPhoneNotificationContent #### Methods **PreparePayload** - - - + + + When implemented in a derived class, transforms the content into a Byte array that is sent over the wire to the notification service. There is no default implementation so a derived class must implement this method. - - - -```cs + + + +```csharp protected internal abstract byte[] PreparePayload(); ``` @@ -1210,54 +1206,54 @@ protected internal abstract byte[] PreparePayload(); #### Properties **NotificationType** (read-only) - - - + + + Gets the type of notification (for example, tile or toast) for which the content is intended. - - - -```cs + + + +```csharp public SPPhoneNotificationType NotificationType ``` For information about the **SPPhoneNotificationType**, see later in this document. - - - + + + **SubscriberType** (read-only) - - - + + + Gets the type of the subscriber's device, for example, a Windows Phone. - - - -```cs + + + +```csharp public SPPhoneNotificationSubscriberType SubscriberType ``` For information about the **SPPhoneNotificationSubscriberType**, see later in this document. - - - + + + ### SPPhoneNotificationResponse class Represents the outcome of an attempt to send a notification. - - - -```cs + + + +```csharp public class SPPhoneNotificationResponse ``` @@ -1265,124 +1261,124 @@ public class SPPhoneNotificationResponse #### Methods **Create** - - - + + + Creates an **SPPhoneNotificationResponse** object. - - - -```cs + + + +```csharp public static SPPhoneNotificationResponse -Create(SPPhoneNotificationSubscriberType subscriberType, +Create(SPPhoneNotificationSubscriberType subscriberType, SPPhoneNotificationType notificationType, HttpWebResponse response) ``` **Parameters** - - - + + + - _subscriberType_ is the device, such as Windows Phone 7.5. - - + + - _notificationType_ is the type of notification, such as toast or tile. - - + + - _response_ is the HTTP response object that was generated by the server. - - + + For more information about **SPPhoneNotificationSubscriberType** and **SPPhoneNotificationType**, see later in this document. - - - + + + #### Properties **NotificationType** (read-only) - - - + + + Gets the type of notification (for example, toast or tile). - - - -```cs + + + +```csharp public SPPhoneNotificationType NotificationType ``` For information about the SPPhoneNotificationType, see later in this document. - - - + + + **ServiceToken** (read-only) - - - + + + Gets the token of the notification service that was used in the notification. - - - -```cs + + + +```csharp public string ServiceToken ``` **StatusCode** (read-only) - - - + + + Gets the HTTP status code. A string version of a **HttpStatusCode** value. - - - -```cs + + + +```csharp public string StatusCode ``` **SubscriberType** - - - + + + Gets or sets the type of device to which the notification was sent. - - - -```cs + + + +```csharp public SPPhoneNotificationSubscriberType SubscriberType ``` For information about the **SPPhoneNotificationSubscriberType**, see later in this document. - - - + + + **TimeStamp** (read-only) - - - + + + The UTC time of the notification. - - - -```cs + + + +```csharp public DateTime Timestamp ``` @@ -1390,11 +1386,11 @@ public DateTime Timestamp ### SPPhoneNotificationSubscriber class A base class for classes that represent a subscriber to notifications issued by a server-side SharePoint application. - - - -```cs + + + +```csharp public abstract class SPPhoneNotificationSubscriber ``` @@ -1402,109 +1398,109 @@ public abstract class SPPhoneNotificationSubscriber #### Methods Notify - - - + + + Sends the specified notification content to the subscriber with error checking. - - - -```cs + + + +```csharp public SPPhoneNotificationResponse Notify(SPPhoneNotificationContent notificationContent) ``` **Parameters** - - - + + + _notificationContent_ is information about the event that triggered the notification. - - - + + + This method cannot be overridden. It wraps the abstract **NotifyInternal** method and ensures that certain error checking is done when **NotifyInternal** is called. - - - + + + For more information about the **SPPhoneNotificationContent** and **SPPhoneNotificationResponse** classes, see earlier in this document. - - - + + + **NotifyInternal** - - - + + + When overridden in a derived class, sends the specified notification content to the subscriber. - - - -```cs + + + +```csharp protected abstract SPPhoneNotificationResponse NotifyInternal(SPPhoneNotificationContent notificationContent); ``` **Parameters** - - - + + + _notificationContent_ is information about the event that triggered the notification. - - - + + + For more information about the **SPPhoneNotificationContent** and **SPPhoneNotificationResponse** classes, see earlier in this document. - - - + + + **ToString** - - - + + + Returns selected properties of the object as a string. - - - -```cs + + + +```csharp public override string ToString() ``` The default implementation includes the **ParentWeb**, **ApplicationTag**, and **DeviceAppInstanceId** properties. - - - + + + Update - - - + + + Saves a (possibly changed) **SPPhoneNotificationSubscriber** object to the website's Subscriber Store. - - - -```cs + + + +```csharp public void Update() ``` **ValidateSubscriberProperties** - - - + + + When implemented in a derived class, validates selected properties of the object. - - - -```cs + + + +```csharp protected abstract void ValidateSubscriberProperties(); ``` @@ -1512,111 +1508,111 @@ protected abstract void ValidateSubscriberProperties(); #### Properties **CustomArgs** - - - + + + Gets or sets a custom arguments string which represents the state of the notifications subscription. This string could be used by the application logic to differentiate between its notification subscribers for different kinds of notifications. - - - -```cs + + + +```csharp public string CustomArgs ``` **DeviceAppInstanceId** (read-only) - - - + + + Gets an ID for the specific instance of the application on the phone or other mobile device. - - - -```cs + + + +```csharp public Guid DeviceAppInstanceId ``` **LastModifiedTimeStamp** (read-only) - - - + + + Gets the date and time when the subscriber was last modified. - - - -```cs + + + +```csharp public DateTime LastModifiedTimeStamp ``` **RegistrationTimeStamp** (read-only) - - - + + + Gets the date and time when the subscriber registered for notifications. - - - -```cs + + + +```csharp public DateTime RegistrationTimeStamp ``` **ServiceToken** - - - + + + Gets or sets delivery channel information that is needed by a notification service, such as channel URI. - - - -```cs + + + +```csharp public string ServiceToken ``` **SubscriberType** (read-only) - - - + + + Gets the type of the device, such as Windows Phone 7. - - - -```cs + + + +```csharp public SPPhoneNotificationSubscriberType SubscriberType ``` For information about the **SPPhoneNotificationSubscriberType** class, see later in this document. - - - + + + **User** (read-only) - - - + + + Gets the user who registered for notifications. - - - -```cs + + + +```csharp public SPUser User ``` @@ -1624,11 +1620,11 @@ public SPUser User ### SPPhoneNotificationSubscriberCollection class A collection of notification subscribers. The collection object takes **Int32** indexers. - - - -```cs + + + +```csharp public sealed class SPPhoneNotificationSubscriberCollection : SPBaseCollection ``` @@ -1636,17 +1632,17 @@ public sealed class SPPhoneNotificationSubscriberCollection : SPBaseCollection #### Properties **Count** - - - + + + Gets the number of items in the collection. - - - -```cs + + + +```csharp public override int Count ``` @@ -1654,9 +1650,9 @@ public override int Count ### SPPhoneNotificationSubscriberType enum Specifies a type of device that can receive notifications. - - - + + + |**Notification**|**Device**| @@ -1664,213 +1660,207 @@ Specifies a type of device that can receive notifications. ||| |**WP7**
    |Windows Phone 7.5
    | |**Custom**
    |Any device other than Windows Phone 7.5
    | - + ### SPPhoneNotificationType enum Specifies the type of notification. - - - +-None +-Tile +-Toast +-Raw -||| -|:-----|:-----| -|**None**
    || -|**Tile**
    || -|**Toast**
    || -|**Raw**
    || - ### SPWeb class The following members have been added to this class. - - - + + + #### Methods **DoesPhoneNotificationSubscriberExist** - - - + + + Gets a value that indicates whether the current user is a subscriber for the specified instance of the specified app. - - - -```cs + + + +```csharp public bool DoesPhoneNotificationSubscriberExist(Guid deviceAppInstanceId) ``` **GetPhoneNotificationSubscriber** - - - + + + Gets a notification subscriber with the specified application and phone IDs from the website's notification Subscription Store list. - - - -```cs + + + +```csharp public SPPhoneNotificationSubscriber GetPhoneNotificationSubscriber(Guid deviceAppInstanceId) ``` **Parameters** - - - + + + _deviceAppInstanceId_ is an ID for the instance of the application on a specific phone or device. - - - + + + For information about the **SPPhoneNotificationSubscriber** class see earlier in this document. - - - + + + **GetPhoneNotificationSubscribers** (overloaded) - - - + + + Gets a collection of notification subscribers from the website's notification Subscription Store list, optionally filtering on the ID of the phone applications and possibly also on one of the following: the user or some custom arguments. - - - -```cs + + + +```csharp public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string customArgs) ``` > [!NOTE] -> Client object model name is **GetPhoneNotificationSubscribersByArgs**. - - - +> Client object model name is **GetPhoneNotificationSubscribersByArgs**. -```cs + + + +```csharp public SPPhoneNotificationSubscriberCollection GetPhoneNotificationSubscribers(string user) ``` > [!NOTE] -> Client object model name is **GetPhoneNotificationSubscribersByUser**. - - - +> Client object model name is **GetPhoneNotificationSubscribersByUser**. + + + **Parameters** - - - + + + - _customArgs_ are additional custom information that some notification-enabled applications may use. - - + + - _user_ is the user who registered for the notifications. - - + + For information about the **SPPhoneNotificationSubscriberCollection** class see earlier in this document. - - - + + + **RegisterPhoneNotificationSubscriber** - - - + + + Registers a phone app on a phone to receive notifications. - - - -```cs + + + +```csharp public SPPhoneNotificationSubscriber RegisterPhoneNotificationSubscriber(SPPhoneNotificationSubscriberType subscriberType, Guid deviceAppInstanceId, string serviceToken) ``` **Parameters** - - - + + + - _subscriberType_ is the device type, such as Windows Phone 7. - - + + - _deviceAppInstanceId_ is an ID for the instance of the app on a specific phone or device. - - + + - _serviceToken_ is the token that is used by the notification service that sends notifications to the subscriber. - - + + For information about **SPPhoneNotificationSubscriberType**, see earlier in this document. - - - + + + **UnregisterPhoneNotificationSubscriber** - - - + + + Unregisters a phone app on a phone from receiving notifications. - - - -```cs + + + +```csharp public void UnregisterPhoneNotificationSubscriber(Guid deviceAppInstanceId) ``` **Parameters** - - - + + + _deviceAppInstanceId_ is an ID for the instance of the app on a specific phone or device. - - - + + + #### Properties **PhoneNotificationSubscribers** (read-only) - - - + + + Gets a collection of all the phone notification subscribers in the website's Subscriber Store. - - - -```cs + + + +```csharp public SPPhoneNotificationSubscriberCollection PhoneNotificationSubscribers ``` For information about the **SPPhoneNotificationSubscriberCollection** class, see earlier in this document. - - - + + + ### WP7NotificationTileContent class Represents the content of a tile notification. - - - -```cs + + + +```csharp public sealed class WP7NotificationTileContent : SPPhoneNotificationContent ``` @@ -1878,11 +1868,11 @@ public sealed class WP7NotificationTileContent : SPPhoneNotificationContent #### Constructors Initializes a new instance of the WP7NotificationTileContent class. - - - -```cs + + + +```csharp public WP7NotificationTileContent() ``` @@ -1890,17 +1880,17 @@ public WP7NotificationTileContent() #### Methods **PreparePayload** - - - + + + Transforms the content into a **Byte** array that is sent over the wire to the notification service. - - - -```cs + + + +```csharp protected internal override byte[] PreparePayload(); ``` @@ -1908,111 +1898,111 @@ protected internal override byte[] PreparePayload(); #### Properties **Count** - - - + + + Gets or sets the count of the notification. Must be from -1 to 99 inclusive. - - - -```cs + + + +```csharp public int Count ``` Setting the property to -1 will not change the count over the tile. - - - + + + **Title** - - - + + + Gets or sets the title of the tile notification. - - - -```cs + + + +```csharp public string Title ``` **BackgroundImagePath** - - - + + + Gets or sets the path to the tile's background image. - - - -```cs + + + +```csharp public string BackgroundImagePath ``` **BackBackgroundImagePath** - - - + + + Gets or sets the background image of the back side of a flipping tile. - - - -```cs + + + +```csharp public string BackBackgroundImagePath ``` **BackContent** - - - + + + Gets or sets the content of the back side of a flipping tile. - - - -```cs + + + +```csharp public string BackContent ``` **BackTitle** - - - + + + Gets or sets of the title that appears on the back side of a flipping tile. - - - -```cs + + + +```csharp public string BackTitle ``` **TileId** - - - + + + Gets or sets the ID of the tile. - - - -```cs + + + +```csharp public string TileId ``` @@ -2020,11 +2010,11 @@ public string TileId ### WP7NotificationToastContent class Represents the content of a toast notification. - - - -```cs + + + +```csharp public sealed class WP7NotificationToastContent : SPPhoneNotificationContent ``` @@ -2032,11 +2022,11 @@ public sealed class WP7NotificationToastContent : SPPhoneNotificationContent #### Constructors Initializes a new instance of the WP7NotificationToastContent class. - - - -```cs + + + +```csharp public WP7NotificationToastContent() ``` @@ -2044,17 +2034,17 @@ public WP7NotificationToastContent() #### Methods **PreparePayload** - - - + + + Transforms the content into a **Byte** array that is sent over the wire to the notification service. - - - -```cs + + + +```csharp protected internal override byte[] PreparePayload(); ``` @@ -2062,63 +2052,63 @@ protected internal override byte[] PreparePayload(); #### Properties **Message** - - - + + + Gets or sets the message of the toast notification. - - - -```cs + + + +```csharp public string Message ``` **Title** - - - + + + Gets or sets the title of the toast notification. - - - -```cs + + + +```csharp public string Title ``` **Param** - - - + + + Gets or sets custom settings data that is passed to the receiving application if the user responds to the toast notification. - - - -```cs + + + +```csharp public string Param ``` This property can be used to pass information to the receiving application such as a URL or a set of name-value pairs. - - - + + + ### WP7NotificationRawContent class Represents the content of a raw notification. - - - -```cs + + + +```csharp public sealed class WP7NotificationRawContent : SPPhoneNotificationContent ``` @@ -2126,11 +2116,11 @@ public sealed class WP7NotificationRawContent : SPPhoneNotificationContent #### Constructors Initializes a new instance of the WP7NotificationRawContent class. - - - -```cs + + + +```csharp public WP7NotificationRawContent() ``` @@ -2138,17 +2128,17 @@ public WP7NotificationRawContent() #### Methods **PreparePayload** - - - + + + Transforms the content into a Byte array that is sent over the wire to the notification service. - - - -```cs + + + +```csharp protected internal override byte[] PreparePayload(); ``` @@ -2156,17 +2146,17 @@ protected internal override byte[] PreparePayload(); #### Properties **Message** - - - + + + Gets or sets the message of the raw notification. - - - -```cs + + + +```csharp public string Message ``` @@ -2174,85 +2164,85 @@ public string Message ### WP7PhoneNotificationResponse class Represents the outcome of an attempt to send a notification to a Windows Phone 7 subscriber. - - - -```cs + + + +```csharp public WP7PhoneNotificationResponse(SPPhoneNotificationType notificationType, HttpWebResponse response) ``` **Parameters** - - - + + + - _notificationType_ is the type of notification, such as toast or tile. - - + + - _response_ is the HTTP response object that was generated by the server. - - + + For more information about **SPPhoneNotificationType**, see earlier in this document. - - - + + + #### Properties **NotificationStatus** (read-only) - - - + + + Gets the notification status, for example, success or failure. - - - -```cs + + + +```csharp public string NotificationStatus ``` **DeviceConnectionStatus** (read-only) - - - + + + Gets the status of the device at the time of the notification. - - - -```cs + + + +```csharp public string DeviceConnectionStatus ``` **SubscriptionStatus** (read-only) - - - + + + The subscription status of the device at the time of the notification. - - - -```cs + + + +```csharp public string SubscriptionStatus ``` **MessageId** (read-only) - - - + + + Gets the ID of the message that was sent in the notification. - - - + + + @@ -2266,15 +2256,15 @@ public string MessageId - [Build Windows Phone apps that access SharePoint](build-windows-phone-apps-that-access-sharepoint.md) - - + + - [How to: Configure and use push notifications in SharePoint apps for Windows Phone](how-to-configure-and-use-push-notifications-in-sharepoint-apps-for-windows.md) - - + + - [Integrating location and map functionality in SharePoint](integrating-location-and-map-functionality-in-sharepoint.md) - - + + - [Overview of the SharePoint mobile client authentication object model](overview-of-the-sharepoint-mobile-client-authentication-object-model.md) - - + + diff --git a/docs/general-development/overview-of-the-sharepoint-page-model.md b/docs/general-development/overview-of-the-sharepoint-page-model.md index dc592529b..c6f5ece3b 100644 --- a/docs/general-development/overview-of-the-sharepoint-page-model.md +++ b/docs/general-development/overview-of-the-sharepoint-page-model.md @@ -1,9 +1,9 @@ --- title: Overview of the SharePoint page model -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides an overview of the revised SharePoint page model, including master pages, page layouts, and pages. +ms.date: 06/13/2022 ms.assetid: 808b1af3-89ab-4f02-89cc-ea86cb1f9a6e -localization_priority: Priority +ms.localizationpriority: high --- @@ -49,7 +49,7 @@ SharePoint uses templates to define and render the pages that a site displays. T -![Master page, page layout, and page](../images/101_page_model_overview.gif) +![Diagram that shows the master page defining the page layout, which then defines the page.](../images/101_page_model_overview.gif) @@ -290,7 +290,7 @@ The rendered page is what site visitors see. When a page is requested by the bro -![Master page, page layout, and page](../images/112_master_plus_layout_plus_page.gif) +![Diagram that shows the master page merged with the page layout, which then defines the page.](../images/112_master_plus_layout_plus_page.gif) diff --git a/docs/general-development/overview-of-windows-phone-sharepoint-application-templates-in-visual-studio.md b/docs/general-development/overview-of-windows-phone-sharepoint-application-templates-in-visual-studio.md index 3c2e97fb3..d2842c1ce 100644 --- a/docs/general-development/overview-of-windows-phone-sharepoint-application-templates-in-visual-studio.md +++ b/docs/general-development/overview-of-windows-phone-sharepoint-application-templates-in-visual-studio.md @@ -1,9 +1,9 @@ --- title: Overview of Windows Phone SharePoint application templates in Visual Studio -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Provides an overview of the Visual Studio templates installed by the Windows Phone SharePoint Software Development Kit for mobile app development. +ms.date: 06/13/2022 ms.assetid: 6ae27957-fa41-4e6f-92e3-db11dae1f6c2 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -159,7 +159,7 @@ For the details of the steps involved in creating a Windows Phone app by using t - [Microsoft SharePoint SDK for Windows Phone 8](https://www.microsoft.com/download/details.aspx?id=36818) -- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=27570) +- [Windows Phone SDK 7.1](https://www.microsoft.com/download/details.aspx?id=29233) - [Microsoft SharePoint SDK for Windows Phone 7.1](https://www.microsoft.com/download/details.aspx?id=30476) diff --git a/docs/general-development/pagination-for-large-result-sets.md b/docs/general-development/pagination-for-large-result-sets.md index a5fa8235a..0b65afce7 100644 --- a/docs/general-development/pagination-for-large-result-sets.md +++ b/docs/general-development/pagination-for-large-result-sets.md @@ -1,8 +1,8 @@ --- title: Pagination for large result sets +description: If you have a large number of search results (for example, over 50,000) to page through in a query, it is recommended to use the approach explained in this article instead of the approach of StartRow. ms.date: 10/14/2020 -ms.prod: sharepoint -localization_priority: Priority +ms.localizationpriority: high --- # Pagination for large result sets @@ -54,3 +54,18 @@ GET http://{site_url}/_api/search/query?querytext='sharepoint indexdocid>20'& ``` And so on for the rest of the pages. + +To use the same approach in CSOM, see the following example: +```csharp +... +if (startRow == 0) // When issueing the query for first time, we don't have a DocId value yet + keywordQuery.QueryText = "sharepoint"; +else // Putting the IndexDocId first and then the 'actual' query matters (in this case searching for the keyword 'sharepoint') + keywordQuery.QueryText = string.Format("IndexDocId>{0} AND (sharepoint)", startRow); +keywordQuery.EnableSorting = true; +keywordQuery.SortList.Add("[DocId]", Microsoft.SharePoint.Client.Search.Query.SortDirection.Ascending); +... +``` + +> [!NOTE] +> When using the SortList in search queries, the fieldname being used must be enclosed by brackets (e.g. `[DocId]`). diff --git a/docs/general-development/performancepoint-services-in-sharepoint.md b/docs/general-development/performancepoint-services-in-sharepoint.md index 27627e01e..26f4cd170 100644 --- a/docs/general-development/performancepoint-services-in-sharepoint.md +++ b/docs/general-development/performancepoint-services-in-sharepoint.md @@ -1,12 +1,12 @@ --- title: PerformancePoint Services in SharePoint -ms.date: 09/25/2017 +description: Describes supported development scenarios and the extensibility architecture for PerformancePoint Services in SharePoint. +ms.date: 06/13/2022 keywords: accessing fco definitions in SharePoint,bi in SharePoint using performancepoint services,business intelligence in SharePoint,business intelligence using performancepoint services in SharePoint,create scorecard transforms using performancepoint in SharePoint,custom filter control in SharePoint,custom performancepoint extensions,customize performancepoint in sharepoint,data source creation in SharePoint,dlls used for performancepoint development,extending performancepoint services for sharepoint,fcos in sharepoint performancepoint,filter creation in SharePoint,filters as fcos in pps performancepoint,getting started with performancepoint services,integration of performancepoint services in sharepoint,performancepoint assemblies used in development,performancepoint custom data sources,performancepoint custom filters,performancepoint custom reports,performancepoint custom scorecard transforms,performancepoint development scenarios,performancepoint services development,performancepoint services development scenarios,performancepoint services programming,performancepoint services sdk,pps custom dashboards in SharePoint,pps development,pps programming,pps sdk,report creation in SharePoint,report renderer in SharePoint,SharePoint service application PerformancePoint f1_keywords: - accessing fco definitions in SharePoint,bi in SharePoint using performancepoint services,business intelligence in SharePoint,business intelligence using performancepoint services in SharePoint,create scorecard transforms using performancepoint in SharePoint,custom filter control in SharePoint,custom performancepoint extensions,customize performancepoint in sharepoint,data source creation in SharePoint,dlls used for performancepoint development,extending performancepoint services for sharepoint,fcos in sharepoint performancepoint,filter creation in SharePoint,filters as fcos in pps performancepoint,getting started with performancepoint services,integration of performancepoint services in sharepoint,performancepoint assemblies used in development,performancepoint custom data sources,performancepoint custom filters,performancepoint custom reports,performancepoint custom scorecard transforms,performancepoint development scenarios,performancepoint services development,performancepoint services development scenarios,performancepoint services programming,performancepoint services sdk,pps custom dashboards in SharePoint,pps development,pps programming,pps sdk,report creation in SharePoint,report renderer in SharePoint,SharePoint service application PerformancePoint -ms.prod: sharepoint ms.assetid: fb159708-d6b4-40c1-b5cc-4bb2071a7930 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/powerpoint-automation-services-in-sharepoint.md b/docs/general-development/powerpoint-automation-services-in-sharepoint.md index bf58ca918..32912a9d0 100644 --- a/docs/general-development/powerpoint-automation-services-in-sharepoint.md +++ b/docs/general-development/powerpoint-automation-services-in-sharepoint.md @@ -1,116 +1,116 @@ --- title: PowerPoint Automation Services in SharePoint +description: Learn to use Microsoft PowerPoint Automation Services to do server-side presentation conversions to and from a variety of file formats. ms.date: 09/25/2017 -ms.prod: sharepoint ms.assetid: 168c7dc0-fbdc-41a2-84db-65d211d3d673 -localization_priority: Priority +ms.localizationpriority: high --- # PowerPoint Automation Services in SharePoint -Learn to use Microsoft PowerPoint Automation Services to do server-side presentation conversions to and from a variety of file formats. +Learn to use Microsoft PowerPoint Automation Services to do server-side presentation conversions to and from a variety of file formats. ## Introduction Many businesses, large and small, use their Microsoft SharePoint Server libraries as a repository for Microsoft PowerPoint presentations. These businesses all have their own particular needs for storing, distributing, and updating their presentations. Microsoft PowerPoint Automation Services is a new feature of Microsoft SharePoint that can help enterprises to manage their presentations. It is a shared service that provides unattended, server-side conversion of presentations into other formats. It was designed from the outset to work on servers and can process many presentation files in a reliable and predictable manner. - - - + + + Using PowerPoint Automation Services, you can convert from the PowerPoint binary file format (.ppt) and the PowerPoint Open XML file format (.pptx) to other formats. For example, you may want to upgrade a batch of PowerPoint 97-2003 files to Open XML presentation files. You could also create a custom action in the **Edit** menu to allow users to create a PDF version of presentations on demand. - + > [!NOTE] -> PowerPoint Automation Services takes advantage of facilities of SharePoint and is a feature of it. You must have SharePoint installed to use PowerPoint Automation Services. If you are using SharePoint in a server farm, you must explicitly enable PowerPoint Automation Services. - - - +> PowerPoint Automation Services takes advantage of facilities of SharePoint and is a feature of it. You must have SharePoint installed to use PowerPoint Automation Services. If you are using SharePoint in a server farm, you must explicitly enable PowerPoint Automation Services. + + + ## PowerPoint Automation Services scenarios The following scenarios describe a couple of ways that you can use PowerPoint Automation Services to automate processing presentations on a server: - - - + + + - A large enterprise stores all of their yearly earnings presentations in a single document library on a corporate intranet site. The library contains a large number of presentations that have accumulated over the years. The IT department wants to upgrade all of the presentation files in the PowerPoint 97-2003 binary file format (.ppt) to the Open XML presentation file format (.pptx). The developer who is performing the conversion decides to deploy a solution to the server that will iterate through each of the files in the library, check to see whether the file is in the .ppt format, and convert each .ppt file to the .pptx file format. - - + + - A regional sales department provides custom service estimates to each of their clients. Each salesperson reviews their quotes with clients in a meeting, either in-person or online. After the meeting, the salesperson provides a copy of the quote to the customer in the form of a PDF. The department hires a vendor to create a custom verb in the **Edit** menu for PowerPoint files stored in a document library in their extranet. When the verb is clicked, the server runs a program that converts the PowerPoint file to a PDF located in the same library. - - + + ### Supported source presentation formats The supported source presentation formats for conversion are as follows: - - - + + + - Open XML File Format presentation format (.pptx) - - + + - PowerPoint 97-2003 presentation (.ppt) - - + + ### Supported destination document formats The supported destination document formats include all of the supported source document formats and the following: - - - + + + - .pptx (Open XML File Format presentation format) - - + + - .pdf - - + + - .xps (Open XML Paper Specification) - - + + - .jpg - - + + - .png (Portable Network Graphics Format) - - + + ### Limitations of PowerPoint Automation Services PowerPoint Automation Services does not include capabilities for printing documents. However, it is straightforward to convert PowerPoint presentation files (.ppt and .pptx) to PDF or XPS and spool them to a printer. - - - + + + ## PowerPoint Automation Services API To use PowerPoint Automation Services, you use its programming interface to send a conversion request to the SharePoint server. For each conversion request, you specify which files you want to convert and the output format of the conversion job. For some conversion requests, you can also specify what types of content is converted, including comments, hidden slides, or document properties. - - - -PowerPoint Automation Services uses the asynchronous pattern method for sending and receiving conversion requests. Thus, you can write code that continues to execute after a conversion request has been sent. If you need to provide notification to users after a conversion request has been completed, you can specify a delegate that references a callback method to execute when the operation completes. - + + + +PowerPoint Automation Services uses the asynchronous pattern method for sending and receiving conversion requests. Thus, you can write code that continues to execute after a conversion request has been sent. If you need to provide notification to users after a conversion request has been completed, you can specify a delegate that references a callback method to execute when the operation completes. + > [!NOTE] -> For more information about how to work with the asynchronous design pattern, see the [Asynchronous Programming Overview](https://msdn.microsoft.com/library/ms228963.aspx). - - - +> For more information about how to work with the asynchronous design pattern, see the [Asynchronous Programming Overview](https://msdn.microsoft.com/library/ms228963.aspx). + + + The sections below contain a limited list of the classes that are necessary for sending and receiving a conversion requests. All of these classes are contained in the **Microsoft.Office.Server.PowerPoint.Conversion** namespace. - - - + + + ### Request Base Class -The **Request** class is the most fundamental class within the **Microsoft.Office.Server.PowerPoint.Conversion** namespace. All of the otherrequest types— **PresentationRequest**, **PictureRequest**, **PdfRequest**, and **XpsRequest**—inherit from it. - - - +The **Request** class is the most fundamental class within the **Microsoft.Office.Server.PowerPoint.Conversion** namespace. All of the otherrequest types— **PresentationRequest**, **PictureRequest**, **PdfRequest**, and **XpsRequest**—inherit from it. + + + **Table 1. Request base class members** @@ -119,178 +119,178 @@ The **Request** class is the most fundamental class within the **Microsoft.Offic |:-----|:-----| |**BeginConvert(Microsoft.SharePoint.SPServiceContext, System.AsyncCallback, System.Object)** method
    |Begins the conversion operation. The first parameter, _serviceContext_, specifies the context of the SharePoint site where the file to be converted is located. Use the _callback_ parameter to specify a delegate that references a method to execute once the operation has completed. Use the _state_ parameter if you need to pass any additional information from the calling code to the callback method.
    Returns an [IAsyncResult](https://msdn.microsoft.com/library/System.IAsyncResult.aspx) object.
    | |**EndConvert(IAsyncResult)** method
    |Ends the conversion operation. The _result_ parameter expects the resulting [IAsyncResult](https://msdn.microsoft.com/library/System.IAsyncResult.aspx) object that the corresponding **BeginConvert** conversion request returns. If that request has not been completed when **EndConvert** is called, the calling thread is blocked until the conversion operation is complete.
    Does not return a value.
    | - + ### PresentationRequest class The **PresentationRequest** class, which inherits from the **Request** class, converts a PowerPoint 97-2003 file (.ppt) or Open XML File Format presentation (.pptx) to another presentation file format. In the first scenario mentioned above, you use this class to convert older presentation files in a document library to the Open XML File Format presentation format. - - - + + + The constructor method for the **PresentationRequest** class has three required parameters: - - - + + + - _input_—Takes the file that you want to convert as a [Stream](https://msdn.microsoft.com/library/System.IO.Stream.aspx) object. - - + + - _extension_—A string that specifies the file extension of the file being converted. - - + + - _output_—An [SPFileStream](https://msdn.microsoft.com/library/microsoft.sharepoint.spfilestream.aspx) object that specifies where the output will be stored. - - + + The **PresentationRequest** class has a single overload for its constructor method that adds a _settings_ parameter. The _settings_ parameter accepts a **PresentationSettings** object as an argument. - - - + + + > **Tip:** > When converting the output [Stream](https://msdn.microsoft.com/library/System.IO.Stream.aspx) object back to an [SPFile](https://msdn.microsoft.com/library/microsoft.sharepoint.spfile.aspx) object, check that the extension given to the resulting file matches the extension of the file type that you want (.ppt or .pptx). - - - + + + ### PdfRequest class The **PdfRequest** class, which also inherits from the **Request** class, converts a PowerPoint 97-2003 file (.ppt) or Open XML File Format presentation (.pptx) to a.pdf file. In the second scenario mentioned above, you use this class to convert presentations to PDF files. - - - + + + The constructor method for the **PdfRequest** class also has three required parameters— _input_, _extension_, and _output_—similar to the **PresentationRequest** class. - - - + + + The **PdfRequest** class also has a single overload for its constructor method that adds a _settings_ parameter. The _settings_ parameter accepts a **FixedFormatSettings** object as an argument. - - - + + + > **Tip:** > When converting the output [Stream](https://msdn.microsoft.com/library/System.IO.Stream.aspx) object back to an [SPFile](https://msdn.microsoft.com/library/microsoft.sharepoint.spfile.aspx) object, check that the extension given to the resulting file matches the extension of the file type that you want (.pdf). - - - + + + ### PictureRequest class The **PictureRequest** class, which also inherits from the **Request** class, converts a PowerPoint 97-2003 file (.ppt) or Open XML File Format presentation (.pptx) to a collection of image files in either the.jpg or .png format. - - - + + + The constructor method for the **PictureRequest** class also has four required parameters. The _input_, _extension_, and _output_ parameters are similar to the parameters for the **PresentationRequest** class constructor. The constructor method for the **PictureRequest** class also has a required _format_ parameter, which must be a constant from the **PictureFormat** enumeration. - - - + + + The **PictureRequest** class does not have any overloads for its constructor method. - - - + + + > **Tip:** > The **PictureRequest** class returns a stream that contains a package of image files. When converting the output [Stream](https://msdn.microsoft.com/library/System.IO.Stream.aspx) object back to an [SPFile](https://msdn.microsoft.com/library/microsoft.sharepoint.spfile.aspx) object, check that the extension given to the resulting file is .zip. - - - + + + ## Building a PowerPoint Automation Services application The easiest way to show how to write code that uses PowerPoint Automation Services is to build a console application. You must build and run the console application on the SharePoint Server, not on a client computer. The code to start conversion requests is similar whether the conversion request code is incorporated into a web part, a workflow, or an event handler. By using PowerPoint Automation Services from a console application, the following procedure shows how to use the API without adding the complexities of a web part, an event handler, or a workflow. - + > [!NOTE] -> Because PowerPoint Automation Services is a service of SharePoint, you can use it only in an application that runs directly on a SharePoint Server. You must build the application as a farm solution. You cannot use PowerPoint Automation Services from a sandboxed solution. - - - +> Because PowerPoint Automation Services is a service of SharePoint, you can use it only in an application that runs directly on a SharePoint Server. You must build the application as a farm solution. You cannot use PowerPoint Automation Services from a sandboxed solution. + + + ### To build the application 1. Start Microsoft Visual Studio 2012. - - -2. On the **File** menu, point to **New**, and then choose **Project**. - - + + +2. On the **File** menu, point to **New**, and then choose **Project**. + + 3. In the **New Project** dialog box, under **Installed**, expand **Templates**, expand **Visual C#**, and then chose **Windows**. - - + + 4. In the list of project templates, choose **Console Application**. - - + + 5. Be sure that the project in Visual Studio targets .NET Framework 4. - + > [!NOTE] - > Previous versions of SharePoint Server required that you target .NET Framework 3.5. The Microsoft.SharePoint libraries now reference assemblies in .NET Framework 4. Also make sure that your project targets the full .NET Framework 4 and not the .NET Framework 4 Client Profile. + > Previous versions of SharePoint Server required that you target .NET Framework 3.5. The Microsoft.SharePoint libraries now reference assemblies in .NET Framework 4. Also make sure that your project targets the full .NET Framework 4 and not the .NET Framework 4 Client Profile. 6. In the **Name** box, type the name that you want to use for your project, such as PAS_Sample. - - + + 7. In the **Location** box, type the location where you want to place the project. - - + + 8. Click **OK** to create the solution. - - + + 9. By default, Visual Studio 2012 creates projects that target x86 CPUs, but to build SharePoint Server applications, you must target any CPU. - + If you are building a Microsoft Visual C# application, in **Solution Explorer**, right-click the project, and then click **Properties**. - + - In the project **Properties** window, click **Build**. - - + + - Point to the **Configuration** list, and select **All Configurations**. - - + + - Point to the **Platform Target** list, and select **Any CPU**. - - - - + + + + If you are building a Microsoft Visual Basic .NET Framework application, in the **Properties** window, click **Compile**. - + - Click **Advanced Compile Options**. - - + + - Point to the **Configuration** list, and then select **All Configurations**. - - + + - Point to the **Platform Target** list, and then click **Any CPU**. - - - - - + + + + + 10. On the **Project** menu, click **Add Reference** to open the **Add Reference** dialog box. - - + + 11. Expand **Assemblies**, and then do the following: - + - Expand **Framework**, and then add a reference to System.Web. - - + + - Expand **Extensions**, and then add a reference to Microsoft.SharePoint. - - -12. Also in the **Add Reference** dialog box, choose **Browse**, navigate to the location for the Microsoft.Office.Server.PowerPoint.dll (default location is C:\\Windows\\Microsoft.NET\\assembly\\GAC_MSIL\\Microsoft.Office.Server.PowerPoint\\v4.0_15.0.0.0__71e9bce111e9429c), select the assembly, and then choose **Add**. - - + + +12. Also in the **Add Reference** dialog box, choose **Browse**, navigate to the location for the Microsoft.Office.Server.PowerPoint.dll (default location is C:\\Windows\\Microsoft.NET\\assembly\\GAC_MSIL\\Microsoft.Office.Server.PowerPoint\\v4.0_15.0.0.0__71e9bce111e9429c), select the assembly, and then choose **Add**. + + The following C# and Visual Basic examples show a simple PowerPoint Automation Services application that converts a PowerPoint 97-2003 file (.ppt) in the Shared Documents folder of a SharePoint site to a PowerPoint Open XML file (.pptx) in the same folder. - - - -```cs + + + +```csharp using System; using System.Collections.Generic; @@ -316,11 +316,11 @@ namespace PAS_Sample { Console.WriteLine("Begin conversion"); - // Get a reference to the "Shared Documents" library + // Get a reference to the "Shared Documents" library // and the presentation file to be converted. - SPFolder docs = web.Folders[siteURL + + SPFolder docs = web.Folders[siteURL + "/Shared Documents"]; - SPFile file = docs.Files[siteURL + + SPFile file = docs.Files[siteURL + "/Shared Documents/Pres1.ppt"]; // Convert the file to a stream and create an @@ -335,20 +335,20 @@ namespace PAS_Sample stream); // Send the request synchronously, passing - // in a 'null' value for the callback parameter, + // in a 'null' value for the callback parameter, // and capturing the response in the result object. IAsyncResult result = request.BeginConvert( SPServiceContext.GetContext(site), null, null); - // Use the EndConvert method to get the result. + // Use the EndConvert method to get the result. request.EndConvert(result); // Add the converted file to the document library. SPFile newFile = docs.Files.Add( - "newPres1.pptx", - stream, + "newPres1.pptx", + stream, true); Console.WriteLine("Output: {0}", newFile.Url); @@ -392,7 +392,7 @@ Namespace PAS_Sample Using web As SPWeb = site.OpenWeb() Console.WriteLine("Begin conversion") - ' Get a reference to the "Shared Documents" library + ' Get a reference to the "Shared Documents" library ' and the presentation file to be converted. Dim docs As SPFolder = web.Folders(siteURL + _ "/Shared Documents") @@ -406,18 +406,18 @@ Namespace PAS_Sample ' Create the presentation conversion request. Dim request As New PresentationRequest(fStream, _ - ".ppt", + ".ppt", stream) ' Send the request synchronously, passing - ' in a Nothing value for the callback parameter, + ' in a Nothing value for the callback parameter, ' and capturing the response in the result object. Dim result As IAsyncResult = request.BeginConvert(_ SPServiceContext.GetContext(site), _ Nothing, _ Nothing) - ' Use the EndConvert method to get the result. + ' Use the EndConvert method to get the result. request.EndConvert(result) ' Add the converted file to the document library. @@ -446,42 +446,42 @@ End Namespace 1. Add a PowerPoint document named Pres1.ppt to the Shared Documents folder in the SharePoint site. - - + + 2. Build and run the example. - - + + 3. After waiting one minute for the conversion process to run, navigate to the Shared Documents folder in the SharePoint site, and refresh the page. The document library now contains a new PowerPoint document, Pres1.pptx. - - -PowerPoint Automation Services on SharePoint provides businesses with advanced capabilities for managing their presentation files. This high-performance solution allows scalable, server-side presentation manipulation and generation, as a batch or on-demand. - + + +PowerPoint Automation Services on SharePoint provides businesses with advanced capabilities for managing their presentation files. This high-performance solution allows scalable, server-side presentation manipulation and generation, as a batch or on-demand. + > [!NOTE] > Before you run the example, make sure that PowerPoint Automation Services has been enabled in the SharePoint Central Administration console.
    To verify that PowerPoint Automation Services is enabled, do the following:
    • In the Central Administration console, under **System Settings**, choose **Manage services on server**, and then make sure that the **PowerPoint Conversion Service** is set to **Started**.
    • Also in the Central Administration console, under **Application Management**, choose **Manage service applications**, and then make sure that the **PowerPoint Conversion Service Application** and **PowerPoint Conversion Service Application Proxy** are set to Started.
    - - - + + + ## Conclusion -PowerPoint Automation Services on SharePoint provides businesses with advanced capabilities for managing their presentation files. This high-performance solution allows scalable, server-side presentation manipulation and generation, as a batch or on-demand. - - - +PowerPoint Automation Services on SharePoint provides businesses with advanced capabilities for managing their presentation files. This high-performance solution allows scalable, server-side presentation manipulation and generation, as a batch or on-demand. + + + ## See also - [Developing with SharePoint 2010 Word Automation Services](https://msdn.microsoft.com/library/ff742315.aspx) - - + + - [PowerPoint Developer Center](https://msdn.microsoft.com/office/aa905465) - - + + - [SharePoint Developer Center](https://msdn.microsoft.com/sharepoint/default.aspx) - - + + diff --git a/docs/general-development/prepare-to-set-up-and-configure-a-sharepoint-workflow-development-environment.md b/docs/general-development/prepare-to-set-up-and-configure-a-sharepoint-workflow-development-environment.md index ac4c76f93..4f49f1078 100644 --- a/docs/general-development/prepare-to-set-up-and-configure-a-sharepoint-workflow-development-environment.md +++ b/docs/general-development/prepare-to-set-up-and-configure-a-sharepoint-workflow-development-environment.md @@ -1,10 +1,9 @@ --- title: Prepare to set up and configure a SharePoint workflow development environment description: Learn how to set up a workflow development environment to develop SharePoint workflows as free-standing apps. -ms.date: 12/14/2020 -ms.prod: sharepoint +ms.date: 06/10/2022 ms.assetid: b6a3321f-4131-4a8e-9cb7-7a1b4ab9e26b -localization_priority: Normal +ms.localizationpriority: medium --- # Prepare to set up and configure a SharePoint workflow development environment @@ -39,7 +38,7 @@ Here are the components you need. It is important that you install these items i 1. Install the SharePoint environment - [SharePoint update (KB2767999)](https://support.microsoft.com/kb/2767999) - - Optionally, you can subscribe to an [Office 365 development environment](https://msdn.microsoft.com/library/office/apps/fp179924%28v=office.15%29) + - Optionally, you can subscribe to an [Office 365 development environment](/office/dev/add-ins/overview/set-up-your-dev-environment) 1. Install the Workflow Manager environment @@ -64,8 +63,6 @@ If you have pre-release (that is, "Preview") versions of SharePoint Server, Work The release version of the Visual Studio workflow components and their related updates introduce important changes that enhance performance, scalability, and reliability. Unfortunately, these upgrades require you to update workflow projects that you created using the Preview tools. -To make this process easier, we provide a conversion tool that you can get through CodePlex. The tool is called the [SharePoint Workflow Converter for Visual Studio 2012](http://wfconverter.codeplex.com/). - Here is a summary of changes that require you to update your workflow projects: - Activity references to **Item Guid** are replaced by **Item Id**. This change has important consequences: diff --git a/docs/general-development/programming-models-in-sharepoint.md b/docs/general-development/programming-models-in-sharepoint.md index d90410c97..f1f931203 100644 --- a/docs/general-development/programming-models-in-sharepoint.md +++ b/docs/general-development/programming-models-in-sharepoint.md @@ -1,9 +1,9 @@ --- title: Programming models in SharePoint -ms.date: 04/13/2017 -ms.prod: sharepoint +description: Describes programming models in SharePoint and provides links to related articles about SharePoint development. +ms.date: 06/13/2022 ms.assetid: 061985ec-6129-4e91-991b-a72488ce1d34 -localization_priority: Priority +ms.localizationpriority: high --- diff --git a/docs/general-development/protocol-handler-error-due-to-deprecated-interface-in-sharepoint-2016.md b/docs/general-development/protocol-handler-error-due-to-deprecated-interface-in-sharepoint-2016.md index b2a5ebddc..af0803039 100644 --- a/docs/general-development/protocol-handler-error-due-to-deprecated-interface-in-sharepoint-2016.md +++ b/docs/general-development/protocol-handler-error-due-to-deprecated-interface-in-sharepoint-2016.md @@ -1,9 +1,9 @@ --- title: Protocol handler error due to deprecated interface in SharePoint 2016 -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to resolve the protocol handler error due to a deprecated interface in SharePoint 2016. +ms.date: 06/13/2022 ms.assetid: c80cb77c-89db-4c78-b576-f63d39ca330a -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/publish-sharepoint-sites.md b/docs/general-development/publish-sharepoint-sites.md index 27dc46eb1..a80548f6e 100644 --- a/docs/general-development/publish-sharepoint-sites.md +++ b/docs/general-development/publish-sharepoint-sites.md @@ -1,9 +1,9 @@ --- title: Publish SharePoint sites -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes how to deploy SharePoint site components and content to the current site collection and other site collections. +ms.date: 06/13/2022 ms.assetid: 46b5a79c-962f-4a07-8316-d5005eabd0e0 -localization_priority: Normal +ms.localizationpriority: medium --- diff --git a/docs/general-development/query-refinement-in-sharepoint.md b/docs/general-development/query-refinement-in-sharepoint.md index dcbf8fd6d..b1523a9d4 100644 --- a/docs/general-development/query-refinement-in-sharepoint.md +++ b/docs/general-development/query-refinement-in-sharepoint.md @@ -2,9 +2,8 @@ title: Query Refinement in SharePoint description: Learn how to use SharePoint query refinement features programmatically when you are working with search queries and results. ms.date: 01/27/2021 -ms.prod: sharepoint ms.assetid: ec31782e-1bc5-4dc3-8df7-c29cd5f7f05c -localization_priority: Priority +ms.localizationpriority: high --- # Query Refinement in SharePoint @@ -71,7 +70,7 @@ Refiners = "FileType,Write(discretize=manual/2013-01-01/2013-08-22/2013-09-15/20 The following CSOM example shows how to programmatically request three refiners: **FileType**, **Write**, and **Companies**. **Write** represents the last modified date for the item, and uses the advanced syntax to return fixed-size date/time bins. -```cs +```csharp using (var context = new ClientContext("http:///")) { var query = new KeywordQuery(context) @@ -144,7 +143,7 @@ You can provide one or more refinement filters for a refined query by adding ref The following CSOM example shows how to programmatically perform a refinement, to limit the search results to those of HTML file type only. As mentioned in [Example: Refinement data](#example-refinement-data), refinement data related to this refinement option has **RefinerName** set to _Filetype_ and **RefinementToken** set to _"????68746d6c"_. -```cs +```csharp using (var context = new ClientContext("http:///")) { var query = new KeywordQuery(context) @@ -173,7 +172,7 @@ using (var context = new ClientContext("http:/// The following CSOM example shows how to run a query with a refiner spec to create refinement data which is subsequently used to perform refinement. This example simulates the process of an end user selecting the first refinement option. -```cs +```csharp using (var context = new ClientContext("http:///")) { // Step 1: Run the query with refiner spec to provide refinement data in search result diff --git a/docs/general-development/reference-threads-and-digest-threads-in-sharepoint-server-social-feeds.md b/docs/general-development/reference-threads-and-digest-threads-in-sharepoint-server-social-feeds.md index b0b017ac7..3d0ec6463 100644 --- a/docs/general-development/reference-threads-and-digest-threads-in-sharepoint-server-social-feeds.md +++ b/docs/general-development/reference-threads-and-digest-threads-in-sharepoint-server-social-feeds.md @@ -1,9 +1,9 @@ --- title: Reference threads and digest threads in SharePoint social feeds -ms.date: 09/25/2017 -ms.prod: sharepoint +description: Describes reference threads and digest threads, which may be included in the collection of threads that make up a social feed in SharePoint. +ms.date: 06/13/2022 ms.assetid: 58e68fb2-ba40-4861-912f-355e119a1c41 -localization_priority: Normal +ms.localizationpriority: medium --- @@ -33,7 +33,7 @@ You can identify a reference thread by its [ThreadType](https://msdn.microsoft. **Table 1. Types of reference thread** -|**Reference type**|**Description**| +|Reference type|Description| |:-----|:-----| | [LikeReference](https://msdn.microsoft.com/library/microsoft.sharepoint.client.social.socialthreadtype.aspx) ****
    |A reference to a post that a user likes.
    | | [MentionReference](https://msdn.microsoft.com/library/microsoft.sharepoint.client.social.socialthreadtype.aspx)
    |A reference to a post that mentions a user.
    | diff --git a/docs/general-development/removing-excel-interactive-view-from-a-webpage.md b/docs/general-development/removing-excel-interactive-view-from-a-webpage.md index eb91a1d6f..8bfd6ef18 100644 --- a/docs/general-development/removing-excel-interactive-view-from-a-webpage.md +++ b/docs/general-development/removing-excel-interactive-view-from-a-webpage.md @@ -1,18 +1,18 @@ --- title: Removing Excel Interactive View from a webpage +description: The Excel Interactive View feature has been disabled. If you have inserted an Excel Interactive View into your webpage, you can remove it by removing the ` ]]> ``` - - diff --git a/docs/schema/locales-element-regional-settings.md b/docs/schema/locales-element-regional-settings.md index 275c7cef6..d9de2d0ce 100644 --- a/docs/schema/locales-element-regional-settings.md +++ b/docs/schema/locales-element-regional-settings.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Regional Settings schema api_type: @@ -17,9 +16,9 @@ description: Used in RGNLSTNG.XML to contain the collection of locales defined i # Locales element (Regional Settings) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Used in RGNLSTNG.XML (%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\1033\XML) to contain the collection of locales defined in regional settings. - + ```XML - +- Maximum: 1 +
    diff --git a/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-bdcmetadata-schema.md b/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-bdcmetadata-schema.md index eacd3976f..c24d8726f 100644 --- a/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-bdcmetadata-schema.md +++ b/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-bdcmetadata-schema.md @@ -2,13 +2,12 @@ title: LocalizedDisplayName Element in LocalizedDisplayNames (BDCMetadata Schema) description: Details on the LocalizedDisplayName Element in LocalizedDisplayNames (BDCMetadata Schema) manager: soliver -ms.date: 01/27/2021 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.LocalizedDisplayName -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 93fb80ef-6347-b463-da90-4980d872678e --- @@ -59,29 +58,7 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    LocalizedDisplayNames Element in MetadataObject (BDCMetadata Schema)

    The **LocalizedDisplayNames** element that contains this **LocalizedDisplayName**.

    - - - - - - - +| Element | Description | +| --- | --- | +| [LocalizedDisplayNames Element in MetadataObject (BDCMetadata Schema)](localizeddisplaynames-element-in-metadataobject-bdcmetadata-schema.md) | The **LocalizedDisplayNames** element that contains this **LocalizedDisplayName**. | diff --git a/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-bdcmetadataresource-schema.md b/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-bdcmetadataresource-schema.md index e6225732d..690e49d95 100644 --- a/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-bdcmetadataresource-schema.md +++ b/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-bdcmetadataresource-schema.md @@ -2,11 +2,10 @@ title: LocalizedDisplayName Element in LocalizedDisplayNames (BDCMetadataResource Schema) description: Details on the LocalizedDisplayName Element in LocalizedDisplayNames (BDCMetadataResource Schema) manager: soliver -ms.date: 01/27/2021 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 22df0505-2024-a38d-38ea-6f614758fae6 --- @@ -56,26 +55,6 @@ None. ### Parent elements - --- - - - - - - - - - - -

    Element

    LocalizedDisplayNames Element in MetadataObject (BDCMetadataResource Schema)

    - - - - - - - - +| Element | +| --- | +| [LocalizedDisplayNames Element in MetadataObject (BDCMetadataResource Schema)](localizeddisplaynames-element-in-metadataobject-bdcmetadataresource-schema.md) | diff --git a/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-subscription-schema.md b/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-subscription-schema.md index 7fefddcc9..9e08535f6 100644 --- a/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-subscription-schema.md +++ b/docs/schema/localizeddisplayname-element-in-localizeddisplaynames-subscription-schema.md @@ -2,11 +2,10 @@ title: LocalizedDisplayName Element in LocalizedDisplayNames (Subscription Schema) description: Details on the LocalizedDisplayName Element in LocalizedDisplayNames (Subscription Schema) manager: soliver -ms.date: 01/27/2021 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f6fd7c82-4d2b-12f4-7c42-dd11f48919bf --- @@ -57,29 +56,6 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    LocalizedDisplayNames Element in MetadataObject (Subscription Schema)

    A list of localized display names.

    - - - - - - - - +| Element | Description | +| --- | --- | +| [LocalizedDisplayNames Element in MetadataObject (Subscription Schema)](localizeddisplaynames-element-in-metadataobject-subscription-schema.md) | A list of localized display names. | diff --git a/docs/schema/localizeddisplaynames-element-in-metadataobject-bdcmetadata-schema.md b/docs/schema/localizeddisplaynames-element-in-metadataobject-bdcmetadata-schema.md index 1648100c0..672b29a45 100644 --- a/docs/schema/localizeddisplaynames-element-in-metadataobject-bdcmetadata-schema.md +++ b/docs/schema/localizeddisplaynames-element-in-metadataobject-bdcmetadata-schema.md @@ -7,8 +7,7 @@ ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.LocalizedDisplayNames -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 3202aecf-f98f-20cb-1fdd-f3a054cb24aa --- @@ -50,7 +49,7 @@ None. - [Method Element in Methods (BDCMetadata Schema)](method-element-in-methods-bdcmetadata-schema.md) - [FilterDescriptor Element in FilterDescriptors (BDCMetadata Schema)](filterdescriptor-element-in-filterdescriptors-bdcmetadata-schema.md) - [Parameter Element in Parameters (BDCMetadata Schema)](parameter-element-in-parameters-bdcmetadata-schema.md) -- [TypeDescriptor](https://docs.microsoft.com/dotnet/api/system.componentmodel.typedescriptor) +- [TypeDescriptor](/dotnet/api/system.componentmodel.typedescriptor) - [TypeDescriptor Element (BDCMetadata Schema)](typedescriptor-element-bdcmetadata-schema.md) - [Association Element in MethodInstances (BDCMetadata Schema)](association-element-in-methodinstances-bdcmetadata-schema.md) - [MethodInstance Element in MethodInstances (BDCMetadata Schema)](methodinstance-element-in-methodinstances-bdcmetadata-schema.md) diff --git a/docs/schema/localizeddisplaynames-element-in-metadataobject-bdcmetadataresource-schema.md b/docs/schema/localizeddisplaynames-element-in-metadataobject-bdcmetadataresource-schema.md index 00d43c1d6..e0930d784 100644 --- a/docs/schema/localizeddisplaynames-element-in-metadataobject-bdcmetadataresource-schema.md +++ b/docs/schema/localizeddisplaynames-element-in-metadataobject-bdcmetadataresource-schema.md @@ -5,8 +5,7 @@ manager: soliver ms.date: 01/27/2021 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4d5bd20d-b6c3-d4bc-3141-33612e341aeb --- diff --git a/docs/schema/localizeddisplaynames-element-in-metadataobject-subscription-schema.md b/docs/schema/localizeddisplaynames-element-in-metadataobject-subscription-schema.md index a1779b634..e4b596767 100644 --- a/docs/schema/localizeddisplaynames-element-in-metadataobject-subscription-schema.md +++ b/docs/schema/localizeddisplaynames-element-in-metadataobject-subscription-schema.md @@ -5,8 +5,7 @@ manager: soliver ms.date: 01/27/2021 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: edb3742e-054c-f683-7033-b15b31d836bf --- diff --git a/docs/schema/locstringid-element-sps15xsdsearchset6.md b/docs/schema/locstringid-element-sps15xsdsearchset6.md index dd95df729..a1825a7d3 100644 --- a/docs/schema/locstringid-element-sps15xsdsearchset6.md +++ b/docs/schema/locstringid-element-sps15xsdsearchset6.md @@ -1,27 +1,25 @@ --- title: "LocStringId element (SPS15XSDSearchSet6)" +description: Outlines information, a definition, and elements and attributes for the LocStringId element (SPS15XSDSearchSet6) in Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 3e7ec5eb-164a-e7f7-9b24-59c176914b4d -description: "Last modified: March 09, 2015" --- # LocStringId element (SPS15XSDSearchSet6) **Applies to:** SharePoint Server 2013 - -## Element information -||| +## Element information +|Name|Value| |:-----|:-----| -|**Element type**
    |tns:LocStringId
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.xsd
    | - +|**Element type** |tns:LocStringId | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search | +|**Schema file** |schema_Microsoft.Office.Server.Search.xsd | + ## Definition ```XML @@ -31,18 +29,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/locstringid-simpletype-sps15xsdsearchset6.md b/docs/schema/locstringid-simpletype-sps15xsdsearchset6.md index d6b6a5abf..b6f98a32b 100644 --- a/docs/schema/locstringid-simpletype-sps15xsdsearchset6.md +++ b/docs/schema/locstringid-simpletype-sps15xsdsearchset6.md @@ -1,27 +1,25 @@ --- title: "LocStringId simpleType (SPS15XSDSearchSet6)" +description: Outlines information, a definition, and enumeration values for the LocStringId simpleType (SPS15XSDSearchSet6) in Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 16b5dcb6-d4cb-5b74-28d6-a58732b7d2b6 -description: "Last modified: March 09, 2015" --- # LocStringId simpleType (SPS15XSDSearchSet6) **Applies to:** SharePoint Server 2013 - -## Type information -||| +## Type information +|Name|Value| |:-----|:-----| -|**Base type**
    |xs:string
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.xsd
    | - +|**Base type** |xs:string | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search | +|**Schema file** |schema_Microsoft.Office.Server.Search.xsd | + ## Definition ```XML @@ -106,5 +104,3 @@ description: "Last modified: March 09, 2015" |Type_PowerPoint
    || |Type_VideoFile
    || |Type_Task
    || - - diff --git a/docs/schema/lookupcolumn-element-view.md b/docs/schema/lookupcolumn-element-view.md index 8e8a04406..1aa481c0f 100644 --- a/docs/schema/lookupcolumn-element-view.md +++ b/docs/schema/lookupcolumn-element-view.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: @@ -17,12 +16,12 @@ description: Functions similarly to the Column element but only valid when refer # LookupColumn element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Functions similarly to the [Column](column-element-view.md) element but only valid when referring to a **Lookup** field. The only distinction between the **Column** and **LookupColumn** elements for **Lookup** fields is that **LookupColumn** retrieves the raw value of the column from the foreign list, while **Column** retrieves the raw value of the column in the local list. - + +Functions similarly to the [Column](column-element-view.md) element but only valid when referring to a **Lookup** field. The only distinction between the **Column** and **LookupColumn** elements for **Lookup** fields is that **LookupColumn** retrieves the raw value of the column from the foreign list, while **Column** retrieves the raw value of the column in the local list. + ```XML |Optional **Boolean**. **TRUE** to remove white space from the beginning and end of the value returned by the element.
    | |**URLEncode**
    |Optional **Boolean**. **TRUE** to convert special characters, such as spaces, to quoted UTF-8 format, for example, `%c3%ab` for character `ë`.
    | |**URLEncodeAsURL**
    |Optional **Boolean**. Like **URLEncode**, but **TRUE** to specify that the string to encode is a path component of a URL and not to encode the forward slash (`/`).
    | - + ### Child elements None - + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded (1 within [Expr1](expr1-element-view.md), [Expr2](expr2-element-view.md), and [UrlBaseName](urlbasename-element-view.md)) - +- Maximum: Unbounded (1 within [Expr1](expr1-element-view.md), [Expr2](expr2-element-view.md), and [UrlBaseName](urlbasename-element-view.md)) + ### Remarks -In the case of a **Lookup** field called LookupTitle that points to the title of item 1 in an announcements list, `` would render "Get Started with SharePoint Foundation!", while `` would render "1". +In the case of a **Lookup** field called LookupTitle that points to the title of item 1 in an announcements list, `` would render "Get Started with SharePoint Foundation!", while `` would render "1". + +Consequently, in most situations involving **Lookup** fields, use the **LookupColumn** element instead of the [Column](column-element-view.md) element. The only time to use the **Column** element is when you need a raw reference to the ID of the item in the target list, perhaps for constructing your own link to the target item. -Consequently, in most situations involving **Lookup** fields, use the **LookupColumn** element instead of the [Column](column-element-view.md) element. The only time to use the **Column** element is when you need a raw reference to the ID of the item in the target list, perhaps for constructing your own link to the target item. - ## Example -The following example uses the **LookupColumn** element to return a value that is used in creating a complete URL for a page on the server. - +The following example uses the **LookupColumn** element to return a value that is used in creating a complete URL for a page on the server. + ```XML @@ -80,4 +79,3 @@ The following example uses the **LookupColumn** element to return a value that i ## See also - [Column element (View)](column-element-view.md) - diff --git a/docs/schema/lookupitem-element-deploymentlookuplistmap.md b/docs/schema/lookupitem-element-deploymentlookuplistmap.md index e10a997a1..2a3e10841 100644 --- a/docs/schema/lookupitem-element-deploymentlookuplistmap.md +++ b/docs/schema/lookupitem-element-deploymentlookuplistmap.md @@ -1,29 +1,28 @@ --- title: "LookupItem Element (DeploymentLookupListMap)" +description: Outlines a definition, type, and elements and attributes for the LookupItem element in Microsoft Sharepoint. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c0e4af3f-673d-42ba-a456-d925b346f5a4 -description: "Last modified: March 09, 2015" --- # LookupItem Element (DeploymentLookupListMap) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a reference object (**SPLookupItem**) that holds references from list item to list item when the items are exported to a content migration package. ## Definition ```XML DECLARATION - USAGE @@ -40,7 +39,7 @@ USAGE ## Type **SPLookupItem** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -53,16 +52,15 @@ The following sections describe attributes, child elements, and parent elements. |**DocId**
    |[Guid Simple Type (DeploymentLookupListMap)](guid-simple-type-deploymentlookuplistmap.md)
    |Unique identifier of the document represented by the list item.
    | |**Url**
    |xs:string
    |URL to the list item.
    | |**Included**
    |xs:boolean
    |Specifies whether the list item is included with the export package; **true** if the item is included, otherwise, **false**.
    | - + ### Child elements None - + ### Parent elements [LookupItems Element (DeploymentLookupListMap)](lookupitems-element-deploymentlookuplistmap.md) - + ## See also - [DeploymentLookupListMap Schema](deploymentlookuplistmap-schema.md) - diff --git a/docs/schema/lookupitems-element-deploymentlookuplistmap.md b/docs/schema/lookupitems-element-deploymentlookuplistmap.md index 4e3ccf755..ff4e32038 100644 --- a/docs/schema/lookupitems-element-deploymentlookuplistmap.md +++ b/docs/schema/lookupitems-element-deploymentlookuplistmap.md @@ -1,28 +1,27 @@ --- title: "LookupItems Element (DeploymentLookupListMap)" +description: Outlines a definition, type, attributes, child elements, and parent elements for the LookupItems element in Sharepoint. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d9c835b9-7008-4431-a819-c354f042d817 -description: "Last modified: March 09, 2015" --- # LookupItems Element (DeploymentLookupListMap) - + **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a collection of lookup item (**SPLookupItem**) instances. Provides a list of lookup references from list item to list item. ## Definition ```XML DECLARATION - USAGE @@ -36,7 +35,7 @@ USAGE ## Type **SPLookupItems** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -44,20 +43,19 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [LookupItem Element (DeploymentLookupListMap)](lookupitem-element-deploymentlookuplistmap.md) - + ### Parent elements [LookupList Element (DeploymentLookupListMap)](lookuplist-element-deploymentlookuplistmap.md) - + ### Remarks For more information, see [LookupItem Element (DeploymentLookupListMap)](lookupitem-element-deploymentlookuplistmap.md) - + ## See also - [DeploymentLookupListMap Schema](deploymentlookuplistmap-schema.md) - diff --git a/docs/schema/lookuplist-element-deploymentlookuplistmap.md b/docs/schema/lookuplist-element-deploymentlookuplistmap.md index 87e493dc2..f5b77c87a 100644 --- a/docs/schema/lookuplist-element-deploymentlookuplistmap.md +++ b/docs/schema/lookuplist-element-deploymentlookuplistmap.md @@ -1,29 +1,28 @@ --- title: "LookupList Element (DeploymentLookupListMap)" +description: Outlines a definition, type, attributes, child elements, and parent elements for the LookupList element in Sharepoint. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8f3366bd-8238-433f-bb41-88adbee251df -description: "Last modified: March 09, 2015" --- # LookupList Element (DeploymentLookupListMap) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents an instance of a lookup list (**SPLookupList**) object for export to a content migration package. ## Definition ```XML DECLARATION - USAGE @@ -40,7 +39,7 @@ USAGE ## Type **SPLookupList** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -52,16 +51,15 @@ The following sections describe attributes, child elements, and parent elements. |**Id**
    |[Guid Simple Type (DeploymentLookupListMap)](guid-simple-type-deploymentlookuplistmap.md)
    |Optional. Unique identifier of the lookup list.
    | |**Url**
    |xs:string
    |Optional. URL to the lookup list.
    | |**Included**
    |xs:boolean
    |Optional. Specifies whether the list item is included with the export package; **true** if the list item is included, otherwise **false**.
    | - + ### Child elements [LookupItems Element (DeploymentLookupListMap)](lookupitems-element-deploymentlookuplistmap.md) - + ### Parent elements [LookupLists Element (DeploymentLookupListMap)](lookuplists-element-deploymentlookuplistmap.md) - + ## See also - [DeploymentLookupListMap Schema](deploymentlookuplistmap-schema.md) - diff --git a/docs/schema/lookuplists-element-deploymentlookuplistmap.md b/docs/schema/lookuplists-element-deploymentlookuplistmap.md index e8ecb416a..ec0170e91 100644 --- a/docs/schema/lookuplists-element-deploymentlookuplistmap.md +++ b/docs/schema/lookuplists-element-deploymentlookuplistmap.md @@ -1,19 +1,18 @@ --- title: "LookupLists Element (DeploymentLookupListMap)" +description: Outlines the LookupLists element in Sharepoint, which represents a collection of deployment lookup list objects exported to the content migration package. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ecee28f0-0d23-46c2-bf69-ebb356d7f322 -description: "Last modified: March 09, 2015" --- # LookupLists Element (DeploymentLookupListMap) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a collection of deployment lookup list (**SPLookupList**) objects exported to the content migration package. ## Definition @@ -32,7 +31,7 @@ USAGE ## Type **SPLookupLists** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -40,20 +39,19 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [LookupList Element (DeploymentLookupListMap)](lookuplist-element-deploymentlookuplistmap.md) - + ### Parent elements None - + ### Remarks -The **LookupLists** element is the root element in the **DeploymentLookupListMap** schema, and therefore has no parent element. - +The **LookupLists** element is the root element in the **DeploymentLookupListMap** schema, and therefore has no parent element. + ## See also - [DeploymentLookupListMap Schema](deploymentlookuplistmap-schema.md) - diff --git a/docs/schema/lt-element-query.md b/docs/schema/lt-element-query.md index cb3f63244..03346df2f 100644 --- a/docs/schema/lt-element-query.md +++ b/docs/schema/lt-element-query.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Query schema api_type: @@ -17,9 +16,9 @@ description: In CAML, arithmetic operator that means "less than" and is used in # Lt element (Query) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Arithmetic operator that means "less than" and is used in queries in views. This element is used similarly to the [Eq](eq-element-query.md) and [Gt](gt-element-query.md) elements. - + +Arithmetic operator that means "less than" and is used in queries in views. This element is used similarly to the [Eq](eq-element-query.md) and [Gt](gt-element-query.md) elements. + ```XML @@ -35,32 +34,32 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [FieldRef](fieldref-element-query.md) - [Value](value-element-query.md) - [XML](xml-element.md) - + ### Parent elements - [And](and-element-query.md) - [Or](or-element-query.md) - [Where](where-element-query.md) - + ### Occurrences - Minimum: 0 - Maximum: Unbounded - + ### Remarks -Remember that Collaborative Application Markup Language (CAML) is case-sensitive; note the lowercase "t" in the **Lt** element name. - +Remember that Collaborative Application Markup Language (CAML) is case-sensitive; note the lowercase "t" in the **Lt** element name. + ## Example The following example queries for cases where the Deadline field value either equals an empty string or is less than the current date. - + ```XML @@ -84,8 +83,7 @@ The following example queries for cases where the Deadline field value either eq ## See also -- [Eq element (Query)](eq-element-query.md) -- [Geq element (Query)](geq-element-query.md) -- [Gt element (Query)](gt-element-query.md) +- [Eq element (Query)](eq-element-query.md) +- [Geq element (Query)](geq-element-query.md) +- [Gt element (Query)](gt-element-query.md) - [Neq element (Query)](neq-element-query.md) - diff --git a/docs/schema/major-caml-files.md b/docs/schema/major-caml-files.md index 901b139f3..9bee19b3e 100644 --- a/docs/schema/major-caml-files.md +++ b/docs/schema/major-caml-files.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f2332dea-1113-424e-b245-9785c09ed3cc description: The major schema files that use Collaborative Application Markup Language (CAML) schemas for data definition or HTML rendering, and their locations. --- @@ -13,16 +12,16 @@ description: The major schema files that use Collaborative Application Markup La # Major CAML files **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Many critical files in Microsoft SharePoint Foundation use [Collaborative Application Markup Language (CAML) schemas](collaborative-application-markup-language-caml-schemas.md) to define how data is displayed and how HTML is rendered. - + +Many critical files in Microsoft SharePoint Foundation use [Collaborative Application Markup Language (CAML) schemas](collaborative-application-markup-language-caml-schemas.md) to define how data is displayed and how HTML is rendered. + ## CAML files -The following table describes the major schema files that use CAML schemas for data definition or HTML rendering, and specifies their locations under %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\. - +The following table describes the major schema files that use CAML schemas for data definition or HTML rendering, and specifies their locations under %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\. + > [!CAUTION] -> With the exception of `DocIcon.xml`, Microsoft does not support modifying any of the built-in files that are installed with SharePoint Foundation. In most cases, you can supplement or override the effects of these files with files of your own. For details about modifying the effect of any specific file, see the SDK's documentation of the extensibility area to which the file belongs. - +> With the exception of `DocIcon.xml`, Microsoft does not support modifying any of the built-in files that are installed with SharePoint Foundation. In most cases, you can supplement or override the effects of these files with files of your own. For details about modifying the effect of any specific file, see the SDK's documentation of the extensibility area to which the file belongs. + |**File name**|**Location**|**Description**| |:-----|:-----|:-----| |DocIcon.xml
    |\TEMPLATE\XML
    |Specifies the icons that represent specific types of documents in document libraries. For more information, see [DocIcon.xml](https://msdn.microsoft.com/library/ef6acad0-0a1a-457c-bc9b-ff1e368e59fb%28Office.15%29.aspx).
    | @@ -37,10 +36,9 @@ The following table describes the major schema files that use CAML schemas for d |FldTypes.xml
    |\TEMPLATE\XML
    |Used during site or list creation to define how field types are rendered in the different modes for viewing list data. For more information, see [FldTypes.xml](https://msdn.microsoft.com/library/8f8db866-03f8-4001-aae3-4c4102a7aed6%28Office.15%29.aspx).
    | |RGNLSTNG.XML
    |\TEMPLATE\LCID\XML folder, where LCID is the numeric ID of the language/culture
    |Specifies the regional settings for currency, language, locale, and time zone.
    | |htmltransinfo.xml
    |\TEMPLATE\XML
    |Contains mapping instructions for directing a request to the URL for handling a request when the client computer does not have Microsoft Office installed.
    | - + ## See also - [How to: Create a Custom Site Definition and Configuration](https://msdn.microsoft.com/library/62b0552d-b7a7-4856-b906-c7bcb3155792%28Office.15%29.aspx) -- [Working with Site Templates and Definitions](https://msdn.microsoft.com/library/1edf6d4d-eddb-4cb5-9034-ed394e8a3e01%28Office.15%29.aspx) +- [Working with Site Templates and Definitions](https://msdn.microsoft.com/library/1edf6d4d-eddb-4cb5-9034-ed394e8a3e01%28Office.15%29.aspx) - [Working with Features](https://msdn.microsoft.com/library/ce5f5ce5-1429-439e-9261-2c4ba9788cc1%28Office.15%29.aspx) - diff --git a/docs/schema/manageddatatype-element-sps15xsdsearchset2.md b/docs/schema/manageddatatype-element-sps15xsdsearchset2.md index 3ef05c019..dc41b1ece 100644 --- a/docs/schema/manageddatatype-element-sps15xsdsearchset2.md +++ b/docs/schema/manageddatatype-element-sps15xsdsearchset2.md @@ -1,27 +1,25 @@ --- title: "ManagedDataType element (SPS15XSDSearchSet2)" +description: Outlines information, a definition, and elements and attributes for the ManagedDataType element in Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a7ed1865-1281-a5ee-485d-40ae30db6555 -description: "Last modified: March 09, 2015" --- # ManagedDataType element (SPS15XSDSearchSet2) - - -## Element information -||| + +## Element information +|Name|Value| |:-----|:-----| -|**Element type**
    |tns:ManagedDataType
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |tns:ManagedDataType | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +29,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/manageddatatype-simpletype-sps15xsdsearchset2.md b/docs/schema/manageddatatype-simpletype-sps15xsdsearchset2.md index 4703e343c..790bfc5f5 100644 --- a/docs/schema/manageddatatype-simpletype-sps15xsdsearchset2.md +++ b/docs/schema/manageddatatype-simpletype-sps15xsdsearchset2.md @@ -1,27 +1,25 @@ --- title: "ManagedDataType simpleType (SPS15XSDSearchSet2)" +description: Outlines information, a definition, and enumeration values for the ManagedDataType simpleType in Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b5080a9d-a72e-57ec-efd6-18f8ea0e184e -description: "Last modified: March 09, 2015" --- # ManagedDataType simpleType (SPS15XSDSearchSet2) - - -## Type information -||| + +## Type information +|Name|Value| |:-----|:-----| -|**Base type**
    |xs:string
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Base type** |xs:string | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -52,5 +50,3 @@ description: "Last modified: March 09, 2015" |YesNo
    || |Binary
    || |Double
    || - - diff --git a/docs/schema/managedpid-element-aliasinfo-complextypesps15xsdsearchset2.md b/docs/schema/managedpid-element-aliasinfo-complextypesps15xsdsearchset2.md index eb0f10104..876dc0309 100644 --- a/docs/schema/managedpid-element-aliasinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/managedpid-element-aliasinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,25 @@ --- title: "ManagedPid element (AliasInfo complexType) (SPS15XSDSearchSet2)" +description: Outlines information, a definition, and elements and attributes for the ManagedPid element in Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: acd0628d-189c-4497-2418-08aa0620116c -description: "Last modified: March 09, 2015" --- # ManagedPid element (AliasInfo complexType) (SPS15XSDSearchSet2) - - -## Element information -||| + +## Element information +|Name|Value| |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |xs:int | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +29,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/managedpid-element-mappinginfo-complextypesps15xsdsearchset2.md b/docs/schema/managedpid-element-mappinginfo-complextypesps15xsdsearchset2.md index f7de6e320..fa6170993 100644 --- a/docs/schema/managedpid-element-mappinginfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/managedpid-element-mappinginfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,25 @@ --- title: "ManagedPid element (MappingInfo complexType) (SPS15XSDSearchSet2)" +description: Outlines information, a definition, and elements and attributes for the ManagedPid element (MappingInfo complexType) in Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 623900e6-2a18-1339-cb15-c9e2368bdd3f -description: "Last modified: March 09, 2015" --- # ManagedPid element (MappingInfo complexType) (SPS15XSDSearchSet2) - - -## Element information -||| + +## Element information +|Name|Value| |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |xs:int | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +29,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/managedpid-element-overrideinfo-complextypesps15xsdsearchset2.md b/docs/schema/managedpid-element-overrideinfo-complextypesps15xsdsearchset2.md index f287425c8..00d918d6e 100644 --- a/docs/schema/managedpid-element-overrideinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/managedpid-element-overrideinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,25 @@ --- title: "ManagedPid element (OverrideInfo complexType) (SPS15XSDSearchSet2)" +description: Outlines information, a definition, and elements and attributes for the ManagedPid element (OverrideInfo complexType) in Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 15087fdd-e237-0ba7-268a-90e3f7b733cc -description: "Last modified: March 09, 2015" --- # ManagedPid element (OverrideInfo complexType) (SPS15XSDSearchSet2) - - -## Element information -||| + +## Element information +|Name|Value| |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |xs:int | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +29,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/managedproperties-element-searchschemaconfigurationsettings-complextypesps15xsds.md b/docs/schema/managedproperties-element-searchschemaconfigurationsettings-complextypesps15xsds.md index fdcfaf0b3..d5ccad186 100644 --- a/docs/schema/managedproperties-element-searchschemaconfigurationsettings-complextypesps15xsds.md +++ b/docs/schema/managedproperties-element-searchschemaconfigurationsettings-complextypesps15xsds.md @@ -1,27 +1,25 @@ --- title: "ManagedProperties element (SearchSchemaConfigurationSettings complexType) (SPS15XSDSearchSet3)" +description: Outlines information, a definition, and elements and attributes for the ManagedProperties element in Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ac423b14-7d05-29cf-c458-a7f820aa6863 -description: "Last modified: March 09, 2015" --- # ManagedProperties element (SearchSchemaConfigurationSettings complexType) (SPS15XSDSearchSet3) - - -## Element information -||| + +## Element information +|Name|Value| |:-----|:-----| -|**Element type**
    |q11:ManagedPropertyInfoCollection
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type** |q11:ManagedPropertyInfoCollection | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | + ## Definition ```XML @@ -31,18 +29,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/managedpropertyinfo-complextype-sps15xsdsearchset2.md b/docs/schema/managedpropertyinfo-complextype-sps15xsdsearchset2.md index 888c6dee5..4a22a148e 100644 --- a/docs/schema/managedpropertyinfo-complextype-sps15xsdsearchset2.md +++ b/docs/schema/managedpropertyinfo-complextype-sps15xsdsearchset2.md @@ -1,27 +1,25 @@ --- title: "ManagedPropertyInfo complexType (SPS15XSDSearchSet2)" +description: Outlines information, a definition, and elements and attributes for the ManagedPropertyInfo complexType in Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8c4106a9-2ca6-a114-94a2-2d3ac56f654c -description: "Last modified: March 09, 2015" --- # ManagedPropertyInfo complexType (SPS15XSDSearchSet2) - - -## Type information -||| + +## Type information +|Name|Value| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |tns:BaseInfo
    | - +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | +|**Extension base** |tns:BaseInfo | + ## Definition ```XML @@ -65,8 +63,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -98,9 +96,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[SortableType](sortabletype-element-managedpropertyinfo-complextypesps15xsdsearchset2.md)
    |tns:SortableType
    || |[TokenNormalization](tokennormalization-element-managedpropertyinfo-complextypesps15xsdsearchset2.md)
    |xs:boolean
    || |[UpdateGroup](updategroup-element-managedpropertyinfo-complextypesps15xsdsearchset2.md)
    |xs:string
    || - + ### Attributes None. - - diff --git a/docs/schema/managedpropertyinfo-element-arrayofmanagedpropertyinfo-complextypesps15xsdsearch.md b/docs/schema/managedpropertyinfo-element-arrayofmanagedpropertyinfo-complextypesps15xsdsearch.md index e8103d3af..a404048ca 100644 --- a/docs/schema/managedpropertyinfo-element-arrayofmanagedpropertyinfo-complextypesps15xsdsearch.md +++ b/docs/schema/managedpropertyinfo-element-arrayofmanagedpropertyinfo-complextypesps15xsdsearch.md @@ -1,27 +1,25 @@ --- title: "ManagedPropertyInfo element (ArrayOfManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" +description: Outlines information, a definition, and elements and attributes for the ManagedPropertyInfo element (ArrayOfManagedPropertyInfo complexType). manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 18da2e4e-c878-481d-7a49-50f936a954a3 -description: "Last modified: March 09, 2015" --- # ManagedPropertyInfo element (ArrayOfManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - -## Element information -||| + +## Element information +|Name|Value| |:-----|:-----| -|**Element type**
    |tns:ManagedPropertyInfo
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |tns:ManagedPropertyInfo | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +29,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/managedpropertyinfo-element-sps15xsdsearchset2.md b/docs/schema/managedpropertyinfo-element-sps15xsdsearchset2.md index 27233d21e..ee10365c6 100644 --- a/docs/schema/managedpropertyinfo-element-sps15xsdsearchset2.md +++ b/docs/schema/managedpropertyinfo-element-sps15xsdsearchset2.md @@ -1,27 +1,25 @@ --- title: "ManagedPropertyInfo element (SPS15XSDSearchSet2)" +description: Outlines information, a definition, and elements and attributes for the ManagedPropertyInfo element (SPS15XSDSearchSet2). manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: e95dc863-3e98-6952-6480-b6d924e56bc7 -description: "Last modified: March 09, 2015" --- # ManagedPropertyInfo element (SPS15XSDSearchSet2) - - -## Element information -||| + +## Element information +|Name|Value| |:-----|:-----| -|**Element type**
    |tns:ManagedPropertyInfo
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |tns:ManagedPropertyInfo | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +29,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/managedpropertyinfocollection-complextype-sps15xsdsearchset2.md b/docs/schema/managedpropertyinfocollection-complextype-sps15xsdsearchset2.md index c053253ae..4a4754fb7 100644 --- a/docs/schema/managedpropertyinfocollection-complextype-sps15xsdsearchset2.md +++ b/docs/schema/managedpropertyinfocollection-complextype-sps15xsdsearchset2.md @@ -1,27 +1,25 @@ --- title: "ManagedPropertyInfoCollection complexType (SPS15XSDSearchSet2)" +description: Outlines information, a definition, and elements and attributes for the ManagedPropertyInfoCollection complexType in Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 91d12373-cd92-1425-53ae-205466821c1b -description: "Last modified: March 09, 2015" --- # ManagedPropertyInfoCollection complexType (SPS15XSDSearchSet2) - - -## Type information -||| + +## Type information +|Name|Value| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |tns:BaseInfoCollectionOfManagedPropertyInfoTzWWwPjw
    | - +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | +|**Extension base** |tns:BaseInfoCollectionOfManagedPropertyInfoTzWWwPjw | + ## Definition ```XML @@ -39,16 +37,14 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| |:-----|:-----|:-----| |[TotalCount](totalcount-element-managedpropertyinfocollection-complextypesps15xsdsearchset2.md)
    |xs:int
    || - + ### Attributes None. - - diff --git a/docs/schema/managedpropertyinfocollection-element-sps15xsdsearchset2.md b/docs/schema/managedpropertyinfocollection-element-sps15xsdsearchset2.md index f04176cf4..87389caad 100644 --- a/docs/schema/managedpropertyinfocollection-element-sps15xsdsearchset2.md +++ b/docs/schema/managedpropertyinfocollection-element-sps15xsdsearchset2.md @@ -1,27 +1,25 @@ --- title: "ManagedPropertyInfoCollection element (SPS15XSDSearchSet2)" +description: Outlines information, a definition, and elements and attributes for the ManagedPropertyInfoCollection element in Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 85d36645-c879-833f-1276-b8130153cb3a -description: "Last modified: March 09, 2015" --- # ManagedPropertyInfoCollection element (SPS15XSDSearchSet2) - - -## Element information -||| + +## Element information +|Name|Value| |:-----|:-----| -|**Element type**
    |tns:ManagedPropertyInfoCollection
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |tns:ManagedPropertyInfoCollection | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +29,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/managedtype-element-managedpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/managedtype-element-managedpropertyinfo-complextypesps15xsdsearchset2.md index 01311af2e..755e0b7e0 100644 --- a/docs/schema/managedtype-element-managedpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/managedtype-element-managedpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,25 @@ --- title: "ManagedType element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" +description: Outlines information, a definition, and elements and attributes for the ManagedType element (ManagedPropertyInfo complexType) Sharepoint. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8388c95c-6012-8e3f-bb8d-4df78d70a689 -description: "Last modified: March 09, 2015" --- # ManagedType element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - -## Element information -||| + +## Element information +|Name|Value| |:-----|:-----| -|**Element type**
    |tns:ManagedDataType
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |tns:ManagedDataType | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +29,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/manifestfile-element-deploymentsystemdata.md b/docs/schema/manifestfile-element-deploymentsystemdata.md index 7541e3dcf..fe17c09ba 100644 --- a/docs/schema/manifestfile-element-deploymentsystemdata.md +++ b/docs/schema/manifestfile-element-deploymentsystemdata.md @@ -1,29 +1,28 @@ --- title: "ManifestFile element (DeploymentSystemData)" +description: Outlines a definition, type, attributes, child elements, and parent elements for the ManifestFile element in Sharepoint. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 37164e6f-d94d-451c-80c1-5558bd4889ca -description: "Last modified: March 09, 2015" --- # ManifestFile element (DeploymentSystemData) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a system data file (SystemData.xml) exported to the content migration package. ## Definition ```XML DECLARATION - USAGE @@ -37,7 +36,7 @@ USAGE ## Type **SPManifestFile** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -47,16 +46,15 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Type**|**Description**| |:-----|:-----|:-----| |**Name**
    |xs:string
    |Optional. Name of the SystemData.xml file.
    | - + ### Child elements None - + ### Parent elements - [ManifestFiles element (DeploymentSystemData)](manifestfiles-element-deploymentsystemdata.md) - + ## See also - [DeploymentSystemData Schema](deploymentsystemdata-schema.md) - diff --git a/docs/schema/manifestfiles-element-deploymentsystemdata.md b/docs/schema/manifestfiles-element-deploymentsystemdata.md index b23ea835f..6c2354cca 100644 --- a/docs/schema/manifestfiles-element-deploymentsystemdata.md +++ b/docs/schema/manifestfiles-element-deploymentsystemdata.md @@ -1,29 +1,28 @@ --- title: "ManifestFiles element (DeploymentSystemData)" +description: "ManifestFiles element (DeploymentSystemData) represents a collection of system data (SystemData.xml) files exported to the content migration package." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b0386913-8ac3-4a6e-a021-e73c9b1b12a7 -description: "Last modified: March 09, 2015" --- # ManifestFiles element (DeploymentSystemData) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a collection of system data (SystemData.xml) files exported to the content migration package. ## Definition ```XML DECLARATION - USAGE @@ -37,7 +36,7 @@ USAGE ## Type **SPManifestFiles** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -45,16 +44,15 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [ManifestFile element (DeploymentSystemData)](manifestfile-element-deploymentsystemdata.md) - + ### Parent elements - [SystemData element (DeploymentSystemData)](systemdata-element-deploymentsystemdata.md) - + ## See also - [DeploymentSystemData Schema](deploymentsystemdata-schema.md) - diff --git a/docs/schema/manifesturi-simpletype-sharepoint-add-in-manifest.md b/docs/schema/manifesturi-simpletype-sharepoint-add-in-manifest.md index b408c2397..20d544af1 100644 --- a/docs/schema/manifesturi-simpletype-sharepoint-add-in-manifest.md +++ b/docs/schema/manifesturi-simpletype-sharepoint-add-in-manifest.md @@ -1,26 +1,26 @@ --- title: ManifestUri simpleType +description: Describes the definition and type information for ManifestUri simpleType. manager: soliver -ms.date: 9/17/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a6861f44-9d24-40f6-efc5-89033c101b4d --- -# ManifestUri simpleType +# ManifestUri simpleType (SharePoint Add-in Manifest) **Applies to**: SharePoint Add-ins | SharePoint Foundation 2013 | SharePoint Server 2013 -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +| Information | Location | |---|---| | **Base type** | xs:anyURI | | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | @@ -29,17 +29,10 @@ ms.assetid: a6861f44-9d24-40f6-efc5-89033c101b4d ## Definition ```XML - + ``` - - - - - - - diff --git a/docs/schema/mapfile-element-feature.md b/docs/schema/mapfile-element-feature.md index 401439daa..fd68cd24b 100644 --- a/docs/schema/mapfile-element-feature.md +++ b/docs/schema/mapfile-element-feature.md @@ -1,11 +1,11 @@ --- title: MapFile element (Feature) +description: Describes the definition, element, and attribute information for MapFile element (Feature), which specifies a mapping between files during a Feature upgrade. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9e5e6eb7-89c7-4fb8-baff-e08cdce7ba18 --- @@ -18,7 +18,7 @@ Specifies a mapping between files during a Feature upgrade. ## Definition ```XML - ``` @@ -82,11 +82,3 @@ None - - - - - - - - diff --git a/docs/schema/mappedcrawledproperties-element-managedpropertyinfo-complextypesps15xsdsearchset.md b/docs/schema/mappedcrawledproperties-element-managedpropertyinfo-complextypesps15xsdsearchset.md index 14779c067..c33dbb49e 100644 --- a/docs/schema/mappedcrawledproperties-element-managedpropertyinfo-complextypesps15xsdsearchset.md +++ b/docs/schema/mappedcrawledproperties-element-managedpropertyinfo-complextypesps15xsdsearchset.md @@ -1,27 +1,26 @@ --- title: "MappedCrawledProperties element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the MappedCrawledProperties element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d7183e4a-fd7a-9316-2ffe-44b042265b34 -description: "Last modified: March 09, 2015" --- # MappedCrawledProperties element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:ArrayOfCrawledPropertyInfo
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:ArrayOfCrawledPropertyInfo| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/mappedmanagedproperties-element-crawledpropertyinfo-complextypesps15xsdsearchset.md b/docs/schema/mappedmanagedproperties-element-crawledpropertyinfo-complextypesps15xsdsearchset.md index 5a9861f1a..a50e99969 100644 --- a/docs/schema/mappedmanagedproperties-element-crawledpropertyinfo-complextypesps15xsdsearchset.md +++ b/docs/schema/mappedmanagedproperties-element-crawledpropertyinfo-complextypesps15xsdsearchset.md @@ -1,27 +1,26 @@ --- title: "MappedManagedProperties element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the MappedManagedProperties element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 407c2966-f706-a276-759f-e57908fd42a1 -description: "Last modified: March 09, 2015" --- # MappedManagedProperties element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:ArrayOfManagedPropertyInfo
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:ArrayOfManagedPropertyInfo| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/mapping-element-document-icons.md b/docs/schema/mapping-element-document-icons.md index 236577a2f..b9296ad7c 100644 --- a/docs/schema/mapping-element-document-icons.md +++ b/docs/schema/mapping-element-document-icons.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Document Icons schema api_type: - schema ms.assetid: 238311d9-6dc4-4864-a3a9-120475f3de20 -description: Used in the DocIcon.xml file to map particular document types to their respective icons. +description: Used in the DocIcon.xml file to map particular document types to their respective icons. --- # Mapping element (Document Icons) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Used in the [DocIcon.xml](https://msdn.microsoft.com/library/ef6acad0-0a1a-457c-bc9b-ff1e368e59fb%28Office.15%29.aspx) file to map particular document types to their respective icons. - + +Used in the [DocIcon.xml](https://msdn.microsoft.com/library/ef6acad0-0a1a-457c-bc9b-ff1e368e59fb%28Office.15%29.aspx) file to map particular document types to their respective icons. + ```XML |Required **Text**. Specifies the image file name and extension. The file must exist in the %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\IMAGES folder.
    | |**EditText**
    |Optional **Text**. Specifies text that displays in drop-down menus as the editing item ("Edit in _Application Name_") for a file that has been uploaded to a list.
    | |**OpenControl**
    |Optional **Text**. Specifies the name of the ActiveX control used to open the type of document.
    | - + ### Child elements None - + ### Parent elements - [ByExtension](byextension-element-document-icons.md) - [ByProgID](byprogid-element-document-icons.md) - + ### Occurrences -- Minimum: 0 -- Maximum: Unbounded - +- Minimum: 0 +- Maximum: Unbounded + ## Example -The following example maps **ProgIDs** and file name extensions as follows: - -- For different values of the **ProgID** `` tag, it maps **ProgIDs** to the icons representing the applications. For example, "Excel.Sheet" maps to ichtmxls.gif. - -- It maps file name extensions to appropriate icons. For example, "docx" maps to icdocx.png. - +The following example maps **ProgIDs** and file name extensions as follows: + +- For different values of the **ProgID** `` tag, it maps **ProgIDs** to the icons representing the applications. For example, "Excel.Sheet" maps to ichtmxls.gif. + +- It maps file name extensions to appropriate icons. For example, "docx" maps to icdocx.png. + - If neither of the above causes a match, it provides a default value, icgen.gif, for the mapping. - + ```XML @@ -83,5 +82,3 @@ The following example maps **ProgIDs** and file name extensions as follows: ``` - - diff --git a/docs/schema/mapping-element-list.md b/docs/schema/mapping-element-list.md index e6352b7b0..fc4fb5c50 100644 --- a/docs/schema/mapping-element-list.md +++ b/docs/schema/mapping-element-list.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: - schema ms.assetid: 2ef8e7b1-8e3f-4a96-b233-2689b6d18fc4 -description: Maps a value to a choice that is displayed in a Choice field. +description: Maps a value to a choice that is displayed in a Choice field. --- # MAPPING element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Maps a value to a choice that is displayed in a **Choice** field. - + +Maps a value to a choice that is displayed in a **Choice** field. + ```XML @@ -35,20 +34,18 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Description**| |:-----|:-----| |**Value**
    |Required **Text**. Specifies the value that is mapped to a choice.
    | - + ### Child elements None - + ### Parent elements - [Mappings](mappings-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - -
    - +- Maximum: Unbounded +
    diff --git a/docs/schema/mapping-element.md b/docs/schema/mapping-element.md index 04015e07b..774dae6ee 100644 --- a/docs/schema/mapping-element.md +++ b/docs/schema/mapping-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b280a03d-dfdc-4d29-98b0-3e4bcb0f8231 description: Used in an HtmlTransInfo.xml file to direct requests to the URL for handling the requests when the client computer does not have the 2007 Microsoft Office system installed. --- @@ -13,9 +12,9 @@ description: Used in an HtmlTransInfo.xml file to direct requests to the URL for # Mapping element **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Used in an HtmlTransInfo.xml file (`\Program Files\Common Files\Microsoft Shared\web server extensions\12TEMPLATE\XML`) to direct requests to the URL for handling the requests when the client computer does not have the 2007 Microsoft Office system installed. - + ```XML |Optional **Text**. Specifies the file name extension for the document type.
    | |**HandlerUrl**
    |Optional **Text**. Specifies the URL of a converter program used by the server to handle a request when the client computer does not have Microsoft Office system installed.
    | |**ProgId**
    |Optional **Text**. Specifies the name of the ActiveX control used to open the type of document.
    | - + ### Child elements None - + ### Parent elements - [HtmlTrInfo](htmltrinfo-element.md) - + ### Occurrences - Minimum: 0 - Maximum: Unbounded - +
    diff --git a/docs/schema/mappingdisallowed-element-managedpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/mappingdisallowed-element-managedpropertyinfo-complextypesps15xsdsearchset2.md index 6ee8fdd3b..7cce5b7f0 100644 --- a/docs/schema/mappingdisallowed-element-managedpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/mappingdisallowed-element-managedpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "MappingDisallowed element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the MappingDisallowed element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6e01be36-43df-92ff-060b-392c02779449 -description: "Last modified: March 09, 2015" --- # MappingDisallowed element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |xs:boolean
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:boolean| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/mappinginfo-complextype-sps15xsdsearchset2.md b/docs/schema/mappinginfo-complextype-sps15xsdsearchset2.md index 0254309c2..f6b276136 100644 --- a/docs/schema/mappinginfo-complextype-sps15xsdsearchset2.md +++ b/docs/schema/mappinginfo-complextype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "MappingInfo complexType (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the MappingInfo complexType (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9f76cdfb-9587-98cc-768f-bc22433c088f -description: "Last modified: March 09, 2015" --- # MappingInfo complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |tns:BaseInfo
    | - +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| +|**Extension base**|tns:BaseInfo| + ## Definition ```XML @@ -43,20 +42,18 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| |:-----|:-----|:-----| -|[CrawledPropertyName](crawledpropertyname-element-mappinginfo-complextypesps15xsdsearchset2.md)
    |xs:string
    || -|[CrawledPropset](crawledpropset-element-mappinginfo-complextypesps15xsdsearchset2.md)
    |ser:guid
    || -|[ManagedPid](managedpid-element-mappinginfo-complextypesps15xsdsearchset2.md)
    |xs:int
    || -|[MappingOrder](mappingorder-element-mappinginfo-complextypesps15xsdsearchset2.md)
    |xs:int
    || -|[SchemaId](schemaid-element-mappinginfo-complextypesps15xsdsearchset2.md)
    |xs:int
    || - +|[CrawledPropertyName](crawledpropertyname-element-mappinginfo-complextypesps15xsdsearchset2.md)|xs:string|| +|[CrawledPropset](crawledpropset-element-mappinginfo-complextypesps15xsdsearchset2.md)|ser:guid|| +|[ManagedPid](managedpid-element-mappinginfo-complextypesps15xsdsearchset2.md)|xs:int|| +|[MappingOrder](mappingorder-element-mappinginfo-complextypesps15xsdsearchset2.md)|xs:int|| +|[SchemaId](schemaid-element-mappinginfo-complextypesps15xsdsearchset2.md)|xs:int|| + ### Attributes None. - - diff --git a/docs/schema/mappinginfo-element-sps15xsdsearchset2.md b/docs/schema/mappinginfo-element-sps15xsdsearchset2.md index 45d31411f..ae52ab77e 100644 --- a/docs/schema/mappinginfo-element-sps15xsdsearchset2.md +++ b/docs/schema/mappinginfo-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "MappingInfo element (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the MappingInfo element (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 63a42ae4-b372-8070-7f3f-a9914be2fc10 -description: "Last modified: March 09, 2015" --- # MappingInfo element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:MappingInfo
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:MappingInfo| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/mappinginfocollection-complextype-sps15xsdsearchset2.md b/docs/schema/mappinginfocollection-complextype-sps15xsdsearchset2.md index 5fb36acf1..3a852f851 100644 --- a/docs/schema/mappinginfocollection-complextype-sps15xsdsearchset2.md +++ b/docs/schema/mappinginfocollection-complextype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "MappingInfoCollection complexType (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the MappingInfoCollection complexType (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d026c8b0-de60-305c-2e5a-1faf2272d2ea -description: "Last modified: March 09, 2015" --- # MappingInfoCollection complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |tns:BaseInfoCollectionOfMappingInfoTzWWwPjw
    | - +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| +|**Extension base**|tns:BaseInfoCollectionOfMappingInfoTzWWwPjw| + ## Definition ```XML @@ -31,14 +30,12 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/mappinginfocollection-element-sps15xsdsearchset2.md b/docs/schema/mappinginfocollection-element-sps15xsdsearchset2.md index 662a1ab5f..5665da113 100644 --- a/docs/schema/mappinginfocollection-element-sps15xsdsearchset2.md +++ b/docs/schema/mappinginfocollection-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "MappingInfoCollection element (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the MappingInfoCollection element (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2e97bae0-2116-9e10-41fa-fb03d11cdf88 -description: "Last modified: March 09, 2015" --- # MappingInfoCollection element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:MappingInfoCollection
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:MappingInfoCollection| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/mappingorder-element-mappinginfo-complextypesps15xsdsearchset2.md b/docs/schema/mappingorder-element-mappinginfo-complextypesps15xsdsearchset2.md index 5e8199a74..5db46ff12 100644 --- a/docs/schema/mappingorder-element-mappinginfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/mappingorder-element-mappinginfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "MappingOrder element (MappingInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the MappingOrder element (MappingInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7f9c78ab-3f1e-2fa2-89f3-2861338f82e9 -description: "Last modified: March 09, 2015" --- # MappingOrder element (MappingInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:int| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/mappings-element-list.md b/docs/schema/mappings-element-list.md index 3009b35f7..e8ba941ba 100644 --- a/docs/schema/mappings-element-list.md +++ b/docs/schema/mappings-element-list.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: - schema ms.assetid: 9d76858e-04a2-4bf6-92d0-f44dcba11937 -description: Contains mappings of values to the choices displayed within a Choice field. +description: Contains mappings of values to the choices displayed within a Choice field. --- # MAPPINGS element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Contains mappings of values to the choices displayed within a **Choice** field. - + +Contains mappings of values to the choices displayed within a **Choice** field. + ```XML @@ -75,4 +74,3 @@ The following excerpt shows how to implement the **MAPPINGS** element in a **Cho ```
    - diff --git a/docs/schema/mappings-element-searchschemaconfigurationsettings-complextypesps15xsdsearchset3.md b/docs/schema/mappings-element-searchschemaconfigurationsettings-complextypesps15xsdsearchset3.md index 66240c0aa..f6d3e8e0d 100644 --- a/docs/schema/mappings-element-searchschemaconfigurationsettings-complextypesps15xsdsearchset3.md +++ b/docs/schema/mappings-element-searchschemaconfigurationsettings-complextypesps15xsdsearchset3.md @@ -1,27 +1,26 @@ --- title: "Mappings element (SearchSchemaConfigurationSettings complexType) (SPS15XSDSearchSet3)" +description: "Describes the definition, element, and attribute information for the Mappings element (SearchSchemaConfigurationSettings complexType) (SPS15XSDSearchSet3)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1a92776f-cbd5-25bb-3e9a-145be1a81ee7 -description: "Last modified: March 09, 2015" --- # Mappings element (SearchSchemaConfigurationSettings complexType) (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |q12:MappingInfoCollection
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type**|q12:MappingInfoCollection| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability| +|**Schema file**|schema_Microsoft.Office.Server.Search.Portability.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/mappingsoverridden-element-overrideinfo-complextypesps15xsdsearchset2.md b/docs/schema/mappingsoverridden-element-overrideinfo-complextypesps15xsdsearchset2.md index dd79959de..de156b826 100644 --- a/docs/schema/mappingsoverridden-element-overrideinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/mappingsoverridden-element-overrideinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "MappingsOverridden element (OverrideInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the MappingsOverridden element (OverrideInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d7dd276c-48b9-a604-b73a-75344deea0c7 -description: "Last modified: March 09, 2015" --- # MappingsOverridden element (OverrideInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |xs:boolean
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:boolean| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/maptoall-element-view.md b/docs/schema/maptoall-element-view.md index 63f84be79..1a17f8ad0 100644 --- a/docs/schema/maptoall-element-view.md +++ b/docs/schema/maptoall-element-view.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: - schema ms.assetid: 95ac3390-76f6-4de5-9492-8ce8a97f76de -description: Combines the functionality of the MapToIcon, MapToText, and MapToControl elements. +description: Combines the functionality of the MapToIcon, MapToText, and MapToControl elements. --- # MapToAll element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Combines the functionality of the [MapToIcon](maptoicon-element-view.md), [MapToText](maptotext-element.md), and [MapToControl](maptocontrol-element-view.md) elements. - + +Combines the functionality of the [MapToIcon](maptoicon-element-view.md), [MapToText](maptotext-element.md), and [MapToControl](maptocontrol-element-view.md) elements. + ```XML @@ -32,26 +31,26 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -Numerous - +Numerous + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ### Remarks -The **MapToAll** element improves performance by preventing the need to make multiple requests to the server for data. - +The **MapToAll** element improves performance by preventing the need to make multiple requests to the server for data. + Using this element is the same as using the following: - + ```XML ProgID|File_Extension| ProgID|File_Extension| diff --git a/docs/schema/maptocontenttype-element-view.md b/docs/schema/maptocontenttype-element-view.md index 5ac17ef7e..f0b85f4f9 100644 --- a/docs/schema/maptocontenttype-element-view.md +++ b/docs/schema/maptocontenttype-element-view.md @@ -1,23 +1,23 @@ --- title: "MapToContentType element (View)" +description: "Describes the definition, element, and attribute information for the MapToContentType element (View)." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: - schema ms.assetid: ba8f491c-17b7-4d46-acaf-e8f6890cc418 -description: "Last modified: March 09, 2015" --- # MapToContentType element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + +## Definition ```XML ... @@ -31,20 +31,18 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -Numerous - +Numerous + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - -
    - +- Maximum: Unbounded +
    diff --git a/docs/schema/maptocontrol-element-view.md b/docs/schema/maptocontrol-element-view.md index dbd9aa4a1..2824d3079 100644 --- a/docs/schema/maptocontrol-element-view.md +++ b/docs/schema/maptocontrol-element-view.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: @@ -17,9 +16,9 @@ description: Returns the name of the application in which a document can be edit # MapToControl element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Returns the name of the application in which a document can be edited based on the file name extension and **ProgID**. - + ```XML ProgID|File_Extension @@ -33,32 +32,32 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -Numerous - +Numerous + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ### Remarks -The **MapToControl** element uses the following syntax, separating the **ProgID** from the file name extension with a pipe symbol ("|"): - +The **MapToControl** element uses the following syntax, separating the **ProgID** from the file name extension with a pipe symbol ("|"): + ```XML ProgID|File_Extension ``` ## Example -The following example uses the **MapToControl** element to assign the name of the application to an Editor variable. - +The following example uses the **MapToControl** element to assign the name of the application to an Editor variable. + ```XML diff --git a/docs/schema/maptoicon-element-view.md b/docs/schema/maptoicon-element-view.md index 50298f2e2..253c7d4f9 100644 --- a/docs/schema/maptoicon-element-view.md +++ b/docs/schema/maptoicon-element-view.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: @@ -17,9 +16,9 @@ description: Returns the file name of the icon associated with a given file name # MapToIcon element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Returns the file name of the icon associated with a given file name extension and **ProgID**. - + ```XML ProgID|File_Extension @@ -33,41 +32,41 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -Numerous - +Numerous + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 - Maximum: Unbounded - + ### Remarks -The **MapToIcon** element uses the following syntax, separating the **ProgID** from the file name extension with a pipe symbol ("|"): - +The **MapToIcon** element uses the following syntax, separating the **ProgID** from the file name extension with a pipe symbol ("|"): + ```XML ProgID|File_Extension ``` This element can be used in any rendering scenario (for example in a view, or as stand-alone element in a document), but it is most useful in a view of a document library. - + For example, `|xls` renders the Microsoft Excel .gif file defined within the [ByExtension](byextension-element-document-icons.md) element of the [DocIcon.xml](https://msdn.microsoft.com/library/ef6acad0-0a1a-457c-bc9b-ff1e368e59fb%28Office.15%29.aspx) file, and using `Excel.Sheet|htm` renders the Excel .gif file defined in the [ByProgID](byprogid-element-document-icons.md) element of DocIcon.xml, but `CustomApp.Baz|htm` would render the generic HTML icon because the **ProgID**, "CustomApp.Baz," is unknown. - -Note that the set of file name extensions and **ProgIDs** that are supported are extensible by the system administrator. They can be edited in DocIcon.xml, and then the image files can be included in the `\TEMPLATES\1033` directory. After such a modification, Microsoft Internet Information Services (IIS) needs to be restarted. Subsequently, any new websites based on Microsoft SharePoint Foundation will support the new file types and display the correct icons. The number of icons and **ProgIDs** that can be supported is limited only by system resources (memory and disk space). - + +Note that the set of file name extensions and **ProgIDs** that are supported are extensible by the system administrator. They can be edited in DocIcon.xml, and then the image files can be included in the `\TEMPLATES\1033` directory. After such a modification, Microsoft Internet Information Services (IIS) needs to be restarted. Subsequently, any new websites based on Microsoft SharePoint Foundation will support the new file types and display the correct icons. The number of icons and **ProgIDs** that can be supported is limited only by system resources (memory and disk space). + ## Example -The following example creates the linked application icon that appears on the toolbar in the Edit Properties view for a document library item. The example uses the **MapToIcon** element to construct the URL of the icon based on the file extension of the document and the **ProgID** of the application associated with the document. - +The following example creates the linked application icon that appears on the toolbar in the Edit Properties view for a document library item. The example uses the **MapToIcon** element to construct the URL of the icon based on the file extension of the document and the **ProgID** of the application associated with the document. + ```XML @@ -77,7 +76,7 @@ The following example creates the linked application icon that appears on the to - ]]> </HTML> <HTML>Icon</HTML> diff --git a/docs/schema/maptotext-element.md b/docs/schema/maptotext-element.md index 173705f97..a247d4af5 100644 --- a/docs/schema/maptotext-element.md +++ b/docs/schema/maptotext-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 68683b19-b395-4342-b047-3d16e236ccda description: Returns the name of the application in which a document was created, based on the file name extension and ProgID. --- @@ -13,9 +12,9 @@ description: Returns the name of the application in which a document was created # MapToText element **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Returns the name of the application in which a document was created, based on the file name extension and **ProgID**. - + ```XML <MapToText> ProgID|File_Extension @@ -29,32 +28,32 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -Numerous - +Numerous + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ### Remarks -The **MapToText** element uses the following syntax, separating the **ProgID** from the file name extension with a pipe symbol (ProgID|File_Extension ``` ## Example -The following example uses the **MapToText** element to assign the name of the application to an App variable. - +The following example uses the **MapToText** element to assign the name of the application to an App variable. + ```XML diff --git a/docs/schema/matchingoptions-element-sps15xsdsearchset4.md b/docs/schema/matchingoptions-element-sps15xsdsearchset4.md index 22a716aa6..7fa3b3a5a 100644 --- a/docs/schema/matchingoptions-element-sps15xsdsearchset4.md +++ b/docs/schema/matchingoptions-element-sps15xsdsearchset4.md @@ -1,29 +1,28 @@ --- title: "MatchingOptions element (SPS15XSDSearchSet4)" +description: "Describes the definition, element, and attribute information for the MatchingOptions element (SPS15XSDSearchSet4)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 0f2de9bb-2b62-bf25-d103-f49b957e5c76 -description: "Last modified: March 09, 2015" --- # MatchingOptions element (SPS15XSDSearchSet4) - - + + **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:MatchingOptions
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query.Rules
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.Rules.xsd
    | - +|**Element type**|tns:MatchingOptions| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query.Rules| +|**Schema file**|schema_Microsoft.Office.Server.Search.Query.Rules.xsd| + ## Definition ```XML @@ -33,18 +32,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/matchingoptions-simpletype-sps15xsdsearchset4.md b/docs/schema/matchingoptions-simpletype-sps15xsdsearchset4.md index 7dc353f68..19eec7eb4 100644 --- a/docs/schema/matchingoptions-simpletype-sps15xsdsearchset4.md +++ b/docs/schema/matchingoptions-simpletype-sps15xsdsearchset4.md @@ -1,32 +1,29 @@ --- title: "MatchingOptions simpleType (SPS15XSDSearchSet4)" +description: "Describes the definition, element, and attribute information for the MatchingOptions simpleType (SPS15XSDSearchSet4)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: acb4696d-91a4-1637-ea9b-4d1a40c61c55 -description: "Last modified: March 09, 2015" --- # MatchingOptions simpleType (SPS15XSDSearchSet4) **Applies to:** SharePoint Server 2013 - + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Base type**
    || -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query.Rules
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.Rules.xsd
    | - +|**Base type**|| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query.Rules| +|**Schema file**|schema_Microsoft.Office.Server.Search.Query.Rules.xsd| + ## Definition ```XML ``` - - diff --git a/docs/schema/matchtype-element-reorderingrule-complextypesps15xsdsearchset5.md b/docs/schema/matchtype-element-reorderingrule-complextypesps15xsdsearchset5.md index 971983ec1..b63762c06 100644 --- a/docs/schema/matchtype-element-reorderingrule-complextypesps15xsdsearchset5.md +++ b/docs/schema/matchtype-element-reorderingrule-complextypesps15xsdsearchset5.md @@ -1,27 +1,26 @@ --- title: "MatchType element (ReorderingRule complexType) (SPS15XSDSearchSet5)" +description: "Describes the definition, element, and attribute information for the MatchType element (ReorderingRule complexType) (SPS15XSDSearchSet5)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ba9286a7-acf9-af5b-ef78-305bc7e617c7 -description: "Last modified: March 09, 2015" --- # MatchType element (ReorderingRule complexType) (SPS15XSDSearchSet5) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:ReorderingRuleMatchType
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Element type**|tns:ReorderingRuleMatchType| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query| +|**Schema file**|schema_Microsoft.Office.Server.Search.Query.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/matchvalue-element-reorderingrule-complextypesps15xsdsearchset5.md b/docs/schema/matchvalue-element-reorderingrule-complextypesps15xsdsearchset5.md index 91c735232..659477830 100644 --- a/docs/schema/matchvalue-element-reorderingrule-complextypesps15xsdsearchset5.md +++ b/docs/schema/matchvalue-element-reorderingrule-complextypesps15xsdsearchset5.md @@ -1,27 +1,26 @@ --- title: "MatchValue element (ReorderingRule complexType) (SPS15XSDSearchSet5)" +description: "Describes the definition, element, and attribute information for the MatchValue element (ReorderingRule complexType) (SPS15XSDSearchSet5)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: bee7e95b-5fca-c51a-a6c3-69a2b8cbae9a -description: "Last modified: March 09, 2015" --- # MatchValue element (ReorderingRule complexType) (SPS15XSDSearchSet5) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |xs:string
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Element type**|xs:string| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query| +|**Schema file**|schema_Microsoft.Office.Server.Search.Query.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/maximumresponselength-element-source-complextypesps15xsdsearchset1.md b/docs/schema/maximumresponselength-element-source-complextypesps15xsdsearchset1.md index b8940c423..42391219f 100644 --- a/docs/schema/maximumresponselength-element-source-complextypesps15xsdsearchset1.md +++ b/docs/schema/maximumresponselength-element-source-complextypesps15xsdsearchset1.md @@ -1,27 +1,26 @@ --- title: "MaximumResponseLength element (Source complexType) (SPS15XSDSearchSet1)" +description: "Describes the definition, element, and attribute information for the MaximumResponseLength element (Source complexType) (SPS15XSDSearchSet1)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 773546f6-df8e-fa51-70dd-3331e1562984 -description: "Last modified: March 09, 2015" --- # MaximumResponseLength element (Source complexType) (SPS15XSDSearchSet1) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.Query.xsd
    | - +|**Element type**|xs:int| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.Query.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/maxsize-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/maxsize-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index c9bd49b43..bac74ba51 100644 --- a/docs/schema/maxsize-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/maxsize-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,24 +1,24 @@ --- title: MaxSize element (CommandUIDefinitionType complexType) +description: Describes the definition, element, and attribute information for the MaxSize element (CommandUIDefinitionType complexType). manager: soliver -ms.date: 9/16/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5d0fa351-a4f7-c57a-0832-3de3f4306029 --- -# MaxSize element (CommandUIDefinitionType complexType) +# MaxSize element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +|Information|Location| |---|---| | **Element type** | MaxSizeType | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | @@ -59,26 +59,18 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements None. -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/maxsize-element.md b/docs/schema/maxsize-element.md index c4600ca3b..02590fc45 100644 --- a/docs/schema/maxsize-element.md +++ b/docs/schema/maxsize-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Specifies the maximum size for a group of controls. # MaxSize element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies the maximum size for a group of controls. - + ```XML |Required. A string that identifies the element, such as "Ribbon.Library.Scaling.ViewFormat.MaxSize".
    | |**Sequence**
    |Optional. An integer that specifies the order of placement among sibling XML nodes.
    | |**Size**
    |Required. A string that corresponds to the value of the **Title** attribute of a [Layout](layout-element.md) element that defines the size.
    | - + ### Child elements None - + ### Parent elements - [Scaling](scaling-element.md) - + ### Occurrences - Minimum: 0 -- Maximum: unbounded - +- Maximum: unbounded + ## See also - [Server Ribbon XML](https://msdn.microsoft.com/library/5eeb45be-4af7-4a38-8ba0-3aafc62aed4b%28Office.15%29.aspx) - diff --git a/docs/schema/meetingproperty-element-view.md b/docs/schema/meetingproperty-element-view.md index 9feb26caa..60163219a 100644 --- a/docs/schema/meetingproperty-element-view.md +++ b/docs/schema/meetingproperty-element-view.md @@ -1,32 +1,31 @@ --- title: "MeetingProperty element (View)" manager: soliver -ms.date: 3/9/2015 +ms.date: 03/28/2023 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: - schema ms.assetid: 3ec34c23-df03-4678-b1cc-56436911ae76 -description: Represents a property of a list in a Meeting Workspace site. +description: Represents a property of a list in a Meeting Workspace site. --- # MeetingProperty element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a property of a list in a Meeting Workspace site. - + +Represents a property of a list in a Meeting Workspace site. + ```XML |Optional **Boolean**. **TRUE** to surround text with `` tags if the text appears like a hyperlink (for example, `www.microsoft.com`).
    | -|**AutoHyperLinkNoEncoding**
    |Optional **Boolean**. **TRUE** to surround text with `    ` tags if the text appears like a hyperlink (for example, `www.microsoft.com`) but without HTML encoding.
    | -|**AutoNewLine**
    |Optional **Boolean**. **TRUE** to insert `
    ` tags into the text stream and to replace multiple spaces with a nonbreaking space (` `).
    | -|**Default**
    |Optional **Text**. Renders the text assigned to this attribute if the value returned by a selection is an empty string (`""`).
    | -|**ExpandXML**
    |Optional **Boolean**. **TRUE** to re-pass the rendered content through the Collaborative Application Markup Language (CAML) interpreter, which allows CAML to render CAML.
    | -|**HTMLEncode**
    |Optional **Boolean**. **TRUE** to convert embedded characters so that they are displayed as text in the browser. In other words, characters that could be confused with HTML tags are converted to entities.
    | -|**Select**
    |Required **Text**. Specifies the name of the property to select.
    | -|**StripWS**
    |Optional **Boolean**. **TRUE** to remove white space from the beginning and end of the value returned by the element.
    | -|**URLEncode**
    |Optional **Boolean**. **TRUE** to convert special characters, such as spaces, to quoted UTF-8 format (for example, `%c3%ab` for character `ë`).
    | -|**URLEncodeAsURL**
    |Optional **Boolean**. Like **URLEncode**, but **TRUE** to specify that the string to encode is a path component of a URL so that forward slashes (`/`) are not encoded.
    | - +| Attribute | Description | +| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **AutoHyperLink** | Optional **Boolean**. **TRUE** to surround text with `    ` tags if the text appears like a hyperlink (for example, `www.microsoft.com`). | +| **AutoHyperLinkNoEncoding** | Optional **Boolean**. **TRUE** to surround text with `` tags if the text appears like a hyperlink (for example, `www.microsoft.com`) but without HTML encoding. | +| **AutoNewLine** | Optional **Boolean**. **TRUE** to insert `
    ` tags into the text stream and to replace multiple spaces with a nonbreaking space (` `). | +| **Default** | Optional **Text**. Renders the text assigned to this attribute if the value returned by a selection is an empty string (`""`). | +| **ExpandXML** | Optional **Boolean**. **TRUE** to re-pass the rendered content through the Collaborative Application Markup Language (CAML) interpreter, which allows CAML to render CAML. | +| **HTMLEncode** | Optional **Boolean**. **TRUE** to convert embedded characters so that they are displayed as text in the browser. In other words, characters that could be confused with HTML tags are converted to entities. | +| **Select** | Required **Text**. Specifies the name of the property to select. | +| **StripWS** | Optional **Boolean**. **TRUE** to remove white space from the beginning and end of the value returned by the element. | +| **URLEncode** | Optional **Boolean**. **TRUE** to convert special characters, such as spaces, to quoted UTF-8 format (for example, `%c3%ab` for character `ë`). | +| **URLEncodeAsURL** | Optional **Boolean**. Like **URLEncode**, but **TRUE** to specify that the string to encode is a path component of a URL so that forward slashes (`/`) are not encoded. | + ### Child elements None - -### Parent elements -Numerous - -### Occurrences +### Parent elements -- Minimum: 0 -- Maximum: Unbounded +Numerous -
    - +### Occurrences +- Minimum: 0 +- Maximum: Unbounded diff --git a/docs/schema/member-element-deploymentusergroupmap.md b/docs/schema/member-element-deploymentusergroupmap.md index 43551d552..3924b9c72 100644 --- a/docs/schema/member-element-deploymentusergroupmap.md +++ b/docs/schema/member-element-deploymentusergroupmap.md @@ -1,29 +1,28 @@ --- title: "Member Element (DeploymentUserGroupMap)" +description: "Describes the definition, element, and attribute information for the Member Element (DeploymentUserGroupMap)." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 83aef82b-1447-42c2-b88b-79144f98fbdd -description: "Last modified: March 09, 2015" --- # Member Element (DeploymentUserGroupMap) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a member of a deployment group (**DeploymentGroup**) object. ## Definition ```XML DECLARATION - USAGE @@ -37,7 +36,7 @@ USAGE ## Type **DeploymentGroupMember** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -47,16 +46,15 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Type**|**Description**| |:-----|:-----|:-----| |**UserId**
    |xx:string
    |Optional. Identifier of the deployment group member.
    | - + ### Child elements None - + ### Parent elements [Group Element (DeploymentUserGroupMap)](group-element-deploymentusergroupmap.md) - + ## See also - [DeploymentUserGroupMap Schema](deploymentusergroupmap-schema.md) - diff --git a/docs/schema/membership-element-query.md b/docs/schema/membership-element-query.md index ab38a5786..a45f69911 100644 --- a/docs/schema/membership-element-query.md +++ b/docs/schema/membership-element-query.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Query schema api_type: @@ -17,9 +16,9 @@ description: Defines a filter based on the type of membership for the user. # Membership element (Query) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a filter based on the type of membership for the user. - + ```XML @@ -35,26 +34,26 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Description**| |:-----|:-----| |**Type**
    | Required **Text**. Specifies the type of membership for the user. Possible values include the following:

    **SPWeb.AllUsers**
    **SPGroup**
    **SPWeb.Groups**
    **CurrentUserGroups**
    **SPWeb.Users**
    | - + ### Child elements - [FieldRef](fieldref-element-query.md) - + ### Parent elements - [And](and-element-query.md) - [Or](or-element-query.md) - [Where](where-element-query.md) - + ### Occurrences -- Minimum: 0 +- Minimum: 0 - Maximum: Unbounded - + ### Remarks The following example defines a filter for cases where the user is either assigned a task based on membership in a group or assigned a task directly. - + ```XML @@ -70,4 +69,3 @@ The following example defines a filter for cases where the user is either assign ```
    - diff --git a/docs/schema/menu-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/menu-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index 4649b30b0..6ed9ca915 100644 --- a/docs/schema/menu-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/menu-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,24 +1,24 @@ --- title: Menu element (CommandUIDefinitionType complexType) +description: Describes the definition, element, and attribute information for the Menu element (CommandUIDefinitionType complexType). manager: soliver -ms.date: 9/16/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c5b76f13-c582-b3ce-d077-f06f8e60dac6 --- -# Menu element (CommandUIDefinitionType complexType) +# Menu element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +|Information|Location| |---|---| | **Element type** | MenuType | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | @@ -59,26 +59,18 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements None. -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/menu-element.md b/docs/schema/menu-element.md index f7767bd48..3a10662ee 100644 --- a/docs/schema/menu-element.md +++ b/docs/schema/menu-element.md @@ -1,25 +1,24 @@ --- title: "Menu element (Server Ribbon)" +description: "Describes the definition, element, and attribute information for the Menu element (Server Ribbon), which defines a menu control." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: - schema ms.assetid: 1bc70fb9-bcf5-4758-a3dd-a3af3b4a745f -description: "Last modified: March 09, 2015" --- # Menu element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a menu control. - + ```XML     |Required. A string that identifies the element, such as "Ribbon.WikiPageTab.EditAndCheckout.SaveEdit.Menu".
    | |**MaxWidth**
    |Optional. The maximum width in pixels.
    | - + ### Child elements - [MenuSection](menusection-element.md) - + ### Parent elements -- [CommandUIDefinition](commanduidefinition-element.md) -- [ComboBox](combobox-element.md) -- [DropDown](dropdown-element.md) -- [FlyoutAnchor](flyoutanchor-element.md) -- [Jewel](jewel-element.md) -- [MRUSplitButton](mrusplitbutton-element.md) -- [SplitButton](splitbutton-element.md) - +- [CommandUIDefinition](commanduidefinition-element.md) +- [ComboBox](combobox-element.md) +- [DropDown](dropdown-element.md) +- [FlyoutAnchor](flyoutanchor-element.md) +- [Jewel](jewel-element.md) +- [MRUSplitButton](mrusplitbutton-element.md) +- [SplitButton](splitbutton-element.md) + ### Occurrences - Minimum: 0 -- Maximum: 1 - - +- Maximum: 1 diff --git a/docs/schema/menusection-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/menusection-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index cfae41df9..577f949f6 100644 --- a/docs/schema/menusection-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/menusection-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,25 +1,25 @@ --- title: MenuSection element (CommandUIDefinitionType complexType) +description: Describes the definition, element, and attribute information for the MenuSection element (CommandUIDefinitionType complexType). manager: soliver -ms.date: 9/16/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 015f7028-917f-95df-c48f-8473fff51b5d --- -# MenuSection element (CommandUIDefinitionType complexType) +# MenuSection element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +|Information|Location| |---|---| | **Element type** | MenuSectionType | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | @@ -60,26 +60,18 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements None. -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/menusection-element.md b/docs/schema/menusection-element.md index de58dace7..6f68fc960 100644 --- a/docs/schema/menusection-element.md +++ b/docs/schema/menusection-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines a section of a menu. # MenuSection element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a section of a menu. - + ```XML |Optional. An integer that specifies the order of placement among sibling XML nodes.
    | |**MaxHeight**
    |Optional. Specifies the maximum height of the section in pixels.
    | |**DisplayMode**
    | Optional. An enumeration value that determines how controls in this section of the menu are rendered.
    **Menu**. Renders as a text-only menu item.
    **Menu16**. Renders as a menu item with a 16-by-16-pixel icon.
    **Menu32**. Renders as a menu item with a 32-by-32-pixel icon.
    | - + ### Child elements -- [Controls](controls-element-menusection.md) -- [Gallery](gallery-element.md) - +- [Controls](controls-element-menusection.md) +- [Gallery](gallery-element.md) + > [!NOTE] -> A **MenuSection** element must contain either a **Controls** element or a **Gallery** element. - +> A **MenuSection** element must contain either a **Controls** element or a **Gallery** element. + ### Parent elements - [Menu](menu-element.md) - + ### Occurrences - Minimum: 1 -- Maximum: unbounded - - +- Maximum: unbounded diff --git a/docs/schema/metadata-element-list.md b/docs/schema/metadata-element-list.md index e782236f0..4bfb5f527 100644 --- a/docs/schema/metadata-element-list.md +++ b/docs/schema/metadata-element-list.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: @@ -17,9 +16,9 @@ description: Used in list definitions (Schema.xml file) to separate list metadat # MetaData element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Used in list definitions ([Schema.xml](https://msdn.microsoft.com/library/c2f01064-80d8-47ee-b602-ecf4c480ac56%28Office.15%29.aspx) file) to separate list metadata from data. - + +Used in list definitions ([Schema.xml](https://msdn.microsoft.com/library/c2f01064-80d8-47ee-b602-ecf4c480ac56%28Office.15%29.aspx) file) to separate list metadata from data. + ```XML @@ -32,7 +31,7 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [ContentTypes](contenttypes-element-list.md) @@ -44,20 +43,20 @@ None - [Toolbar](toolbar-element-list.md) - [Validation](validation-element-list.md) - [Views](views-element-list.md) - + ### Parent elements - [List](list-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ## Example -The following sample illustrates the skeletal structure of a list with **MetaData** and [Data](data-element-site.md) elements. - +The following sample illustrates the skeletal structure of a list with **MetaData** and [Data](data-element-site.md) elements. + ```XML @@ -83,4 +82,3 @@ The following sample illustrates the skeletal structure of a list with **MetaDat ## See also - [Data](data-element-site.md) - diff --git a/docs/schema/metadata-element-site.md b/docs/schema/metadata-element-site.md index 3d92ef76e..d2a1dbaeb 100644 --- a/docs/schema/metadata-element-site.md +++ b/docs/schema/metadata-element-site.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: - schema ms.assetid: 5b01ab05-5e08-48df-bc8c-b4cf5086ded7 -description: Used in the global Onet.xml to contain metadata for list base types. +description: Used in the global Onet.xml to contain metadata for list base types. --- # MetaData element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Used in the global [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx) to contain metadata for list base types. - + +Used in the global [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx) to contain metadata for list base types. + ```XML @@ -32,7 +31,7 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [ContentTypes](contenttypes-element-list.md) @@ -43,16 +42,14 @@ None - [Toolbar](toolbar-element-list.md) - [Validation](validation-element-list.md) - [Views](views-element-list.md) - + ### Parent elements - [BaseType](basetype-element-site.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - -
    - +- Maximum: 1 +
    diff --git a/docs/schema/metadata-element-workflow.md b/docs/schema/metadata-element-workflow.md index 56e7acaf2..bbff2afc1 100644 --- a/docs/schema/metadata-element-workflow.md +++ b/docs/schema/metadata-element-workflow.md @@ -1,13 +1,13 @@ --- title: MetaData Element (Workflow) +description: The MetaData Element (Workflow) contains any additional, custom metadata elements that are valid XML for the workflow. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference keywords: - workflow definition schema, metadata element (workflow) -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c454e18c-ea94-4dd1-8081-a25a8acbacef --- @@ -89,7 +89,7 @@ Following is an example of a **Metadata** element containing information on how Canceled Approved Rejected - +     ``` @@ -98,13 +98,3 @@ Following is an example of a **Metadata** element containing information on how - [Workflow Definitions](workflow-definitions.md) - [Workflows in Windows SharePoint Services](https://msdn.microsoft.com/library/be0888d4-20b2-4d39-bf28-2d8a71829d8e(Office.15).aspx) - [Workflow Deployment Using Features](https://msdn.microsoft.com/library/ad294f09-483d-4e87-bd19-fa37795ed558(Office.15).aspx) - - - - - - - - - - diff --git a/docs/schema/method-element-in-methods-bdcmetadata-schema.md b/docs/schema/method-element-in-methods-bdcmetadata-schema.md index 71683ca61..91f835916 100644 --- a/docs/schema/method-element-in-methods-bdcmetadata-schema.md +++ b/docs/schema/method-element-in-methods-bdcmetadata-schema.md @@ -1,13 +1,13 @@ --- title: Method element in Methods (BDCMetadata) +description: Describes the definition, element, and attribute information for the Method element in Methods (BDCMetadata), which specifies a method of an external content type. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.Method -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 70e87a9e-4959-0a7b-3f37-ddec36473ff4 --- @@ -21,6 +21,8 @@ Specifies a method of an external content type. **Schema**: BDCMetadata +## Definition + ```XML ``` @@ -31,119 +33,27 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Attribute

    Description

    **IsStatic**

    Optional.

    -

    Specifies whether the execution of this method requires an external item (**EntityInstance**) to serve as a context for execution. If set to **true**, the method represents a static method and does not require a specific **EntityInstance** to provide context for execution. If set to **false**, the method represents an instance method and requires an **EntityInstance** to provide the context for execution.

    -

    Default value: **true**

    -

    Attribute type: **Boolean**

    **LobName**

    Optional.

    -

    The name of the operation defined in the external system that is represented by this method.

    -

    Attribute type: **String**

    **Name**

    Required.

    -

    The name of this method.

    -

    Attribute type: **String**

    **DefaultDisplayName**

    Optional.

    -

    The default display name of the method.

    -

    Attribute type: **String**

    **IsCached**

    Optional.

    -

    Specifies whether this method is used frequently. If set to **true**, Business Data Connectivity (BDC) service caches this method in memory.

    -

    Default value: **true**

    -

    Attribute type: **Boolean**

    +|Attribute|Description| +|---------|-----------| +|**IsStatic**|Optional.

    Specifies whether the execution of this method requires an external item (**EntityInstance**) to serve as a context for execution. If set to **true**, the method represents a static method and does not require a specific **EntityInstance** to provide context for execution. If set to **false**, the method represents an instance method and requires an **EntityInstance** to provide the context for execution.

    Default value: **true**

    Attribute type: **Boolean**| +|**LobName**|Optional.

    The name of the operation defined in the external system that is represented by this method.

    Attribute type: **String**| +|**Name**|Required.

    The name of this method.

    Attribute type: **String**| +|**DefaultDisplayName**|Optional.

    The default display name of the method.

    Attribute type: **String**| +|**IsCached**|Optional.

    Specifies whether this method is used frequently. If set to **true**, Business Data Connectivity (BDC) service caches this method in memory.

    Default value: **true**

    Attribute type: **Boolean**| ### Child elements - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Element

    Description

    LocalizedDisplayNames Element in MetadataObject (BDCMetadata Schema)

    The localized display names of the method.

    Properties Element in MetadataObject (BDCMetadata Schema)

    The properties of the method.

    AccessControlList Element (BDCMetadata Schema)

    The access control list (ACL) of this method.

    FilterDescriptors Element in Method (BDCMetadata Schema)

    The filter descriptors of the method.

    Parameters Element in Method (BDCMetadata Schema)

    The parameters of the method. A method cannot have more than one return parameter.

    MethodInstances Element in Method (BDCMetadata Schema)

    The method instances of the method.

    +|Element|Description| +|-------|-----------| +|[LocalizedDisplayNames Element in MetadataObject (BDCMetadata Schema)](localizeddisplaynames-element-in-metadataobject-bdcmetadata-schema.md)|The localized display names of the method.| +|[Properties Element in MetadataObject (BDCMetadata Schema)](properties-element-in-metadataobject-bdcmetadata-schema.md)|The properties of the method.| +|[AccessControlList Element (BDCMetadata Schema)](accesscontrollist-element-bdcmetadata-schema.md)|The access control list (ACL) of this method.| +|[FilterDescriptors Element in Method (BDCMetadata Schema)](filterdescriptors-element-in-method-bdcmetadata-schema.md)|The filter descriptors of the method.| +|[Parameters Element in Method (BDCMetadata Schema)](parameters-element-in-method-bdcmetadata-schema.md)|The parameters of the method. A method cannot have more than one return parameter.| +|[MethodInstances Element in Method (BDCMetadata Schema)](methodinstances-element-in-method-bdcmetadata-schema.md)|The method instances of the method.| ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    Methods Element in Entity (BDCMetadata Schema)

    A list of methods of an external content type.

    - - - - - - - - +|Element|Description| +|-------|-----------| +|[Methods Element in Entity (BDCMetadata Schema)](methods-element-in-entity-bdcmetadata-schema.md)|A list of methods of an external content type.| diff --git a/docs/schema/method-element-in-methods-bdcmetadataresource-schema.md b/docs/schema/method-element-in-methods-bdcmetadataresource-schema.md index a7cb1de3d..aa6c9146b 100644 --- a/docs/schema/method-element-in-methods-bdcmetadataresource-schema.md +++ b/docs/schema/method-element-in-methods-bdcmetadataresource-schema.md @@ -1,11 +1,11 @@ --- title: Method element in Methods (BDCMetadataResource) +description: Method element in Methods (BDCMetadataResource) specifies localized display names, properties, and permissions for a Method Element in Methods (BDCMetadata Schema). manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 533c94af-e18a-75af-1ef8-e42811534a12 --- @@ -19,6 +19,7 @@ Specifies localized display names, properties, and permissions, in any combinati **Schema**: BDCMetadataResource +## Definition ``` ``` @@ -33,59 +34,17 @@ None. ### Child elements - --- - - - - - - - - - - - - - - - - - - - - - - - - - -

    Element

    LocalizedDisplayNames Element in MetadataObject (BDCMetadataResource Schema)

    Properties Element in MetadataObject (BDCMetadataResource Schema)

    AccessControlList Element in IndividuallySecurableMetadataObject (BDCMetadataResource Schema)

    FilterDescriptors Element in Method (BDCMetadataResource Schema)

    Parameters Element in Method (BDCMetadataResource Schema)

    MethodInstances Element in Method (BDCMetadataResource Schema)

    +|Element| +|-------| +|[LocalizedDisplayNames Element in MetadataObject (BDCMetadataResource Schema)](localizeddisplaynames-element-in-metadataobject-bdcmetadataresource-schema.md)| +|[Properties Element in MetadataObject (BDCMetadataResource Schema)](properties-element-in-metadataobject-bdcmetadataresource-schema.md)| +|[AccessControlList Element in IndividuallySecurableMetadataObject (BDCMetadataResource Schema)](accesscontrollist-element-in-individuallysecurablemetadataobject-bdcmetadatareso.md)| +|[FilterDescriptors Element in Method (BDCMetadataResource Schema)](filterdescriptors-element-in-method-bdcmetadataresource-schema.md)| +|[Parameters Element in Method (BDCMetadataResource Schema)](parameters-element-in-method-bdcmetadataresource-schema.md)| +|[MethodInstances Element in Method (BDCMetadataResource Schema)](methodinstances-element-in-method-bdcmetadataresource-schema.md)| ### Parent elements - --- - - - - - - - - - - -

    Element

    Methods Element in Entity (BDCMetadataResource Schema)

    - - - - - - - - +|Element| +|-------| +|[Methods Element in Entity (BDCMetadataResource Schema)](methods-element-in-entity-bdcmetadataresource-schema.md)| diff --git a/docs/schema/method-element-list.md b/docs/schema/method-element-list.md index dd4d0ec2b..d1fa7df42 100644 --- a/docs/schema/method-element-list.md +++ b/docs/schema/method-element-list.md @@ -1,23 +1,22 @@ --- title: "Method element (List)" +description: Describes the the Method element (List) and provides a definition and the elements and attributes in SharePoint. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: - schema ms.assetid: 6848da4e-e6f2-4663-bef9-0413f74b0251 -description: "Last modified: March 09, 2015" --- # Method element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + ```vb ``` @@ -31,30 +30,28 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Description**| |:-----|:-----| |**Name**
    |Optional **Text**.
    | - + ### Child elements - [Filter](filter-element-list.md) - + ### Parent elements - [View](view-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ## Example This is the description for a Code Example. - + Microsoft.Win32.RegistryKey#4 Optional comments. - + ### .NET Framework equivalent Optional .NET Framework equivalent section. - - diff --git a/docs/schema/method-element-view.md b/docs/schema/method-element-view.md index 2602bbab2..6eef4635d 100644 --- a/docs/schema/method-element-view.md +++ b/docs/schema/method-element-view.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: - schema ms.assetid: bfcb7a97-c9e7-4b16-9a20-9c023c9ffc2b -description: Used in batch processing to specify commands within the Batch element. +description: Used in batch processing to specify commands within the Batch element. --- # Method element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Used in batch processing to specify commands within the [Batch](batch-element-view.md) element. - + +Used in batch processing to specify commands within the [Batch](batch-element-view.md) element. + ```XML | Optional **Text**. Used in Web services to specify the command to post to the server for updating list items. Possible values include the following:
    - **Delete**: Delete the specified item.
    - **New**: Create the specified item.
    - **Update**: Modify the specified item.
    | |**ID**
    |Required **Text**. A freeform identification string that is not actually used by the server but that is returned to the client.
    | - + ### Child elements - [Field](field-element-list.md) - [SetList](setlist-element-view.md) - [SetVar](setvar-element-view.md) - + ### Parent elements - [Batch](batch-element-view.md) - + ### Occurrences - Minimum: 1 -- Maximum: Unbounded - +- Maximum: Unbounded + ### Remarks -The **Method** element is required for the **Batch** element, which is embedded within HTTP protocol and allows the client application to post more than one command at a time to the server. - -In operations where the [SetVar](setvar-element-view.md) element is used within the **Method** element to post commands, the **Cmd** attribute can contain methods in the [Windows SharePoint Services RPC Protocol](https://msdn.microsoft.com/library/1af2791b-f17f-42f3-95ea-1a4df9b8e3d0%28Office.15%29.aspx) protocol. - -When used with the [UpdateListItems](https://msdn.microsoft.com/library/WebSvcLists.Lists.UpdateListItems.aspx) method of the [Lists](https://msdn.microsoft.com/library/WebSvcLists.Lists.aspx) Web service, each **Method** element contains [Field](field-element-list.md) elements that specify the column values for each item being updated. - +The **Method** element is required for the **Batch** element, which is embedded within HTTP protocol and allows the client application to post more than one command at a time to the server. + +In operations where the [SetVar](setvar-element-view.md) element is used within the **Method** element to post commands, the **Cmd** attribute can contain methods in the [Windows SharePoint Services RPC Protocol](https://msdn.microsoft.com/library/1af2791b-f17f-42f3-95ea-1a4df9b8e3d0%28Office.15%29.aspx) protocol. + +When used with the [UpdateListItems](https://msdn.microsoft.com/library/WebSvcLists.Lists.UpdateListItems.aspx) method of the [Lists](https://msdn.microsoft.com/library/WebSvcLists.Lists.aspx) Web service, each **Method** element contains [Field](field-element-list.md) elements that specify the column values for each item being updated. + ## Example -The following example uses the **Method** element to post the remote procedure call (RPC) [ExportList](https://msdn.microsoft.com/library/0e3b38ed-34de-4a16-a178-66a750de92c8%28Office.15%29.aspx) command and return the schema of a specified list. - +The following example uses the **Method** element to post the remote procedure call (RPC) [ExportList](https://msdn.microsoft.com/library/0e3b38ed-34de-4a16-a178-66a750de92c8%28Office.15%29.aspx) command and return the schema of a specified list. + ```XML diff --git a/docs/schema/methodinstance-element-in-methodinstances-bdcmetadata-schema.md b/docs/schema/methodinstance-element-in-methodinstances-bdcmetadata-schema.md index ab8e6a467..8089a6588 100644 --- a/docs/schema/methodinstance-element-in-methodinstances-bdcmetadata-schema.md +++ b/docs/schema/methodinstance-element-in-methodinstances-bdcmetadata-schema.md @@ -2,13 +2,12 @@ title: MethodInstance Element in MethodInstances (BDCMetadata Schema) description: Details on the MethodInstance Element in MethodInstances (BDCMetadata Schema) manager: soliver -ms.date: 01/27/2021 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.MethodInstance -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 577ff9d0-706b-be7d-af5b-883e137cada8 --- @@ -22,11 +21,11 @@ Specifies a **MethodInstance**. **Schema**: BDCMetadata -> [!NOTE] +> [!NOTE] > The following two cases in a BDC model result in an [InvalidOperationException](https://msdn.microsoft.com/library/frlrfSystemInvalidOperationExceptionClassTopic.aspx) at run time: -> +> > - Two **SpecificFinder** method instances that return the same set of fields. > - Two **SpecificFinder** method instances that have the same number of fields and that share the same number of fields with another method instance, such as a **Finder**. @@ -184,58 +183,16 @@ The following sections describe attributes, child elements, and parent elements. ### Child elements - ---- - - - - - - - - - - - - - - - - - - - - -

    Element

    Description

    LocalizedDisplayNames Element in MetadataObject (BDCMetadata Schema)

    The localized display names of the **MethodInstance**.

    Properties Element in MetadataObject (BDCMetadata Schema)

    The properties of the **MethodInstance**.

    AccessControlList Element (BDCMetadata Schema)

    The access control lists (ACLs) of the **MethodInstance**.

    - -### Parent elements - - ---- - - - - - - - - - - - - -

    Element

    Description

    MethodInstances Element in Method (BDCMetadata Schema)

    The **MethodInstances** element that contains this **MethodInstance**.

    - - - - +| Element | Description | +| --- | --- | +| [LocalizedDisplayNames Element in MetadataObject (BDCMetadata Schema)](localizeddisplaynames-element-in-metadataobject-bdcmetadata-schema.md) | The localized display names of the **MethodInstance**. | +| [Properties Element in MetadataObject (BDCMetadata Schema)](properties-element-in-metadataobject-bdcmetadata-schema.md) | The properties of the **MethodInstance**. | +| [AccessControlList Element (BDCMetadata Schema)](accesscontrollist-element-bdcmetadata-schema.md) | The access control lists (ACLs) of the **MethodInstance**. | +### Parent elements +| Element | Description | +| --- | --- | +| [MethodInstances Element in Method (BDCMetadata Schema)](methodinstances-element-in-method-bdcmetadata-schema.md) | The **MethodInstances** element that contains this **MethodInstance**. | diff --git a/docs/schema/methodinstance-element-in-methodinstances-bdcmetadataresource-schema.md b/docs/schema/methodinstance-element-in-methodinstances-bdcmetadataresource-schema.md index 364660a41..b84e0cbb4 100644 --- a/docs/schema/methodinstance-element-in-methodinstances-bdcmetadataresource-schema.md +++ b/docs/schema/methodinstance-element-in-methodinstances-bdcmetadataresource-schema.md @@ -2,11 +2,10 @@ title: MethodInstance Element in MethodInstances (BDCMetadataResource Schema) description: Details on the MethodInstance Element in MethodInstances (BDCMetadataResource Schema) manager: soliver -ms.date: 01/27/2021 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9174eee9-3a97-ac0b-06c0-4eddf8737d18 --- @@ -34,51 +33,14 @@ None. ### Child elements - --- - - - - - - - - - - - - - - - - -

    Element

    LocalizedDisplayNames Element in MetadataObject (BDCMetadataResource Schema)

    Properties Element in MetadataObject (BDCMetadataResource Schema)

    AccessControlList Element in IndividuallySecurableMetadataObject (BDCMetadataResource Schema)

    +| Element | +| --- | +| [LocalizedDisplayNames Element in MetadataObject (BDCMetadataResource Schema)](localizeddisplaynames-element-in-metadataobject-bdcmetadataresource-schema.md) | +| [Properties Element in MetadataObject (BDCMetadataResource Schema)](properties-element-in-metadataobject-bdcmetadataresource-schema.md) | +| [AccessControlList Element in IndividuallySecurableMetadataObject (BDCMetadataResource Schema)](accesscontrollist-element-in-individuallysecurablemetadataobject-bdcmetadatareso.md) | ### Parent elements - --- - - - - - - - - - - -

    Element

    MethodInstances Element in Method (BDCMetadataResource Schema)

    - - - - - - - - - +| Element | +| --- | +| [MethodInstances Element in Method (BDCMetadataResource Schema)](methodinstances-element-in-method-bdcmetadataresource-schema.md) | diff --git a/docs/schema/methodinstances-element-in-method-bdcmetadata-schema.md b/docs/schema/methodinstances-element-in-method-bdcmetadata-schema.md index 9e13ed825..b08475a80 100644 --- a/docs/schema/methodinstances-element-in-method-bdcmetadata-schema.md +++ b/docs/schema/methodinstances-element-in-method-bdcmetadata-schema.md @@ -2,13 +2,12 @@ title: MethodInstances Element in Method (BDCMetadata Schema) description: Details on the MethodInstances Element in Method (BDCMetadata Schema) manager: soliver -ms.date: 01/27/2021 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.MethodInstances -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: dae3aeae-e72a-0b52-1348-f5e5cd31109f --- @@ -36,54 +35,15 @@ None. ### Child elements - ---- - - - - - - - - - - - - - - - - -

    Element

    Description

    Association Element in MethodInstances (BDCMetadata Schema)

    An association.

    MethodInstance Element in MethodInstances (BDCMetadata Schema)

    A method instance.

    - -### Parent elements - - ---- - - - - - - - - - - - - -

    Element

    Description

    Method Element in Methods (BDCMetadata Schema)

    The method that this method instance belongs to.

    - - - - +| Element | Description | +| --- | --- | +| [Association Element in MethodInstances (BDCMetadata Schema)](association-element-in-methodinstances-bdcmetadata-schema.md) | An association. | +| [MethodInstance Element in MethodInstances (BDCMetadata Schema)](methodinstance-element-in-methodinstances-bdcmetadata-schema.md) | A method instance. | +### Parent elements +| Element | Description | +| --- | --- | +| [Method Element in Methods (BDCMetadata Schema)](method-element-in-methods-bdcmetadata-schema.md) | The method that this method instance belongs to. | diff --git a/docs/schema/methodinstances-element-in-method-bdcmetadataresource-schema.md b/docs/schema/methodinstances-element-in-method-bdcmetadataresource-schema.md index 5f7d655fa..65b168fb1 100644 --- a/docs/schema/methodinstances-element-in-method-bdcmetadataresource-schema.md +++ b/docs/schema/methodinstances-element-in-method-bdcmetadataresource-schema.md @@ -2,11 +2,10 @@ title: MethodInstances Element in Method (BDCMetadataResource Schema) description: Details on the MethodInstances Element in Method (BDCMetadataResource Schema) manager: soliver -ms.date: 01/27/2021 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 25eec00b-98be-e684-076d-c591a093d5f5 --- @@ -34,47 +33,13 @@ None. ### Child elements - --- - - - - - - - - - - - - - -

    Element

    Association Element in MethodInstances (BDCMetadataResource Schema)

    MethodInstance Element in MethodInstances (BDCMetadataResource Schema)

    +| Element | +| --- | +| [Association Element in MethodInstances (BDCMetadataResource Schema)](association-element-in-methodinstances-bdcmetadataresource-schema.md) | +| [MethodInstance Element in MethodInstances (BDCMetadataResource Schema)](methodinstance-element-in-methodinstances-bdcmetadataresource-schema.md) | ### Parent elements - --- - - - - - - - - - - -

    Element

    Method Element in Methods (BDCMetadataResource Schema)

    - - - - - - - - +| Element | +| --- | +| [Method Element in Methods (BDCMetadataResource Schema)](method-element-in-methods-bdcmetadataresource-schema.md) | diff --git a/docs/schema/methods-element-in-entity-bdcmetadata-schema.md b/docs/schema/methods-element-in-entity-bdcmetadata-schema.md index dbd5519cd..acda4b0f1 100644 --- a/docs/schema/methods-element-in-entity-bdcmetadata-schema.md +++ b/docs/schema/methods-element-in-entity-bdcmetadata-schema.md @@ -7,8 +7,7 @@ ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.Methods -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 42a24b32-bd97-4067-2e25-681d876d29fd --- @@ -44,4 +43,4 @@ None. | Element | Description | | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- | -| [Entity Element in Entities (BDCMetadata Schema)

    ](entity-element-in-entities-bdcmetadata-schema.md) | The external content type that this list of methods belongs to. | \ No newline at end of file +| [Entity Element in Entities (BDCMetadata Schema)

    ](entity-element-in-entities-bdcmetadata-schema.md) | The external content type that this list of methods belongs to. | diff --git a/docs/schema/methods-element-in-entity-bdcmetadataresource-schema.md b/docs/schema/methods-element-in-entity-bdcmetadataresource-schema.md index 536ac9813..919287311 100644 --- a/docs/schema/methods-element-in-entity-bdcmetadataresource-schema.md +++ b/docs/schema/methods-element-in-entity-bdcmetadataresource-schema.md @@ -5,8 +5,7 @@ manager: soliver ms.date: 01/27/2021 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: e77e39d9-388b-3dc5-9550-6b75fdb29814 --- diff --git a/docs/schema/mobile-document-viewer-schema.md b/docs/schema/mobile-document-viewer-schema.md index 993b2627a..b1ed92582 100644 --- a/docs/schema/mobile-document-viewer-schema.md +++ b/docs/schema/mobile-document-viewer-schema.md @@ -4,26 +4,23 @@ manager: soliver ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 219b4aa9-0f70-4700-bcc7-069acd056b95 -description: The mobile document viewer XML is used to redirect requests from mobile devices for a specific document to a page that hosts a viewer that is capable of displaying documents of that type. +description: The mobile document viewer XML is used to redirect requests from mobile devices for a specific document to a page that hosts a viewer that is capable of displaying documents of that type. --- # Mobile Document Viewer schema **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Most mobile devices have browsers that can render pages only in the browser's rendering format. But document libraries can contain documents in other formats. The mobile document viewer XML is used to redirect requests from mobile devices for a specific document to a page that hosts a viewer that is capable of displaying documents of that type. The markup also allows browsers that contain their own viewer for the specified type of document to override the redirection and open the document directly. - + +Most mobile devices have browsers that can render pages only in the browser's rendering format. But document libraries can contain documents in other formats. The mobile document viewer XML is used to redirect requests from mobile devices for a specific document to a page that hosts a viewer that is capable of displaying documents of that type. The markup also allows browsers that contain their own viewer for the specified type of document to override the redirection and open the document directly. + ## Elements - [MobileDocViewers](mobiledocviewers-mobile-document-viewer.md) - + - [MobileDocViewer](mobiledocviewer-mobile-document-viewer.md) - + - [BrowserCondition](browsercondition-mobile-document-viewer.md) - -- [Override](override-mobile-document-viewer.md) - +- [Override](override-mobile-document-viewer.md) diff --git a/docs/schema/mobiledocviewer-mobile-document-viewer.md b/docs/schema/mobiledocviewer-mobile-document-viewer.md index 2e4b049df..34a90ab11 100644 --- a/docs/schema/mobiledocviewer-mobile-document-viewer.md +++ b/docs/schema/mobiledocviewer-mobile-document-viewer.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Mobile Document Viewer XML ms.assetid: 5f606061-9eb5-49c9-93c0-75b3bd6bc4f6 @@ -15,9 +14,9 @@ description: Specifies how a request for a document for a specific type is redir # MobileDocViewer element (Mobile Document Viewer) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies how a request for a document for a specific type is redirected to a page that hosts a viewer that can open documents of that type. - + ```XML ``` @@ -35,23 +34,23 @@ The following sections describe attributes, child elements, and parent elements. |**FeatureId**
    |Optional. The GUID of the Feature, if any, that was used to deploy the viewer page.
    | |**QueryId**
    |The query ID key; for example, "doc".
    | |**AppendSourceUrl**
    |**True** if a source query ID should be appended to the URL of page that hosts the viewer; otherwise, **false**. The source query value is the path to the folder that holds the document. In the special case where `"?mobile=1"` is part of the original URL, the source query value is the same as the source query value of the original URL.
    | - + ### Child elements |**Element**|**Description**| |:-----|:-----| |[BrowserCondition](browsercondition-mobile-document-viewer.md)
    |Optional. Identifies a browser capability that means the browser can use an alternative viewer for the specified type of file.
    | - + ### Parent elements |**Element**|**Description**| |:-----|:-----| |[MobileDocViewers](mobiledocviewers-mobile-document-viewer.md)
    |Specifies the document viewing page for one or more types of documents.
    | - + ## Example The following example shows this element in use. - + ```XML @@ -66,4 +65,3 @@ The following example shows this element in use. ## See also - [Developing Mobile Document Viewers](https://msdn.microsoft.com/library/acd5386d-7808-4fd8-843f-0a4ac9ddd6b0%28Office.15%29.aspx) - diff --git a/docs/schema/mobiledocviewers-mobile-document-viewer.md b/docs/schema/mobiledocviewers-mobile-document-viewer.md index 6a7d25d15..0c4898032 100644 --- a/docs/schema/mobiledocviewers-mobile-document-viewer.md +++ b/docs/schema/mobiledocviewers-mobile-document-viewer.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Mobile Document Viewer XML ms.assetid: 171e58ff-ca97-4ac8-9ebc-fdcaeabc885c @@ -15,9 +14,9 @@ description: Specifies the document-viewing page for one or more types of docume # MobileDocViewers element (Mobile Document Viewer) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Specifies the document-viewing page for one or more types of documents. - + +Specifies the document-viewing page for one or more types of documents. + ```XML @@ -32,25 +31,25 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements |**Element**|**Description**| |:-----|:-----| |[MobileDocViewer](mobiledocviewer-mobile-document-viewer.md)
    |Configures redirection for a specific type of document.
    | - + ### Parent elements None - + ### Remarks -The **MobileDocViewers** element persists in a file named `mdocview_*.xml`, where the asterisk (`*`) is some string of valid file name characters. We recommend using your company name or some other string that is not likely to duplicate the name that is used by other document viewer providers. The page is deployed to %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\Config on all front-end web servers. - +The **MobileDocViewers** element persists in a file named `mdocview_*.xml`, where the asterisk (`*`) is some string of valid file name characters. We recommend using your company name or some other string that is not likely to duplicate the name that is used by other document viewer providers. The page is deployed to %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\Config on all front-end web servers. + ## Example The following example shows this element in use. - + ```XML @@ -65,4 +64,3 @@ The following example shows this element in use. ## See also - [Developing Mobile Document Viewers](https://msdn.microsoft.com/library/acd5386d-7808-4fd8-843f-0a4ac9ddd6b0%28Office.15%29.aspx) - diff --git a/docs/schema/model-element-bdcmetadata-schema.md b/docs/schema/model-element-bdcmetadata-schema.md index 7c94d3ecb..e609caea3 100644 --- a/docs/schema/model-element-bdcmetadata-schema.md +++ b/docs/schema/model-element-bdcmetadata-schema.md @@ -7,8 +7,7 @@ ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.Model -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d7823090-b20d-2c96-c359-081c055d0e65 --- # Model Element (BDCMetadata Schema) diff --git a/docs/schema/model-element-bdcmetadataresource-schema.md b/docs/schema/model-element-bdcmetadataresource-schema.md index e0c820bf6..ecfb2aa8e 100644 --- a/docs/schema/model-element-bdcmetadataresource-schema.md +++ b/docs/schema/model-element-bdcmetadataresource-schema.md @@ -5,8 +5,7 @@ manager: soliver ms.date: 01/27/2021 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 26f834ca-0db4-ec9f-528f-9e4da115322b --- diff --git a/docs/schema/modification-element-modifications-elementaction-elementactions-elementworkflowi.md b/docs/schema/modification-element-modifications-elementaction-elementactions-elementworkflowi.md index 3e7d41957..9e7c92811 100644 --- a/docs/schema/modification-element-modifications-elementaction-elementactions-elementworkflowi.md +++ b/docs/schema/modification-element-modifications-elementaction-elementactions-elementworkflowi.md @@ -1,15 +1,15 @@ --- title: Modification element +description: Describes the Modification element and provides the usage, element information, a definition, and elements and attributes in SharePoint. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 42c04adb-4809-40ac-d145-a7a103883b2b --- -# Modification element +# Modification element (Modifications element) (Action element) (Actions element) (WorkflowInfo element) (Action4) @@ -59,7 +59,7 @@ Specifies a workflow modification. - + ``` ## Elements and attributes @@ -137,11 +137,3 @@ None. - - - - - - - - diff --git a/docs/schema/modification-element-workflowactions.md b/docs/schema/modification-element-workflowactions.md index 06435fdfe..5632626b4 100644 --- a/docs/schema/modification-element-workflowactions.md +++ b/docs/schema/modification-element-workflowactions.md @@ -1,13 +1,13 @@ --- title: Modification Element (WorkflowActions) +description: Describes the Modification element (WorkflowActions) and provides a definition and the elements and attributes in SharePoint. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: fcfdc7be-8952-4641-abe0-d3b7f114d378 --- @@ -85,10 +85,3 @@ None - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - - diff --git a/docs/schema/modification-element-workflowinfo.md b/docs/schema/modification-element-workflowinfo.md index f819b3d00..3abdb7bbb 100644 --- a/docs/schema/modification-element-workflowinfo.md +++ b/docs/schema/modification-element-workflowinfo.md @@ -1,13 +1,13 @@ --- title: Modification Element (WorkflowInfo) +description: Describes the Modification element (WorkflowInfo) and provides a definition and the elements and attributes in SharePoint. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ba2942c8-a7e4-4ee5-817a-0ad3b5b0b18b --- @@ -88,10 +88,3 @@ None - [Default Workflow Conditions](default-workflow-conditions-workflowinfo.md) - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - - diff --git a/docs/schema/modification_guid_name-element-workflow.md b/docs/schema/modification_guid_name-element-workflow.md index 729cafd5c..c1bd713f6 100644 --- a/docs/schema/modification_guid_name-element-workflow.md +++ b/docs/schema/modification_guid_name-element-workflow.md @@ -1,13 +1,13 @@ --- title: Modification_GUID_Name Element (Workflow) +description: Describes the Modification_GUID_Name element (Workflow) and provides a definition, the elements and attributes, and an example. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference keywords: - workflow definition schema, modification_guid_name element (workflow) -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ca629084-42d0-4e22-9559-34ed1158b30a --- @@ -68,7 +68,7 @@ None The modification name is displayed as the link text for the modification link on the workflow status page. -To specify a modification form, you must first set the ModificationId property of the EnableWorkflowModification activity to the GUID you generated for your modification form. You can have multiple modifications available in your workflow; you must assign each modification a unique identifier. +To specify a modification form, you must first set the ModificationId property of the EnableWorkflowModification activity to the GUID you generated for your modification form. You can have multiple modifications available in your workflow; you must assign each modification a unique identifier. ## Example @@ -85,13 +85,3 @@ The following example specifies a modification name of **Add a New Reviewer**. T - [Workflow Definitions](workflow-definitions.md) - [Workflows in Windows SharePoint Services](https://msdn.microsoft.com/library/be0888d4-20b2-4d39-bf28-2d8a71829d8e(Office.15).aspx) - [Workflow Deployment Using Features](https://msdn.microsoft.com/library/ad294f09-483d-4e87-bd19-fa37795ed558(Office.15).aspx) - - - - - - - - - - diff --git a/docs/schema/modifications-element-action-elementactions-elementworkflowinfo-elementaction4.md b/docs/schema/modifications-element-action-elementactions-elementworkflowinfo-elementaction4.md index 2db6e7162..f0cb6a54a 100644 --- a/docs/schema/modifications-element-action-elementactions-elementworkflowinfo-elementaction4.md +++ b/docs/schema/modifications-element-action-elementactions-elementworkflowinfo-elementaction4.md @@ -1,15 +1,15 @@ --- title: Modifications element +description: Describes the Modifications element and provides the usage, element information, a definition, and elements and attributes in SharePoint. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c2c25f2d-f252-6769-5924-c13571a0c763 --- -# Modifications element +# Modifications element (Action element) (Actions element) (WorkflowInfo element) (Action4) @@ -64,10 +64,10 @@ Container for **Modification** element collections that specify modifications as - + - + ``` ## Elements and attributes @@ -125,11 +125,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** ### Attributes None. - - - - - - - - diff --git a/docs/schema/modifications-element-workflowactions.md b/docs/schema/modifications-element-workflowactions.md index 49847cdd9..61159030e 100644 --- a/docs/schema/modifications-element-workflowactions.md +++ b/docs/schema/modifications-element-workflowactions.md @@ -1,13 +1,13 @@ --- title: Modifications Element (WorkflowActions) +description: Describes the Modifications element (WorkflowActions) and provides a definition and the elements and attributes in SharePoint. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ea3b4d73-520a-49a8-9845-4ee271e9cbba --- @@ -69,8 +69,3 @@ None - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - diff --git a/docs/schema/modifications-element-workflowinfo.md b/docs/schema/modifications-element-workflowinfo.md index 146d6ff0b..386065cc5 100644 --- a/docs/schema/modifications-element-workflowinfo.md +++ b/docs/schema/modifications-element-workflowinfo.md @@ -1,13 +1,13 @@ --- title: Modifications Element (WorkflowInfo) +description: Describes the Modifications element (WorkflowInfo) and provides a definition and the elements and attributes in SharePoint. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 18c6b7d8-f447-4d12-90dd-772929114dc6 --- @@ -71,10 +71,3 @@ None - [Default Workflow Conditions](default-workflow-conditions-workflowinfo.md) - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - - diff --git a/docs/schema/module-element-deploymentmanifest.md b/docs/schema/module-element-deploymentmanifest.md index 1182140d3..558f56875 100644 --- a/docs/schema/module-element-deploymentmanifest.md +++ b/docs/schema/module-element-deploymentmanifest.md @@ -1,20 +1,19 @@ --- title: "Module Element (DeploymentManifest)" +description: Describes the Modifications element (DeploymentManifest) and provides a definition and the elements and attributes in SharePoint. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6c4ef8ae-88fa-4055-aaa3-9089ed609d40 -description: "Last modified: March 09, 2015" --- # Module Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents an instance of a SharePoint module ([SPModule](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPModule.aspx)) object, providing a collection of files and views that are used in a site template. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents an instance of a SharePoint module ([SPModule](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPModule.aspx)) object, providing a collection of files and views that are used in a site template. ## Definition @@ -37,8 +36,8 @@ USAGE ## Type -[SPModule](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPModule.aspx) object. - +[SPModule](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPModule.aspx) object. + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -51,17 +50,16 @@ The following sections describe attributes, child elements, and parent elements. |**Name**
    |xs:string
    |Optional. Represents the name of the module.
    | |**ParentWeb**
    |xs:string
    |Optional. Specifies the parent website.
    | |**Url**
    |xs:string
    |Optional. Specifies the server-relative URL for the module.
    | - + ### Child elements [Properties Element (DeploymentManifest - SPModule)](properties-element-deploymentmanifestspmodule.md) - + ### Parent elements [SPObject Element (DeploymentManifest)](spobject-element-deploymentmanifest.md) - + ## See also - [SPModule](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPModule.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/module-element-module.md b/docs/schema/module-element-module.md index 2c145c763..d0804d86b 100644 --- a/docs/schema/module-element-module.md +++ b/docs/schema/module-element-module.md @@ -1,11 +1,11 @@ --- title: Module Element (Module) +description: Describes the Module element (Module) and provides a definition, the elements and attributes, and an example. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1e7fd643-5029-4158-910e-2ab5396efcb4 --- @@ -167,7 +167,7 @@ The following sections describe attributes, child elements, and parent elements. The **Module** element specifies a file or collection of files and a location where the files are installed during site creation. If the file is a web part page, the module definition can specify which web parts should be included on the page. -## Example +## Example For an example of how this element is used, see [Modules](modules.md). @@ -176,10 +176,3 @@ For an example of how this element is used, see [Modules](modules.md). - [Module](https://msdn.microsoft.com/library/e5eeed6e-d785-496d-82b5-08d153588045(Office.15).aspx) - [How to: Provision a File](https://msdn.microsoft.com/library/438d5a75-7f39-4fa9-a365-d86e8ba967b6(Office.15).aspx) - - - - - - - diff --git a/docs/schema/module-element-site.md b/docs/schema/module-element-site.md index 15853c8fa..3cc218c7c 100644 --- a/docs/schema/module-element-site.md +++ b/docs/schema/module-element-site.md @@ -1,11 +1,10 @@ --- title: "Module element (Site)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: @@ -17,9 +16,9 @@ description: Specifies files and "all user" web parts with which to provision a # Module element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies files and "all user" web parts with which to provision a website. - + ```XML HyperlinkBaseUrl = "Text" @@ -48,31 +47,31 @@ The following sections describe attributes, child elements, and parent elements. |**Path**
    | Optional **Text**. Specifies the physical path to the file set relative to %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\SiteTemplates\ \_Site\_Definition_.

    Can only contain the following characters:
    alphanumeric
    hyphen (**-**)
    underscore (**\_**)
    period (**.**)
    space ( )
    | |**RootWebOnly**
    |Optional **Boolean**. **TRUE** if the files specified in the module are installed only in the top-level website of the site collection.
    | |**SetupPath**
    | Optional **Text**. Specifies the physical path to a folder in the SharePoint Foundation setup directory %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE) that contains a file to include in the module.

    Can only contain the following characters:
    alphanumeric
    hyphen (**-**)
    underscore (**\_**)
    period (**.**)
    space ( )
    | -|**Url**
    | Optional **Text**. Specifies the virtual path of the folder in which to place the files when a site is instantiated. If **Path** is not specified, the value of **Url** is used for the physical path. Use the **Url** attribute to provision a folder through the site definition.

    The **Url** attribute cannot contain the following characters:
    \"
    #
    %
    &
    \*
    :
    \<
    \>
    ?
    \\
    {
    }
    |
    ~
    \x7f
    | - +|**Url**
    | Optional **Text**. Specifies the virtual path of the folder in which to place the files when a site is instantiated. If **Path** is not specified, the value of **Url** is used for the physical path. Use the **Url** attribute to provision a folder through the site definition.

    The **Url** attribute cannot contain the following characters:
    \"
    #
    %
    &
    \*
    :
    \<
    \>
    ?
    \\
    {
    }
    \|
    ~
    \x7f
    | + ### Child elements - [File](file-element.md) - + ### Parent elements - [Modules](modules-element-site.md) - + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ### Remarks -A detailed **Module** element appears in a **Modules** element directly under the **Project** element of an `Onet.xml` file. Each such module is referenced by at least one other **Module** element that is in a **Configuration** element of the same file. - -The **Module** element specifies a file or collection of files and a location where the files are installed during site creation. If the file is a web part page, the module definition can specify which web parts should be included on the page. - +A detailed **Module** element appears in a **Modules** element directly under the **Project** element of an `Onet.xml` file. Each such module is referenced by at least one other **Module** element that is in a **Configuration** element of the same file. + +The **Module** element specifies a file or collection of files and a location where the files are installed during site creation. If the file is a web part page, the module definition can specify which web parts should be included on the page. + ## Example -The following example from [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx) defines the views and files to include within a module. - +The following example from [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx) defines the views and files to include within a module. + ```XML @@ -98,4 +97,3 @@ The following example from [Onet.xml](https://msdn.microsoft.com/library/b99d665 ## See also - [How to: Provision a File](https://msdn.microsoft.com/library/438d5a75-7f39-4fa9-a365-d86e8ba967b6%28Office.15%29.aspx) - diff --git a/docs/schema/modules-element-site.md b/docs/schema/modules-element-site.md index 2122bf950..48435f9a0 100644 --- a/docs/schema/modules-element-site.md +++ b/docs/schema/modules-element-site.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: @@ -17,9 +16,9 @@ description: Contains a collection of modules in the configuration of a site def # Modules element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Contains a collection of modules in the configuration of a site definition within [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx). - + +Contains a collection of modules in the configuration of a site definition within [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx). + ```XML @@ -31,22 +30,20 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes -None - +None + ### Child elements - [Module](module-element-site.md) - + ### Parent elements - [Configuration](configuration-element-site.md) - [Project](project-element-site.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - -
    - +- Maximum: 1 +
    diff --git a/docs/schema/modules.md b/docs/schema/modules.md index 947d13036..fd5c98723 100644 --- a/docs/schema/modules.md +++ b/docs/schema/modules.md @@ -1,15 +1,15 @@ --- title: Modules +description: This article describes Modules and provides examples and links to related information. manager: soliver -ms.date: 12/7/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4f43e194-322e-4eca-9c96-8ad9f13818bd --- -# Modules +# Modules **Applies to**: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 @@ -91,11 +91,3 @@ The next example registers a Feature that includes two files and that specifies - [Module](https://msdn.microsoft.com/library/e5eeed6e-d785-496d-82b5-08d153588045(Office.15).aspx) - [How to: Provision a File](https://msdn.microsoft.com/library/438d5a75-7f39-4fa9-a365-d86e8ba967b6(Office.15).aspx) - - - - - - - - diff --git a/docs/schema/month-element-query.md b/docs/schema/month-element-query.md index bc8df180a..0af63e1e9 100644 --- a/docs/schema/month-element-query.md +++ b/docs/schema/month-element-query.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Query schema api_type: - schema ms.assetid: ff0c7293-6426-4a70-9267-ee504baebc9e -description: In CAML, used in the DateRangesOverlap element to retrieve from a calendar all instances of a recurring event that occur within a month. +description: In CAML, used in the DateRangesOverlap element to retrieve from a calendar all instances of a recurring event that occur within a month. --- # Month element (Query) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Used in the [DateRangesOverlap](daterangesoverlap-element-query.md) element to retrieve from a calendar all instances of a recurring event that occur within a month. - + +Used in the [DateRangesOverlap](daterangesoverlap-element-query.md) element to retrieve from a calendar all instances of a recurring event that occur within a month. + ```XML @@ -38,22 +37,21 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [Value](value-element-query.md) - + ### Occurrences -- Minimum: 0 +- Minimum: 0 - Maximum: Unbounded - + ## See also - [Now element (Query)](now-element-query.md) - [Today element (Query)](today-element-query.md) - diff --git a/docs/schema/month-element-regional-settings.md b/docs/schema/month-element-regional-settings.md index 2a4ebfc04..953027cd4 100644 --- a/docs/schema/month-element-regional-settings.md +++ b/docs/schema/month-element-regional-settings.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Regional Settings schema api_type: - schema ms.assetid: 16a6ccc7-5d5e-4703-a085-4e861e94dae8 -description: Used in TIMEZONE.XML to contain an integer representing the month in which standard time or daylight saving time begins for a time zone. +description: Used in TIMEZONE.XML to contain an integer representing the month in which standard time or daylight saving time begins for a time zone. --- # Month element (Regional Settings) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Used in TIMEZONE.XML (%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\CONFIG) to contain an integer representing the month in which standard time or daylight saving time begins for a time zone. If the **Month** element is empty outside the context of TIMEZONE.XML, such as in a view definition ([Schema.xml](https://msdn.microsoft.com/library/c2f01064-80d8-47ee-b602-ecf4c480ac56%28Office.15%29.aspx)), it returns the current month. - + ```XML @@ -32,27 +31,26 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: 1 (Unbounded outside TIMEZONE.XML) - +- Maximum: 1 (Unbounded outside TIMEZONE.XML) + ### Remarks For an example that shows how to use the **Month** element, see [StandardTime element (Regional Settings)](standardtime-element-regional-settings.md). - + ## See also -- [Date element (Regional Settings)](date-element-regional-settings.md) -- [Day element (Regional Settings)](day-element-regional-settings.md) +- [Date element (Regional Settings)](date-element-regional-settings.md) +- [Day element (Regional Settings)](day-element-regional-settings.md) - [Hour element (Regional Settings)](hour-element-regional-settings.md) - diff --git a/docs/schema/more-element-view.md b/docs/schema/more-element-view.md index a88386010..e6bc14fcb 100644 --- a/docs/schema/more-element-view.md +++ b/docs/schema/more-element-view.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: @@ -17,9 +16,9 @@ description: Allows additional properties to be set when a limit is applied to t # More element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Allows additional properties to be set when a limit is applied to text. - + ```XML @@ -32,20 +31,18 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -Numerous - +Numerous + ### Parent elements - [Limit](limit-element-view.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - -
    - +- Maximum: 1 +
    diff --git a/docs/schema/mrusplitbutton-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/mrusplitbutton-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index 8f57011b3..9c3cf4f2a 100644 --- a/docs/schema/mrusplitbutton-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/mrusplitbutton-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,24 +1,24 @@ --- title: MRUSplitButton element (CommandUIDefinitionType complexType) +description: Describes the definition, element, and attribute information for the MRUSplitButton element (CommandUIDefinitionType complexType). manager: soliver -ms.date: 9/16/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b100cec4-2d26-e763-3eb7-df5c1523985d --- -# MRUSplitButton element (CommandUIDefinitionType complexType) +# MRUSplitButton element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +|Information|Location| |---|---| | **Element type** | MRUSplitButtonType | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | @@ -59,26 +59,18 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements None. -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/mrusplitbutton-element.md b/docs/schema/mrusplitbutton-element.md index 5f87819f2..2544ce5a6 100644 --- a/docs/schema/mrusplitbutton-element.md +++ b/docs/schema/mrusplitbutton-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines a control that combines a button and a drop-down menu to di # MRUSplitButton element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a control that combines a button and a drop-down menu to display a list of the most-recently used items. - + ```XML |Optional. The keyword that is used by context-sensitive Help.
    | |**ToolTipSelectedItemTitle**
    |Optional. The title of the tooltip that appears for the selected item.
    | |**ToolTipShortcutKey**
    |Optional. The text to display for the shortcut key in the tooltip. For example, if the shortcut key for the control is Alt+J, the value for this attribute is "Alt+J". The tooltip will display the text for the shortcut key in parentheses after the tooltip title: "(Alt+J)".
    | - + ### Child elements - [Menu](menu-element.md) - + ### Parent elements - [CommandUIDefinition](commanduidefinition-element.md) -- [Controls](controls-element-group.md) - -### Occurrences +- [Controls](controls-element-group.md) -- Minimum: 0 -- Maximum: unbounded - +### Occurrences +- Minimum: 0 +- Maximum: unbounded diff --git a/docs/schema/name-element-baseinfo-complextypesps15xsdsearchset2.md b/docs/schema/name-element-baseinfo-complextypesps15xsdsearchset2.md index 690a3c961..29d70b9dd 100644 --- a/docs/schema/name-element-baseinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/name-element-baseinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Name element (BaseInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the Name element (BaseInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 28b3c301-4f46-cfd7-318c-006532a87fca -description: "Last modified: March 09, 2015" --- # Name element (BaseInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |xs:string
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/name-element-event.md b/docs/schema/name-element-event.md index 94b1f4f24..f2df02b1c 100644 --- a/docs/schema/name-element-event.md +++ b/docs/schema/name-element-event.md @@ -1,11 +1,11 @@ --- title: Name element (Event) +description: Describes the definition, element, and attribute information for the Name element (Event), which contains the name of the event receiver. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b9f80322-8412-4a01-a1b1-ea3ad1d2db27 --- @@ -64,11 +64,3 @@ None ## Example For an example of how this element is used, see [Event Registrations](event-registrations.md). - - - - - - - - diff --git a/docs/schema/name-element-propertyruleoperator-complextypesps15xsdsearchset2.md b/docs/schema/name-element-propertyruleoperator-complextypesps15xsdsearchset2.md index 1b9698887..0e5f55753 100644 --- a/docs/schema/name-element-propertyruleoperator-complextypesps15xsdsearchset2.md +++ b/docs/schema/name-element-propertyruleoperator-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Name element (PropertyRuleOperator complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the Name element (PropertyRuleOperator complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d604ec50-f997-7292-2eec-8ca539d2e11b -description: "Last modified: March 09, 2015" --- # Name element (PropertyRuleOperator complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |xs:string
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/name-element-resultitemtype-complextypesps15xsdsearchset2.md b/docs/schema/name-element-resultitemtype-complextypesps15xsdsearchset2.md index 571f7ca96..cc38b0ed2 100644 --- a/docs/schema/name-element-resultitemtype-complextypesps15xsdsearchset2.md +++ b/docs/schema/name-element-resultitemtype-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Name element (ResultItemType complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the Name element (ResultItemType complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a2d40c35-ca8c-5a1d-67b6-5549f4d2815c -description: "Last modified: March 09, 2015" --- # Name element (ResultItemType complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |xs:string
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/name-element-source-complextypesps15xsdsearchset1.md b/docs/schema/name-element-source-complextypesps15xsdsearchset1.md index 68422254e..80c067aeb 100644 --- a/docs/schema/name-element-source-complextypesps15xsdsearchset1.md +++ b/docs/schema/name-element-source-complextypesps15xsdsearchset1.md @@ -1,27 +1,26 @@ --- title: "Name element (Source complexType) (SPS15XSDSearchSet1)" +description: "Describes the definition, element, and attribute information for the Name element (Source complexType) (SPS15XSDSearchSet1)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: cfbd8224-2af9-f6f2-a162-334eb67c0667 -description: "Last modified: March 09, 2015" --- # Name element (Source complexType) (SPS15XSDSearchSet1) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |xs:string
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.Query.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/namedefinition-simpletype-sharepoint-add-in-manifest.md b/docs/schema/namedefinition-simpletype-sharepoint-add-in-manifest.md index 550af67fd..26b724850 100644 --- a/docs/schema/namedefinition-simpletype-sharepoint-add-in-manifest.md +++ b/docs/schema/namedefinition-simpletype-sharepoint-add-in-manifest.md @@ -1,15 +1,15 @@ --- title: NameDefinition simpleType +description: NameDefinition simpleType is the internal name of a SharePoint Add-in. It must be ASCII characters only, with no spaces, and up to 64 characters long. manager: soliver -ms.date: 9/17/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 37aba6e8-8291-d66a-b0bf-dded191ec131 --- -# NameDefinition simpleType +# NameDefinition simpleType (SharePoint Add-in Manifest) @@ -18,12 +18,12 @@ ms.assetid: 37aba6e8-8291-d66a-b0bf-dded191ec131 Internal name of an SharePoint Add-in. The internal name of an SharePoint Add-in. Must be ASCII characters only, with no spaces, up to 64 characters long. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +|Information|Location| |---|---| | **Base type** | xs:token | | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | @@ -32,11 +32,11 @@ only, with no spaces, up to 64 characters long. ## Definition ```XML  - + -``` \ No newline at end of file +``` diff --git a/docs/schema/namelsid-element-propertyruleoperator-complextypesps15xsdsearchset2.md b/docs/schema/namelsid-element-propertyruleoperator-complextypesps15xsdsearchset2.md index b2320e575..85138af6f 100644 --- a/docs/schema/namelsid-element-propertyruleoperator-complextypesps15xsdsearchset2.md +++ b/docs/schema/namelsid-element-propertyruleoperator-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "NameLSID element (PropertyRuleOperator complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the NameLSID element (PropertyRuleOperator complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1993dd62-6c1a-3f9a-af11-073f9d848d33 -description: "Last modified: March 09, 2015" --- # NameLSID element (PropertyRuleOperator complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |q4:LocStringId
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/navbar-element-site.md b/docs/schema/navbar-element-site.md index cd043ec05..c54e403be 100644 --- a/docs/schema/navbar-element-site.md +++ b/docs/schema/navbar-element-site.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: @@ -17,9 +16,9 @@ description: Contains the definition of the navigation area for either the top l # NavBar element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Contains the definition of the navigation area for either the top links of all pages within a site or for the Quick Launch area of the home page. - + ```XML |Optional **Text**. Specifies the separator to use between items in the navigation bar.
    | |**Suffix**
    |Optional **Text**. Contains the closing tag for the table that contains the navigation bar.
    | |**Url**
    |Optional **Text**.
    | - + ### Child elements - [NavBarLink](navbarlink-element-site.md) - [NavBarPage](navbarpage-element-sitemodule.md) - + ### Parent elements - [NavBars](navbars-element-site.md) - + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ## Example The following example defines the top navigation area of a home page. - + ```XML - - - - - ``` - - diff --git a/docs/schema/navbarlink-element-site.md b/docs/schema/navbarlink-element-site.md index 79ea39f66..8a69794bd 100644 --- a/docs/schema/navbarlink-element-site.md +++ b/docs/schema/navbarlink-element-site.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: @@ -17,9 +16,9 @@ description: Defines a hyperlink used in the top navigation area of a home page. # NavBarLink element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a hyperlink used in the top navigation area of a home page. - + ```XML |Required **Text**. Contains the text displayed for the hyperlink.
    | |**Url**
    |Required **Text**. Contains the URL for the hyperlink.
    | - + ### Child elements None - + ### Parent elements - [NavBar](navbar-element-site.md) - + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ## Example The following example specifies the links for the top navigation area of a home page. - + ```XML - - - - ``` - - diff --git a/docs/schema/navbarpage-element-module.md b/docs/schema/navbarpage-element-module.md index 6d282f952..4451299d1 100644 --- a/docs/schema/navbarpage-element-module.md +++ b/docs/schema/navbarpage-element-module.md @@ -1,11 +1,11 @@ --- title: NavBarPage element (Module) +decription: NavBarPage element (Module) provides information about the file specified as the home page in a module so that other pages can be linked to the page. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 749fc52f-df5a-4fe6-9aea-6f6a6f0edd73 --- @@ -100,9 +100,3 @@ None - [Modules](modules.md) - [Module](https://msdn.microsoft.com/library/e5eeed6e-d785-496d-82b5-08d153588045(Office.15).aspx) - [How to: Provision a File](https://msdn.microsoft.com/library/438d5a75-7f39-4fa9-a365-d86e8ba967b6(Office.15).aspx) - - - - - - diff --git a/docs/schema/navbarpage-element-sitemodule.md b/docs/schema/navbarpage-element-sitemodule.md index 37ff2a1dc..dbf09650b 100644 --- a/docs/schema/navbarpage-element-sitemodule.md +++ b/docs/schema/navbarpage-element-sitemodule.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: @@ -17,9 +16,9 @@ description: Provides information about the file specified as the home page in a # NavBarPage element (Site - Module) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Provides information about the file specified as the home page in a module so that other pages can be linked to the page. - + ```XML |Required **Integer**. Specifies the ID for the page.
    | |**Name**
    |Required **Text**. Specifies the text that appears in the navigation area of other pages that link to the page.
    | |**Position**
    | Optional **Text**. Specifies the position of the UI element represented by the **NavBarPage** element with respect to the top navigational area on a page.

    Possible values include the following:
    **Start** — add the node at the start (left/top in English) of the top navigational area.
    **End** — add the node to the end (right/bottom in English) of the top navigational area. Default.
    **Number between 1001 and 2000** — add the node after (right/below in English) another **NavBarPage** element whose ID matches the specified value.
    | - + ### Child elements -None - +None + ### Parent elements - [File](file-element.md) - + ### Occurrences - Minimum: 0 - Maximum: Unbounded - + ## Example -The following example uses the **NavBarPage** element to specify information about the home page in a module. - +The following example uses the **NavBarPage** element to specify information about the home page in a module. + ```XML @@ -81,4 +80,3 @@ The following example uses the **NavBarPage** element to specify information abo ## See also - [Module element (Site)](module-element-site.md) - diff --git a/docs/schema/navbarpage-element-sitenavbar.md b/docs/schema/navbarpage-element-sitenavbar.md index 52ae0efd5..0d7b3f0e5 100644 --- a/docs/schema/navbarpage-element-sitenavbar.md +++ b/docs/schema/navbarpage-element-sitenavbar.md @@ -1,23 +1,22 @@ --- title: "NavBarPage element (Site - NavBar)" +description: "Describes the definition, element, and attribute information for the NavBarPage element (Site - NavBar)." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: - schema ms.assetid: 2dd54346-63b3-4498-8217-8aaa07283ac3 -description: "Last modified: March 09, 2015" --- # NavBarPage element (Site - NavBar) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + ```XML |Required **Text**. Specifies the text that appears in the navigation area of other pages that link to the page.
    | |**Url**
    |Optional **Text**.
    | - + ### Child elements -None - +None + ### Parent elements - [NavBar](navbar-element-site.md) - + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - -
    - +- Maximum: Unbounded +
    diff --git a/docs/schema/navbars-element-site.md b/docs/schema/navbars-element-site.md index d0763ccac..6800f7220 100644 --- a/docs/schema/navbars-element-site.md +++ b/docs/schema/navbars-element-site.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: @@ -17,9 +16,9 @@ description: Contains the collection of links that appear in the top and left na # NavBars element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Contains the collection of links that appear in the top and left navigation areas of a home page. - + ```XML @@ -32,87 +31,85 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [NavBar](navbar-element-site.md) - + ### Parent elements - [Project](project-element-site.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ## Example -The following example from the file [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx) defines the default navigation areas for the home page. - +The following example from the file [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx) defines the default navigation areas for the home page. + ```XML - - - - - #LABEL#" Suffix="" ID="1004" /> - - - - ``` - - diff --git a/docs/schema/neq-element-query.md b/docs/schema/neq-element-query.md index 9c8927698..4ad8a65f2 100644 --- a/docs/schema/neq-element-query.md +++ b/docs/schema/neq-element-query.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Query schema api_type: @@ -17,9 +16,9 @@ description: In CAML, arithmetic operator that means "not equal to" and is used # Neq element (Query) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Arithmetic operator that means "not equal to" and is used in queries. - + ```XML @@ -35,29 +34,29 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [FieldRef](fieldref-element-query.md) - [Value](value-element-query.md) - [XML](xml-element.md) - + ### Parent elements - [And](and-element-query.md) - [Or](or-element-query.md) - [Where](where-element-query.md) - + ### Occurrences - Minimum: 0 - Maximum: Unbounded - + ## Example -The following example queries the Status field for cases where the value does not equal Completed or is **null**, returning the results according to a descending sort on the Modified field. The **Where** element contains an **Or** element to group the filters. - +The following example queries the Status field for cases where the value does not equal Completed or is **null**, returning the results according to a descending sort on the Modified field. The **Where** element contains an **Or** element to group the filters. + ```XML @@ -79,8 +78,7 @@ The following example queries the Status field for cases where the value does no ## See also -- [Eq element (Query)](eq-element-query.md) -- [Geq element (Query)](geq-element-query.md) -- [Gt element (Query)](gt-element-query.md) +- [Eq element (Query)](eq-element-query.md) +- [Geq element (Query)](geq-element-query.md) +- [Gt element (Query)](gt-element-query.md) - [Lt element (Query)](lt-element-query.md) - diff --git a/docs/schema/nestedinitiationfieldnodes-element-schemasource-elementdatasourcetype-complextyp.md b/docs/schema/nestedinitiationfieldnodes-element-schemasource-elementdatasourcetype-complextyp.md index d484bc285..191db54cf 100644 --- a/docs/schema/nestedinitiationfieldnodes-element-schemasource-elementdatasourcetype-complextyp.md +++ b/docs/schema/nestedinitiationfieldnodes-element-schemasource-elementdatasourcetype-complextyp.md @@ -1,15 +1,15 @@ --- title: NestedInitiationFieldNodes element +description: NestedInitiationFieldNodes element specifies that fields are retrieved from the schema of the data used to begin the workflow. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b39e8e21-490b-f498-1ac1-7d88f72532b9 --- -# NestedInitiationFieldNodes element +# NestedInitiationFieldNodes element (SchemaSource element) (dataSourceType complexType) (Action4) @@ -52,7 +52,7 @@ Specifies that fields are retrieved from the schema of the data used to begin th ```XML - + ``` ## Elements and attributes @@ -90,11 +90,3 @@ None. ### Attributes None. - - - - - - - - diff --git a/docs/schema/nestedinitiationfieldnodes-element-workflowactions.md b/docs/schema/nestedinitiationfieldnodes-element-workflowactions.md index db34932fa..5b1a98729 100644 --- a/docs/schema/nestedinitiationfieldnodes-element-workflowactions.md +++ b/docs/schema/nestedinitiationfieldnodes-element-workflowactions.md @@ -1,13 +1,13 @@ --- title: NestedInitiationFieldNodes element (WorkflowActions) +description: NestedInitiationFieldNodes element (WorkflowActions) specifies that fields are retrieved from the schema of the data used to begin the workflow. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 357bd163-dbed-49f3-8a4f-411cf1b2ff06 --- @@ -56,9 +56,3 @@ None - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - diff --git a/docs/schema/nestedinitiationfieldnodes-element-workflowinfo.md b/docs/schema/nestedinitiationfieldnodes-element-workflowinfo.md index 5ce266510..33def68fb 100644 --- a/docs/schema/nestedinitiationfieldnodes-element-workflowinfo.md +++ b/docs/schema/nestedinitiationfieldnodes-element-workflowinfo.md @@ -1,13 +1,13 @@ --- title: NestedInitiationFieldNodes element (WorkflowInfo) +description: NestedInitiationFieldNodes element (WorkflowInfo) specifies that fields are retrieved from the schema of the data used to begin the workflow. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f7e98365-4dfd-4d2c-98bf-5f61271b876e --- @@ -59,11 +59,3 @@ None - [Default Workflow Conditions](default-workflow-conditions-workflowinfo.md) - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - - - diff --git a/docs/schema/normalizedatetime-element-in-interpretation-bdcmetadata-schema.md b/docs/schema/normalizedatetime-element-in-interpretation-bdcmetadata-schema.md index 1fc27c9b0..6e088f3c2 100644 --- a/docs/schema/normalizedatetime-element-in-interpretation-bdcmetadata-schema.md +++ b/docs/schema/normalizedatetime-element-in-interpretation-bdcmetadata-schema.md @@ -1,15 +1,15 @@ --- title: NormalizeDateTime element in Interpretation +description: NormalizeDateTime element in Interpretation specifies the rule used to convert the representation of a date and time value to another representation. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: bbae3bfa-0754-d576-2bee-1ac0e8508a57 --- -# NormalizeDateTime element in Interpretation +# NormalizeDateTime element in Interpretation (BDCMetadata Schema) @@ -86,29 +86,6 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    Interpretation element in TypeDescriptor (BDCMetadata Schema)

    An **Interpretation** element that specifies the rules to apply to the data that is stored in the data structures represented by a **TypeDescriptor**.

    - - - - - - - - +|Element|Description| +|-------|-----------| +|[Interpretation element in TypeDescriptor (BDCMetadata Schema)](interpretation-element-in-typedescriptor-bdcmetadata-schema.md)|An **Interpretation** element that specifies the rules to apply to the data that is stored in the data structures represented by a **TypeDescriptor**.| diff --git a/docs/schema/notificationhandlerassembly-element-alert-templates.md b/docs/schema/notificationhandlerassembly-element-alert-templates.md index cc0e283df..4ac42dcd7 100644 --- a/docs/schema/notificationhandlerassembly-element-alert-templates.md +++ b/docs/schema/notificationhandlerassembly-element-alert-templates.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - AlertTemplates schema api_type: @@ -17,9 +16,9 @@ description: Specifies assembly information for an alert notification handler. # NotificationHandlerAssembly element (AlertTemplates) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies assembly information for an alert notification handler. - + ```XML @@ -32,15 +31,15 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [Properties](properties-element-alerttemplates.md) - + ## Example ```XML @@ -57,4 +56,3 @@ None ## See also - [UpdateHandlerAssembly element (AlertTemplates)](updatehandlerassembly-element-alerttemplates.md) - diff --git a/docs/schema/notificationhandlerclassname-element-alerttemplates.md b/docs/schema/notificationhandlerclassname-element-alerttemplates.md index 35156b528..ef38a38c5 100644 --- a/docs/schema/notificationhandlerclassname-element-alerttemplates.md +++ b/docs/schema/notificationhandlerclassname-element-alerttemplates.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - AlertTemplates schema api_type: @@ -17,9 +16,9 @@ description: Specifies a class name for an alert notification handler. # NotificationHandlerClassName element (AlertTemplates) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies a class name for an alert notification handler. - + ```XML @@ -32,15 +31,15 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [Properties](properties-element-alerttemplates.md) - + ## Example ```XML @@ -53,5 +52,3 @@ None ``` - - diff --git a/docs/schema/notincludes-element-query.md b/docs/schema/notincludes-element-query.md index fea8e9917..78b1cadfc 100644 --- a/docs/schema/notincludes-element-query.md +++ b/docs/schema/notincludes-element-query.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Query schema api_type: - schema ms.assetid: fab5013e-7283-42f5-b4a7-d614415ec05c -description: In CAML, if the specified field is a Lookup field that allows multiple values, specifies that the Value element is excluded from the list item for the field that is specified by the FieldRef element. +description: In CAML, if the specified field is a Lookup field that allows multiple values, specifies that the Value element is excluded from the list item for the field that is specified by the FieldRef element. --- # NotIncludes element (Query) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -If the specified field is a Lookup field that allows multiple values, specifies that the [Value](values-element-query.md) element is excluded from the list item for the field that is specified by the [FieldRef](fieldref-element-query.md) element. - + +If the specified field is a Lookup field that allows multiple values, specifies that the [Value](values-element-query.md) element is excluded from the list item for the field that is specified by the [FieldRef](fieldref-element-query.md) element. + ```XML @@ -35,22 +34,20 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [FieldRef](fieldref-element-query.md) - [Values](values-element-query.md) - [XML](xml-element.md) - + ### Parent elements - [And](and-element-query.md) - [Or](or-element-query.md) - [Where](where-element-query.md) - + ### Occurrences - Minimum: 0 - Maximum: Unbounded - - diff --git a/docs/schema/now-element-query.md b/docs/schema/now-element-query.md index 6bea55526..2eed9c7bb 100644 --- a/docs/schema/now-element-query.md +++ b/docs/schema/now-element-query.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Query schema api_type: @@ -17,9 +16,9 @@ description: In CAML, returns the current date and time. # Now element (Query) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Returns the current date and time. - + ```XML @@ -32,24 +31,24 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 - Maximum: Unbounded - + ## Example The following example queries for cases where a recurring event overlaps with the current date and time. - + ```XML @@ -68,6 +67,5 @@ The following example queries for cases where a recurring event overlaps with th ## See also - [TodayISO element](todayiso-element.md) -- [Month element (Regional Settings)](month-element-regional-settings.md) +- [Month element (Regional Settings)](month-element-regional-settings.md) - [Today element (Query)](today-element-query.md) - diff --git a/docs/schema/obpart-element-in-arrayofobpart-layoutdefinitions-schema.md b/docs/schema/obpart-element-in-arrayofobpart-layoutdefinitions-schema.md index f2ae7fc7f..effc2a34f 100644 --- a/docs/schema/obpart-element-in-arrayofobpart-layoutdefinitions-schema.md +++ b/docs/schema/obpart-element-in-arrayofobpart-layoutdefinitions-schema.md @@ -1,15 +1,15 @@ --- title: OBPart element in ArrayOfOBPart +description: Describes the definition, element, and attribute information for the OBPart element in ArrayOfOBPart, which specifies an External Data Part. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f50e24c6-674b-241f-5af6-1b6205be93be --- -# OBPart element in ArrayOfOBPart +# OBPart element in ArrayOfOBPart (LayoutDefinitions Schema) @@ -148,58 +148,15 @@ The following sections describe attributes, child elements, and parent elements. ### Child elements - ---- - - - - - - - - - - - - - - - - - - - - -

    Element

    Description

    CustomProperties element in UIElement (LayoutDefinitions Schema)

    The list of the custom properties of the Container or Office External Part.

    TitleBar element in OBPart (LayoutDefinitions Schema)

    The UI and behavior of the title bar of the Office External Part.

    ActionNames element in OBPart (LayoutDefinitions Schema)

    The actions that are exposed by this Office External Part.

    - -### Parent elements - - ---- - - - - - - - - - - - - -

    Element

    Description

    Children element in Container (LayoutDefinitions Schema)

    - - - - - +|Element|Description| +|-------|-----------| +|[CustomProperties element in UIElement (LayoutDefinitions Schema)](customproperties-element-in-uielement-layoutdefinitions-schema.md)|The list of the custom properties of the Container or Office External Part.| +|[TitleBar element in OBPart (LayoutDefinitions Schema)](titlebar-element-in-obpart-layoutdefinitions-schema.md)|The UI and behavior of the title bar of the Office External Part.| +|[ActionNames element in OBPart (LayoutDefinitions Schema)](actionnames-element-in-obpart-layoutdefinitions-schema.md)|The actions that are exposed by this Office External Part.| +### Parent elements +|Element|Description| +|-------|-----------| +|[Children element in Container (LayoutDefinitions Schema)](children-element-in-container-layoutdefinitions-schema.md)|| diff --git a/docs/schema/officeitemcustomizations-element-in-contextdefinition-solutionmanifestdefinition.md b/docs/schema/officeitemcustomizations-element-in-contextdefinition-solutionmanifestdefinition.md index a837ec445..db0709e61 100644 --- a/docs/schema/officeitemcustomizations-element-in-contextdefinition-solutionmanifestdefinition.md +++ b/docs/schema/officeitemcustomizations-element-in-contextdefinition-solutionmanifestdefinition.md @@ -1,15 +1,15 @@ --- title: OfficeItemCustomizations element in ContextDefinition +description: OfficeItemCustomizations element in ContextDefinition describes Microsoft Outlook-specific customizations. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 79c8b258-dbc7-37f2-7ff5-4ea58eb376ca --- -# OfficeItemCustomizations element in ContextDefinition +# OfficeItemCustomizations element in ContextDefinition (SolutionManifestDefinitions schema) @@ -31,25 +31,9 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes - ---- - - - - - - - - - - - - -

    Attribute

    Description

    **Description**

    Optional.

    -

    Attribute type: **String**

    +|Attribute|Description| +|---------|-----------| +|**Description**|Optional.
    Attribute type: **String**| ### Child elements @@ -57,33 +41,6 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    element

    Description

    ContextDefinition element in ContextDefinitionGroup (SolutionManifestDefinitions schema)

    - -
    - -
    - - - - - - - - +|Element|Description| +|-------|-----------| +|[ContextDefinition element in ContextDefinitionGroup (SolutionManifestDefinitions schema)](contextdefinition-element-in-contextdefinitiongroup-solutionmanifestdefinitions.md)|| diff --git a/docs/schema/officeitemproperties-element.md b/docs/schema/officeitemproperties-element.md index b19665357..fa229fdd1 100644 --- a/docs/schema/officeitemproperties-element.md +++ b/docs/schema/officeitemproperties-element.md @@ -1,11 +1,11 @@ --- title: OfficeItemProperties element +description: Describes the definition, element, and attribute information for the OfficeItemProperties element, which describes the fields of an external content type. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: e9509ca9-8dbe-48d9-b90a-bf0dd27fbb36 --- @@ -76,11 +76,3 @@ None.

    - - - - - - - - diff --git a/docs/schema/officeitemproperty-element.md b/docs/schema/officeitemproperty-element.md index e48bb78e7..08fa4f212 100644 --- a/docs/schema/officeitemproperty-element.md +++ b/docs/schema/officeitemproperty-element.md @@ -1,11 +1,11 @@ --- title: OfficeItemProperty element +description: OfficeItemProperty element describes how to display a field of an external content type in Microsoft Outlook 2010. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 12fd8fb9-91eb-4f23-89d6-2870fb9e30a8 --- @@ -20,7 +20,7 @@ Describes how to display a field of an external content type in Microsoft Outloo **Schema**: SolutionManifestDefinitions ```XML - ``` @@ -119,11 +119,3 @@ None.

    - - - - - - - - diff --git a/docs/schema/oktovote-element.md b/docs/schema/oktovote-element.md index e558a4577..05585e49e 100644 --- a/docs/schema/oktovote-element.md +++ b/docs/schema/oktovote-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: cb803116-b471-4893-87b8-d03ef0632b9c description: Used to determine whether a specific user can vote in a survey. --- @@ -13,9 +12,9 @@ description: Used to determine whether a specific user can vote in a survey. # OkToVote element **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Used to determine whether a specific user can vote in a survey. - + ```XML @@ -28,32 +27,32 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ### Remarks -This element requires that a **SetList** element be implemented for the appropriate survey; otherwise, the behavior of the **OkToVote** element is undefined. - -The **OkToVote** element renders as follows: - -- **0** — It is okay for the currently authenticated user to vote in the survey whose internal name is u_Survey. - -- **1** — The user cannot vote because u_Survey has no questions. - -- **2** — The user cannot vote because he or she has already voted in this survey. - -This element can be combined with a **Switch** statement to take actions, depending on the user's status in relation to a particular survey. - +This element requires that a **SetList** element be implemented for the appropriate survey; otherwise, the behavior of the **OkToVote** element is undefined. + +The **OkToVote** element renders as follows: + +- **0** — It is okay for the currently authenticated user to vote in the survey whose internal name is u_Survey. + +- **1** — The user cannot vote because u_Survey has no questions. + +- **2** — The user cannot vote because he or she has already voted in this survey. + +This element can be combined with a **Switch** statement to take actions, depending on the user's status in relation to a particular survey. +
    diff --git a/docs/schema/optimizeforfrequentuse-element-resultitemtype-complextypesps15xsdsearchset2.md b/docs/schema/optimizeforfrequentuse-element-resultitemtype-complextypesps15xsdsearchset2.md index 1951c1929..8176acbbb 100644 --- a/docs/schema/optimizeforfrequentuse-element-resultitemtype-complextypesps15xsdsearchset2.md +++ b/docs/schema/optimizeforfrequentuse-element-resultitemtype-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "OptimizeForFrequentUse element (ResultItemType complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the OptimizeForFrequentUse element (ResultItemType complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 65dbacd9-39b4-5c9e-2c7a-7a5a4991d329 -description: "Last modified: March 09, 2015" --- # OptimizeForFrequentUse element (ResultItemType complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |xs:boolean
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:boolean| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/option-element-fieldbind-elementruledesignertype-complextypeaction4.md b/docs/schema/option-element-fieldbind-elementruledesignertype-complextypeaction4.md index f81d487ec..b11eb4dc7 100644 --- a/docs/schema/option-element-fieldbind-elementruledesignertype-complextypeaction4.md +++ b/docs/schema/option-element-fieldbind-elementruledesignertype-complextypeaction4.md @@ -1,15 +1,15 @@ --- title: Option element +description: The Option element is used to populate DesignerType drop-down list box controls that are not data bound. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 72988312-4f49-08bd-e43d-09c5a6c15857 --- -# Option element +# Option element (FieldBind element) (ruleDesignerType complexType) (Action4) @@ -59,7 +59,7 @@ Used to populate **DesignerType** drop-down list box controls that are not data - + ``` ## Elements and attributes @@ -220,73 +220,66 @@ The following XML demonstrates how to construct an **Option** element so that it ```XML - ``` - - - - - - - diff --git a/docs/schema/option-element-workflowactions.md b/docs/schema/option-element-workflowactions.md index 55b818291..66643eeb5 100644 --- a/docs/schema/option-element-workflowactions.md +++ b/docs/schema/option-element-workflowactions.md @@ -1,13 +1,13 @@ --- title: Option Element (WorkflowActions) +description: The Option Element (WorkflowActions) is used to populate DesignerType drop-down list box controls that are not data bound. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5525a26e-ae81-42f1-84e1-97dfd7336360 --- @@ -161,64 +161,64 @@ The following XML demonstrates how to construct an **Option** element so that it ```XML - @@ -229,9 +229,3 @@ The following XML demonstrates how to construct an **Option** element so that it - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - diff --git a/docs/schema/option-element-workflowinfo.md b/docs/schema/option-element-workflowinfo.md index 8ee90bde0..ac5a0cbe4 100644 --- a/docs/schema/option-element-workflowinfo.md +++ b/docs/schema/option-element-workflowinfo.md @@ -1,13 +1,13 @@ --- title: Option Element (WorkflowInfo) +description: The Option Element (WorkflowInfo) is used to populate DesignerType drop-down list box controls that are not data bound. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c82dc727-b3e1-4c1b-80c4-a9d689795eaa --- @@ -159,64 +159,64 @@ The following XML demonstrates how to construct an **Option** element so that it ```XML - @@ -230,9 +230,3 @@ The following XML demonstrates how to construct an **Option** element so that it - [Default Workflow Conditions](default-workflow-conditions-workflowinfo.md) - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - diff --git a/docs/schema/or-element-query.md b/docs/schema/or-element-query.md index a786b87c0..8c6ddecae 100644 --- a/docs/schema/or-element-query.md +++ b/docs/schema/or-element-query.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Query schema api_type: - schema ms.assetid: a2e4f3fc-12b5-4fe3-a1ca-9a5c118479d3 -description: In CAML, used within the Where element to group filters in a query. +description: In CAML, used within the Where element to group filters in a query. --- # Or element (Query) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Used within the [Where](where-element-query.md) element to group filters in a query. - + +Used within the [Where](where-element-query.md) element to group filters in a query. + ```XML @@ -32,7 +31,7 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [And](and-element-query.md) @@ -52,26 +51,26 @@ None - [Neq](neq-element-query.md) - [NotIncludes](notincludes-element-query.md) - [Or](or-element-query.md) - + ### Parent elements - [And](and-element-query.md) - [Or](or-element-query.md) - [Where](where-element-query.md) - + ### Occurrences - Minimum: 0 - Maximum: Unbounded - + ### Remarks -This element can be nested inside other **Or** and [And](and-element-query.md) elements. The server supports unlimited complicated queries. However, any given **Or** element can have only two disjuncts; that is, only two child elements. If you need to disjoin three or more conditions, you must nest the **Or** elements, as demonstrated by the second example in the following section. - +This element can be nested inside other **Or** and [And](and-element-query.md) elements. The server supports unlimited complicated queries. However, any given **Or** element can have only two disjuncts; that is, only two child elements. If you need to disjoin three or more conditions, you must nest the **Or** elements, as demonstrated by the second example in the following section. + ## Examples The following example performs a query for cases in which values of the Status field either do not equal Completed or are **null**. The results are sorted in descending order according to the Modified field. - + ```XML @@ -93,8 +92,8 @@ The following example performs a query for cases in which values of the Status f
    -The following example shows how to disjoin three conditions. Note that the first pair of conditions is within their own **Or** element, which is itself a condition of an outer **Or** element. - +The following example shows how to disjoin three conditions. Note that the first pair of conditions is within their own **Or** element, which is itself a condition of an outer **Or** element. + ```XML @@ -116,5 +115,3 @@ The following example shows how to disjoin three conditions. Note that the first
    - - diff --git a/docs/schema/orderby-element-query.md b/docs/schema/orderby-element-query.md index edd756316..d91a4ca52 100644 --- a/docs/schema/orderby-element-query.md +++ b/docs/schema/orderby-element-query.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Query schema api_type: - schema ms.assetid: 7a659d08-9060-41d1-9a1c-e5a61376f3ba -description: In CAML, determines the sort order for a query. The OrderBy element contains a group of FieldRef elements. +description: In CAML, determines the sort order for a query. The OrderBy element contains a group of FieldRef elements. --- # OrderBy element (Query) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Determines the sort order for a query. The **OrderBy** element contains a group of [FieldRef](fieldref-element-query.md) elements. - + +Determines the sort order for a query. The **OrderBy** element contains a group of [FieldRef](fieldref-element-query.md) elements. + ```XML |Optional **Boolean**.
    | |**UseIndexForOrderBy**
    |Optional **Boolean**.
    | - + ### Child elements - [FieldRef](fieldref-element-query.md) - + ### Parent elements - [Expr1](expr1-element-view.md) - [Expr2](expr2-element-view.md) - [Query](query-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ### Remarks -The order in which the fields appear is the order in which the fields are sorted. The value of the **Ascending** attribute in the [FieldRef](fieldref-element-list.md) element determines whether to sort in ascending order. - +The order in which the fields appear is the order in which the fields are sorted. The value of the **Ascending** attribute in the [FieldRef](fieldref-element-list.md) element determines whether to sort in ascending order. + ## Example The following example sorts the fields first in ascending order by the Newcomers field, next in descending order by Years, and finally in ascending order by Location. - + ```XML @@ -72,4 +71,3 @@ The following example sorts the fields first in ascending order by the Newcomers ```
    - diff --git a/docs/schema/other-sharepoint-schemas.md b/docs/schema/other-sharepoint-schemas.md index d3d3fba18..c6d0bb003 100644 --- a/docs/schema/other-sharepoint-schemas.md +++ b/docs/schema/other-sharepoint-schemas.md @@ -1,11 +1,11 @@ --- title: Other SharePoint schemas +description: This section provides schema reference documentation for additional SharePoint XML schemas. manager: soliver -ms.date: 9/18/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: overview -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: bf0e4b97-a47b-4c49-a336-6644925470f1 --- @@ -30,10 +30,3 @@ This section provides schema reference documentation for additional SharePoint X - [Upgrade Definition schema](upgrade-definition-schema.md) - [dsQueryResponse schema](dsqueryresponse-schema.md) - - - - - - - diff --git a/docs/schema/outlookfolder-element.md b/docs/schema/outlookfolder-element.md index 37233e854..e6ed5a37f 100644 --- a/docs/schema/outlookfolder-element.md +++ b/docs/schema/outlookfolder-element.md @@ -1,11 +1,11 @@ --- title: OutlookFolder Element +description: OutlookFolder Element describes the Microsoft Outlook 2010 folder that contains the external data. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c4b78ba3-f271-4d7a-9e7a-ed3ec809ae65 --- @@ -21,7 +21,7 @@ Describes the Microsoft Outlook 2010 folder that contains the external data. ```XML ``` @@ -170,11 +170,3 @@ The following sections describe attributes, child elements, and parent elements.

    - - - - - - - - diff --git a/docs/schema/outlookitemcustomizations-element.md b/docs/schema/outlookitemcustomizations-element.md index f4462e4d3..de09745d0 100644 --- a/docs/schema/outlookitemcustomizations-element.md +++ b/docs/schema/outlookitemcustomizations-element.md @@ -1,11 +1,11 @@ --- title: OutlookItemCustomizations Element +description: OutlookItemCustomizations Element describes how external data should appear in Microsoft Outlook 2010 and what other customizations you need in Outlook. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: bb7f173c-c9a8-4e71-94bf-743fed55378f --- @@ -20,7 +20,7 @@ Describes how external data should appear in Microsoft Outlook 2010 and what oth **Schema**: SolutionManifestDefinitions ```XML - ``` @@ -30,106 +30,23 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes - ---- - - - - - - - - - - - - - - - - - - - - -

    Attribute

    Description

    **ItemTypeDisplayName**

    The display name of the Outlook item type.

    -

    Required.

    -

    Attribute type: **String**

    **MessageClass**

    Used to identify the form used to display the item. It follows the format: `IPM..`.

    -

    Example: IPM.Contact.Customer

    -

    Required.

    -

    Attribute type: **String**

    **Description**

    A description for the customizations.

    -

    Optional.

    -

    Attribute type: **String**

    - -
    +|Attribute|Description| +|---------|-----------| +|**ItemTypeDisplayName**|The display name of the Outlook item type.

    Required.

    Attribute type: **String**| +|**MessageClass**|Used to identify the form used to display the item. It follows the format: IPM...

    Example: IPM.Contact.Customer

    Required

    Attribute type: **String**| +|**Description**|A description for the customizations.

    Optional.

    Attribute type: **String**| ### Child elements - ---- - - - - - - - - - - - - - - - - - - - - - - - - -

    Element

    Description

    **OfficeItemProperties**

    Used to describe the fields of an external content type.

    **FormRegions**

    Used to describe the properties of the form region used to display the external data.

    **OutlookFolder**

    Used to describe Outlook folder that contains the external data.

    **Picture**

    Used to describe the icon to use in Microsoft Outlook 2010.

    - -
    +|Element|Description| +|-------|-----------| +|**OfficeItemProperties**|Used to describe the fields of an external content type.| +|**FormRegions**|Used to describe the properties of the form region used to display the external data.| +|**OutlookFolder**|Used to describe Outlook folder that contains the external data.| +|**Picture**|Used to describe the icon to use in Microsoft Outlook 2010.| ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    **OfficeItemCustomizations**

    Describes Outlook-specific customizations.

    - -
    - -
    - - - - - - - - +|Element|Description| +|-------|-----------| +|**OfficeItemCustomizations**|Describes Outlook-specific customizations.| diff --git a/docs/schema/overflowarea-element.md b/docs/schema/overflowarea-element.md index 5aa2edf7d..eed5d9e7b 100644 --- a/docs/schema/overflowarea-element.md +++ b/docs/schema/overflowarea-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines an area where multiple controls can render as a list. # OverflowArea element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines an area where multiple controls can render as a list. - + ```XML | Optional. An enumeration value that determines how a control is rendered.
    **Small**. Renders as a small icon without label text.
    **Medium**. Renders as a 16-by-16-pixel icon with label text.
    **Large**. Renders as a 32-by-32-pixel icon with label text.
    **Menu**. Renders as a text-only menu item.
    **Menu16**. Renders as a menu item with a 16-by-16-pixel icon.
    **Menu32**. Renders as a menu item with a 32-by-32-pixel icon.
    | |**TemplateAlias**
    |Optional. A string that a control can reference in its own **TemplateAlias** attribute. The **TemplateAlias** attribute is used to size and position controls within a group when a template is applied to the group.
    | - + ### Child elements None - + ### Parent elements - [Row](row-element.md) - + ### Occurrences - Minimum: 0 -- Maximum: unbounded - - +- Maximum: unbounded diff --git a/docs/schema/overflowsection-element.md b/docs/schema/overflowsection-element.md index 19668f8c4..b73c967dc 100644 --- a/docs/schema/overflowsection-element.md +++ b/docs/schema/overflowsection-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines a section that can be created dynamically with a variable n # OverflowSection element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a section that can be created dynamically with a variable number of controls. - + ```XML |Optional. **TRUE** to render a divider at the start of the section.
    | |**TemplateAlias**
    |Optional. A string that a control can reference in its own **TemplateAlias** attribute. The **TemplateAlias** attribute is used to size and position controls within a group when a template is applied to the group.
    | |**Type**
    | Optional. An enumeration value that specifies the type of section.
    **OneRow**. The section renders with one row of controls.
    **TwoRow**. The section renders with two rows of controls.
    **ThreeRow**. The section renders with three rows of controls.
    | - + ### Child elements None - + ### Parent elements - [Layout](layout-element.md) - + ### Occurrences - Minimum: 0 -- Maximum: unbounded - - +- Maximum: unbounded diff --git a/docs/schema/override-mobile-document-viewer.md b/docs/schema/override-mobile-document-viewer.md index a838e30da..3781b9ba2 100644 --- a/docs/schema/override-mobile-document-viewer.md +++ b/docs/schema/override-mobile-document-viewer.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Mobile Document Viewer XML ms.assetid: 0a24e16c-c447-4851-a5f7-c4c7dbe98b06 @@ -15,9 +14,9 @@ description: Specifies an alternative URL to which a mobile device is redirected # Override element (Mobile Document Viewer) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies an alternative URL to which a mobile device is redirected when it can use an alternative viewer to open the files of the specified type. - + ```XML ``` @@ -33,21 +32,21 @@ The following sections describe attributes, child elements, and parent elements. |**FilePath**
    |The website-relative path to the request handler for devices that are capable of opening documents of the specified type in some other viewer.
    | |**AppendSourceUrl**
    |**True** if a source query ID should be appended to the URL of the handler; otherwise, **false**. The source query value is the path to the document.
    | |**OueryID**
    |An alternative query for the one that is specified in the parent \ element.
    | - + ### Child elements None - + ### Parent elements |**Element**|**Description**| |:-----|:-----| |[BrowserCondition](browsercondition-mobile-document-viewer.md)
    |Identifies a browser condition under which redirection to a page that hosts a viewer for a specified type of document is overridden because the browser can open documents of a specified type directly.
    | - + ## Example The following example shows this element in use. - + ```XML @@ -62,4 +61,3 @@ The following example shows this element in use. ## See also - [Developing Mobile Document Viewers](https://msdn.microsoft.com/library/acd5386d-7808-4fd8-843f-0a4ac9ddd6b0%28Office.15%29.aspx) - diff --git a/docs/schema/overrideinfo-complextype-sps15xsdsearchset2.md b/docs/schema/overrideinfo-complextype-sps15xsdsearchset2.md index e17c0ac71..9376425f2 100644 --- a/docs/schema/overrideinfo-complextype-sps15xsdsearchset2.md +++ b/docs/schema/overrideinfo-complextype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "OverrideInfo complexType (SPS15XSDSearchSet2)" +description: "Describes the definition, type, element, and attribute information for the OverrideInfo complexType (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 60c793ca-dd25-005a-f935-8725ad403ed7 -description: "Last modified: March 09, 2015" --- # OverrideInfo complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |tns:BaseInfo
    | - +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| +|**Extension base**|tns:BaseInfo| + ## Definition ```XML @@ -44,8 +43,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -56,9 +55,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[MappingsOverridden](mappingsoverridden-element-overrideinfo-complextypesps15xsdsearchset2.md)
    |xs:boolean
    || |[SchemaId](schemaid-element-overrideinfo-complextypesps15xsdsearchset2.md)
    |xs:int
    || |[TokenNormalization](tokennormalization-element-overrideinfo-complextypesps15xsdsearchset2.md)
    |xs:boolean
    || - + ### Attributes None. - - diff --git a/docs/schema/overrideinfo-element-sps15xsdsearchset2.md b/docs/schema/overrideinfo-element-sps15xsdsearchset2.md index f63f969aa..2c46bfce8 100644 --- a/docs/schema/overrideinfo-element-sps15xsdsearchset2.md +++ b/docs/schema/overrideinfo-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "OverrideInfo element (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the OverrideInfo element (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6d7d00fb-a4fb-f657-b745-0804dd8f0457 -description: "Last modified: March 09, 2015" --- # OverrideInfo element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:OverrideInfo
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:OverrideInfo| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/overrideinfocollection-complextype-sps15xsdsearchset2.md b/docs/schema/overrideinfocollection-complextype-sps15xsdsearchset2.md index de2336bb5..e79edd5df 100644 --- a/docs/schema/overrideinfocollection-complextype-sps15xsdsearchset2.md +++ b/docs/schema/overrideinfocollection-complextype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "OverrideInfoCollection complexType (SPS15XSDSearchSet2)" +description: "Describes the definition, type, element, and attribute information for the OverrideInfoCollection complexType (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1aadf191-a236-b357-9acb-0201a21c2bbc -description: "Last modified: March 09, 2015" --- # OverrideInfoCollection complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |tns:BaseInfoCollectionOfOverrideInfoTzWWwPjw
    | - +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| +|**Extension base**|tns:BaseInfoCollectionOfOverrideInfoTzWWwPjw| + ## Definition ```XML @@ -31,14 +30,12 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/overrideinfocollection-element-sps15xsdsearchset2.md b/docs/schema/overrideinfocollection-element-sps15xsdsearchset2.md index 82e86469b..92e5edf42 100644 --- a/docs/schema/overrideinfocollection-element-sps15xsdsearchset2.md +++ b/docs/schema/overrideinfocollection-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "OverrideInfoCollection element (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the OverrideInfoCollection element (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1188de30-bc0b-a3ed-c9cc-ef96b26d6d4a -description: "Last modified: March 09, 2015" --- # OverrideInfoCollection element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:OverrideInfoCollection
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:OverrideInfoCollection| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/overrides-element-searchschemaconfigurationsettings-complextypesps15xsdsearchset.md b/docs/schema/overrides-element-searchschemaconfigurationsettings-complextypesps15xsdsearchset.md index 469f370f5..175484985 100644 --- a/docs/schema/overrides-element-searchschemaconfigurationsettings-complextypesps15xsdsearchset.md +++ b/docs/schema/overrides-element-searchschemaconfigurationsettings-complextypesps15xsdsearchset.md @@ -1,27 +1,26 @@ --- title: "Overrides element (SearchSchemaConfigurationSettings complexType) (SPS15XSDSearchSet3)" +description: "Describes the definition, element, and attribute information for the Overrides element (SearchSchemaConfigurationSettings complexType) (SPS15XSDSearchSet3)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1f00644b-77b0-db0b-ce78-488a650bf777 -description: "Last modified: March 09, 2015" --- # Overrides element (SearchSchemaConfigurationSettings complexType) (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |q13:OverrideInfoCollection
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type**|q13:OverrideInfoCollection| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability| +|**Schema file**|schema_Microsoft.Office.Server.Search.Portability.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/owner-element-resultitemtype-complextypesps15xsdsearchset2.md b/docs/schema/owner-element-resultitemtype-complextypesps15xsdsearchset2.md index f17b97423..9cb30d80f 100644 --- a/docs/schema/owner-element-resultitemtype-complextypesps15xsdsearchset2.md +++ b/docs/schema/owner-element-resultitemtype-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Owner element (ResultItemType complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the Owner element (ResultItemType complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 14ee1c1b-906a-08a2-80c1-cd9eb32123da -description: "Last modified: March 09, 2015" --- # Owner element (ResultItemType complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SearchObjectOwner
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:SearchObjectOwner| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/owner-element-source-complextypesps15xsdsearchset1.md b/docs/schema/owner-element-source-complextypesps15xsdsearchset1.md index 5302f9379..8dc238c43 100644 --- a/docs/schema/owner-element-source-complextypesps15xsdsearchset1.md +++ b/docs/schema/owner-element-source-complextypesps15xsdsearchset1.md @@ -1,27 +1,26 @@ --- title: "Owner element (Source complexType) (SPS15XSDSearchSet1)" +description: "Describes the definition, element, and attribute information for the Owner element (Source complexType) (SPS15XSDSearchSet1)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d4a26487-611a-70b3-92e6-126bf5e0786e -description: "Last modified: March 09, 2015" --- # Owner element (Source complexType) (SPS15XSDSearchSet1) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |q2:SearchObjectOwner
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.Query.xsd
    | - +|**Element type**|q2:SearchObjectOwner| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.Query.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/pagedclientcallbackrowset-element-deploymentmanifestspview.md b/docs/schema/pagedclientcallbackrowset-element-deploymentmanifestspview.md index edfc320da..a89c37bb4 100644 --- a/docs/schema/pagedclientcallbackrowset-element-deploymentmanifestspview.md +++ b/docs/schema/pagedclientcallbackrowset-element-deploymentmanifestspview.md @@ -1,20 +1,19 @@ --- title: "PagedClientCallbackRowset element (DeploymentManifest - SPView)" +description: "PagedClientCallbackRowset element (DeploymentManifest - SPView) represents a row set returned from a callback to a paged client on an instance of a SharePoint view (SPView) object." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8bd99d11-95b5-4eb1-a8e4-e313deeec7a4 -description: "Last modified: March 09, 2015" --- # PagedClientCallbackRowset element (DeploymentManifest - SPView) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a row set returned from a callback to a paged client on an instance of a SharePoint view ([SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a row set returned from a callback to a paged client on an instance of a SharePoint view ([SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx)) object. ## Definition @@ -32,7 +31,7 @@ USAGE ## Type **xs:string** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -40,17 +39,16 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [View element (DeploymentManifest)](view-element-deploymentmanifest.md) - + ## See also - [SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/pagedclientcallbackrowset-element-deploymentmanifestspwebpart.md b/docs/schema/pagedclientcallbackrowset-element-deploymentmanifestspwebpart.md index 152743edd..0aae275e8 100644 --- a/docs/schema/pagedclientcallbackrowset-element-deploymentmanifestspwebpart.md +++ b/docs/schema/pagedclientcallbackrowset-element-deploymentmanifestspwebpart.md @@ -1,20 +1,19 @@ --- title: "PagedClientCallbackRowset element (DeploymentManifest - SPWebPart)" +description: "PagedClientCallbackRowset element (DeploymentManifest - SPWebPart) represents a row set returned from a callback to a paged client on an instance of SharePoint web part (WebPart) object." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7ce7e786-c712-4a8c-95bc-77be740c55f2 -description: "Last modified: March 09, 2015" --- # PagedClientCallbackRowset element (DeploymentManifest - SPWebPart) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a row set returned from a callback to a paged client on an instance of SharePoint web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a row set returned from a callback to a paged client on an instance of SharePoint web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)) object. ## Definition @@ -32,7 +31,7 @@ USAGE ## Type **xs:string** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -40,17 +39,16 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [WebPart element (DeploymentManifest)](webpart-element-deploymentmanifest.md) - + ## See also - [WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/pagedclientcallbackrowset-element-list.md b/docs/schema/pagedclientcallbackrowset-element-list.md index a4d8b4f18..42e36f7be 100644 --- a/docs/schema/pagedclientcallbackrowset-element-list.md +++ b/docs/schema/pagedclientcallbackrowset-element-list.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: @@ -17,8 +16,8 @@ description: Defines user interface elements to display for accessing subsequent # PagedClientCallbackRowset element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Defines user interface elements to display for accessing subsequent pages when the number of rows returned in a view surpasses the limit set by the [RowLimit](rowlimit-element-list.md) element. + +Defines user interface elements to display for accessing subsequent pages when the number of rows returned in a view surpasses the limit set by the [RowLimit](rowlimit-element-list.md) element. ```XML @@ -26,7 +25,7 @@ Defines user interface elements to display for accessing subsequent pages when t ``` > [!NOTE] -> Most standard Microsoft SharePoint Foundation 2010 list views ignore this element. For more information, see [XMLDefinition and CAML View Schema](https://msdn.microsoft.com/library/1845d203-4699-4b0e-a182-2d9998439922%28Office.15%29.aspx). +> Most standard Microsoft SharePoint Foundation 2010 list views ignore this element. For more information, see [XMLDefinition and CAML View Schema](https://msdn.microsoft.com/library/1845d203-4699-4b0e-a182-2d9998439922%28Office.15%29.aspx). ## Elements and attributes @@ -35,25 +34,25 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -Numerous - +Numerous + ### Parent elements - [View](view-element-list.md) - [ViewStyle](viewstyle-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ## Example -The following example uses the **PagedClientCallbackRowset** element to define a link for viewing more list data on the subsequent page. - +The following example uses the **PagedClientCallbackRowset** element to define a link for viewing more list data on the subsequent page. + ```XML ]]> @@ -84,6 +83,5 @@ The following example uses the **PagedClientCallbackRowset** element to define a ## See also -- [List Views](https://msdn.microsoft.com/library/43e6ba7e-eddb-418a-a570-c0815016fc17%28Office.15%29.aspx) +- [List Views](https://msdn.microsoft.com/library/43e6ba7e-eddb-418a-a570-c0815016fc17%28Office.15%29.aspx) - [XMLDefinition and CAML View Schema](https://msdn.microsoft.com/library/1845d203-4699-4b0e-a182-2d9998439922%28Office.15%29.aspx) - diff --git a/docs/schema/pagedrecurrencerowset-element-deploymentmanifestspview.md b/docs/schema/pagedrecurrencerowset-element-deploymentmanifestspview.md index fbe73d6a0..6a6d31175 100644 --- a/docs/schema/pagedrecurrencerowset-element-deploymentmanifestspview.md +++ b/docs/schema/pagedrecurrencerowset-element-deploymentmanifestspview.md @@ -1,20 +1,19 @@ --- title: "PagedRecurrenceRowset element (DeploymentManifest - SPView)" +description: "PagedRecurrenceRowset element (DeploymentManifest - SPView) represents a row set returned from a paged recurrence on a SharePoint view (SPView) object." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 53a0de25-b57c-4f55-b508-75c38dac199d -description: "Last modified: March 09, 2015" --- # PagedRecurrenceRowset element (DeploymentManifest - SPView) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a row set returned from a paged recurrence on a SharePoint view ([SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a row set returned from a paged recurrence on a SharePoint view ([SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx)) object. ## Definition @@ -32,7 +31,7 @@ USAGE ## Type **xs:string** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -40,17 +39,16 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [View element (DeploymentManifest)](view-element-deploymentmanifest.md) - + ## See also - [SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/pagedrecurrencerowset-element-deploymentmanifestspwebpart.md b/docs/schema/pagedrecurrencerowset-element-deploymentmanifestspwebpart.md index 2e1383c64..8e9b17a8e 100644 --- a/docs/schema/pagedrecurrencerowset-element-deploymentmanifestspwebpart.md +++ b/docs/schema/pagedrecurrencerowset-element-deploymentmanifestspwebpart.md @@ -1,20 +1,19 @@ --- title: "PagedRecurrenceRowset element (DeploymentManifest - SPWebPart)" +description: "PagedRecurrenceRowset element (DeploymentManifest - SPWebPart) represents a row set returned from a paged recurrence on an instance of a SharePoint web part (WebPart) object." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5178c6d7-f7b2-4ccd-bb3a-18e43886b841 -description: "Last modified: March 09, 2015" --- # PagedRecurrenceRowset element (DeploymentManifest - SPWebPart) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a row set returned from a paged recurrence on an instance of a SharePoint web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a row set returned from a paged recurrence on an instance of a SharePoint web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)) object. ## Definition @@ -31,7 +30,7 @@ USAGE ## Type **xs:string** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -39,17 +38,16 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [WebPart element (DeploymentManifest)](webpart-element-deploymentmanifest.md) - + ## See also - [WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/pagedrecurrencerowset-element-list.md b/docs/schema/pagedrecurrencerowset-element-list.md index 82ca9fd01..08272314c 100644 --- a/docs/schema/pagedrecurrencerowset-element-list.md +++ b/docs/schema/pagedrecurrencerowset-element-list.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: @@ -17,11 +16,11 @@ description: Contains the definition of the page to display for a recurring item # PagedRecurrenceRowset element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Contains the definition of the page to display for a recurring item in an events list when the number of items in the recurrence surpasses the limit set by the [RowLimit](rowlimit-element-list.md) element. - + +Contains the definition of the page to display for a recurring item in an events list when the number of items in the recurrence surpasses the limit set by the [RowLimit](rowlimit-element-list.md) element. + Most standard Microsoft SharePoint Foundation 2010 list views ignore this element. For more information, see [XMLDefinition and CAML View Schema](https://msdn.microsoft.com/library/1845d203-4699-4b0e-a182-2d9998439922%28Office.15%29.aspx). - + ```XML @@ -34,25 +33,25 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [View](view-element-list.md) - [ViewStyle](viewstyle-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ## Example -The following example from the [Schema.xml](https://msdn.microsoft.com/library/c2f01064-80d8-47ee-b602-ecf4c480ac56%28Office.15%29.aspx) file for announcements lists defines how to display items when the number of items exceeds the value specified by the [RowLimit](rowlimit-element-list.md) element. - +The following example from the [Schema.xml](https://msdn.microsoft.com/library/c2f01064-80d8-47ee-b602-ecf4c480ac56%28Office.15%29.aspx) file for announcements lists defines how to display items when the number of items exceeds the value specified by the [RowLimit](rowlimit-element-list.md) element. + ```XML @@ -74,7 +73,7 @@ The following example from the [Schema.xml](https://msdn.microsoft.com/library/c ]]> <![CDATA[ Previous ]]> - <![CDATA[ @@ -103,7 +102,7 @@ The following example from the [Schema.xml](https://msdn.microsoft.com/library/c ]]> Next - @@ -84,7 +83,7 @@ The following example uses the **PagedRowset** element to display the string "(I ]]> Next - + @@ -90,5 +88,3 @@ The following example uses the **PageUrl** element to return the URL of the curr ]]> ``` - -
    diff --git a/docs/schema/parameter-element-coercionparameterstype-complextypeaction4.md b/docs/schema/parameter-element-coercionparameterstype-complextypeaction4.md index f170a3dad..3687f4d9d 100644 --- a/docs/schema/parameter-element-coercionparameterstype-complextypeaction4.md +++ b/docs/schema/parameter-element-coercionparameterstype-complextypeaction4.md @@ -5,8 +5,7 @@ manager: soliver ms.date: 01/27/2021 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f1952ebe-19b3-1bcf-9880-0ef3013e101b --- diff --git a/docs/schema/parameter-element-feature.md b/docs/schema/parameter-element-feature.md index f41940b51..b330385f2 100644 --- a/docs/schema/parameter-element-feature.md +++ b/docs/schema/parameter-element-feature.md @@ -1,11 +1,11 @@ --- title: Parameter Element (Feature) +description: Describes the Parameter element (Feature) and provides a definition and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d1778571-9dfb-461f-8688-996868bac2c6 --- @@ -18,7 +18,7 @@ Specifies the parameter to be applied during a Feature upgrade. ## Definition ```XML - ``` @@ -78,11 +78,3 @@ None - - - - - - - - diff --git a/docs/schema/parameter-element-in-parameters-bdcmetadata-schema.md b/docs/schema/parameter-element-in-parameters-bdcmetadata-schema.md index d773809cc..067965883 100644 --- a/docs/schema/parameter-element-in-parameters-bdcmetadata-schema.md +++ b/docs/schema/parameter-element-in-parameters-bdcmetadata-schema.md @@ -1,14 +1,13 @@ --- title: Parameter Element in Parameters (BDCMetadata Schema) -description: Details on the Parameter Element in Parameters (BDCMetadata Schema) +description: Describes the Parameter element in Parameters (BDCMetadata Schema) and provides the elements and attributes. manager: soliver -ms.date: 01/27/2021 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.Parameter -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 811cad0b-ba71-8be0-0765-3e0dec18a0d3 --- @@ -106,58 +105,16 @@ The following sections describe attributes, child elements, and parent elements. ### Child elements - ---- - - - - - - - - - - - - - - - - - - - - -

    Element

    Description

    LocalizedDisplayNames Element in MetadataObject (BDCMetadata Schema)

    The localized names of the parameter.

    Properties Element in MetadataObject (BDCMetadata Schema)

    The properties of the parameter.

    TypeDescriptor

    The root type descriptor of the parameter.

    - -### Parent elements - - ---- - - - - - - - - - - - - -

    Element

    Description

    Parameters Element in Method (BDCMetadata Schema)

    The **Parameters** element that contains this parameter.

    - - - - +| Element | Description | +| --- | --- | +| [LocalizedDisplayNames Element in MetadataObject (BDCMetadata Schema)](localizeddisplaynames-element-in-metadataobject-bdcmetadata-schema.md) | The localized names of the parameter. | +| [Properties Element in MetadataObject (BDCMetadata Schema)](properties-element-in-metadataobject-bdcmetadata-schema.md) | The properties of the parameter. | +| [TypeDescriptor](typedescriptor-element-bdcmetadata-schema.md) | The root type descriptor of the parameter. | +### Parent elements +| Element | Description | +| --- | --- | +| [Parameters Element in Method (BDCMetadata Schema)](parameters-element-in-method-bdcmetadata-schema.md) | The **Parameters** element that contains this parameter. | diff --git a/docs/schema/parameter-element-in-parameters-bdcmetadataresource-schema.md b/docs/schema/parameter-element-in-parameters-bdcmetadataresource-schema.md index f8f60dcfd..e5e564230 100644 --- a/docs/schema/parameter-element-in-parameters-bdcmetadataresource-schema.md +++ b/docs/schema/parameter-element-in-parameters-bdcmetadataresource-schema.md @@ -1,12 +1,11 @@ --- title: Parameter Element in Parameters (BDCMetadataResource Schema) -description: Details on the Parameter Element in Parameters (BDCMetadataResource Schema) +description: Describes the Parameter element in Parameters (BDCMetadataResource Schema) and provides the elements and attributes. manager: soliver -ms.date: 01/27/2021 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 83463153-e2f4-a9bc-7fa0-edbee2947a91 --- @@ -34,51 +33,14 @@ None. ### Child elements - --- - - - - - - - - - - - - - - - - -

    Element

    LocalizedDisplayNames Element in MetadataObject (BDCMetadataResource Schema)

    Properties Element in MetadataObject (BDCMetadataResource Schema)

    TypeDescriptor Element in Parameter (BDCMetadataResource Schema)

    +| Element | +| --- | +| [LocalizedDisplayNames Element in MetadataObject (BDCMetadataResource Schema)](localizeddisplaynames-element-in-metadataobject-bdcmetadataresource-schema.md) | +| [Properties Element in MetadataObject (BDCMetadataResource Schema)](properties-element-in-metadataobject-bdcmetadataresource-schema.md) | +| [TypeDescriptor Element in Parameter (BDCMetadataResource Schema)](typedescriptor-element-in-parameter-bdcmetadataresource-schema.md) | ### Parent elements - --- - - - - - - - - - - -

    Element

    Parameters Element in Method (BDCMetadataResource Schema)

    - - - - - - - - - +| Element | +| --- | +| [Parameters Element in Method (BDCMetadataResource Schema)](parameters-element-in-method-bdcmetadataresource-schema.md) | diff --git a/docs/schema/parameter-element-parameterstype-complextypeaction4.md b/docs/schema/parameter-element-parameterstype-complextypeaction4.md index 331d9a774..8eb5bfe94 100644 --- a/docs/schema/parameter-element-parameterstype-complextypeaction4.md +++ b/docs/schema/parameter-element-parameterstype-complextypeaction4.md @@ -5,8 +5,7 @@ manager: soliver ms.date: 01/27/2021 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1a694945-69a8-57b5-c3aa-f8c2edca165c --- diff --git a/docs/schema/parameter-element-workflowactions.md b/docs/schema/parameter-element-workflowactions.md index 0bd9d598d..1e5e5029a 100644 --- a/docs/schema/parameter-element-workflowactions.md +++ b/docs/schema/parameter-element-workflowactions.md @@ -1,13 +1,13 @@ --- title: Parameter Element (WorkflowActions) +description: Describes the Parameter element (WorkflowActions) and provides a definition and the elements and attributes. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 29d78788-1ef1-4cd7-a07d-43b6952839ec --- @@ -222,10 +222,3 @@ None - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - - diff --git a/docs/schema/parameter-element-workflowconfig.md b/docs/schema/parameter-element-workflowconfig.md index 59ae3d3df..d7f1ac78c 100644 --- a/docs/schema/parameter-element-workflowconfig.md +++ b/docs/schema/parameter-element-workflowconfig.md @@ -1,13 +1,13 @@ --- title: Parameter Element (WorkflowConfig) +description: Describes the Parameter element (WorkflowConfig) and provides a definition, the elements and attributes, and an example. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 3d043e89-5b01-41bb-a5ca-541041466d5a --- @@ -20,9 +20,9 @@ Represents a single parameter for the workflow initiation form. ## Definition ```XML - ``` @@ -71,16 +71,9 @@ The following sections describe attributes, child elements, and parent elements. ### Parent elements - --- - - - - - -

    Parameters Element (WorkflowConfig)

    +|Element| +|---| +|[Parameters Element (WorkflowConfig)](parameters-element-workflowconfig.md)| ### Remarks @@ -101,13 +94,13 @@ The element also contains a Fields element, which in turn contains a Field eleme This example has been edited for clarity. ```XML - - Standard review of new documents @@ -125,9 +118,3 @@ This example has been edited for clarity. - [Workflow Development for Windows SharePoint Services](https://msdn.microsoft.com/library/office/ms414613.aspx) - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Office SharePoint Designer Overview](https://msdn.microsoft.com/library/office/ms454098.aspx) - - - - - - diff --git a/docs/schema/parameter-element-workflowinfo.md b/docs/schema/parameter-element-workflowinfo.md index 28c6add17..84d0edbd0 100644 --- a/docs/schema/parameter-element-workflowinfo.md +++ b/docs/schema/parameter-element-workflowinfo.md @@ -1,13 +1,13 @@ --- title: Parameter Element (WorkflowInfo) +description: Describes the Parameter element (WorkflowInfo) and provides a definition, the elements and attributes, and an example. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: dd8766fd-0424-4f88-a8ce-8466fc178bce --- @@ -278,6 +278,3 @@ The following example demonstrates how to construct a **Parameter** element so t - [Default Workflow Conditions](default-workflow-conditions-workflowinfo.md) - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - diff --git a/docs/schema/parameterbinding-element-list.md b/docs/schema/parameterbinding-element-list.md index 26fc4aba0..a1888f9a7 100644 --- a/docs/schema/parameterbinding-element-list.md +++ b/docs/schema/parameterbinding-element-list.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: - schema ms.assetid: 71f578c2-6343-4d8d-a251-739f8f53bf07 -description: Specifies a stylesheet parameter binding to make a resource available to the XSL that renders the view. +description: Specifies a stylesheet parameter binding to make a resource available to the XSL that renders the view. --- # ParameterBinding element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Specifies a stylesheet parameter binding to make a resource available to the XSL that renders the view. - + +Specifies a stylesheet parameter binding to make a resource available to the XSL that renders the view. + ```vb ``` @@ -37,7 +36,7 @@ The following sections describe attributes, child elements, and parent elements. In addition to specifying a localized resource in a .resx file, the **Location** attribute can be used to specify the values indicated in the following table. -#### Location attribute values +#### Location attribute values |**Context**|**Format**| |:-----|:-----| @@ -50,20 +49,19 @@ In addition to specifying a localized resource in a .resx file, the **Location** ### Child elements None - + ### Parent elements - [ParameterBindings](parameterbindings-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ## See also - [XSLT Parameter Bindings](https://msdn.microsoft.com/library/0e63af9c-c94b-4425-8b93-989dad1dd49d%28Office.15%29.aspx) -- [XSLT Global Parameters](https://msdn.microsoft.com/library/13abde86-c820-42bd-863a-c9c8829255a6%28Office.15%29.aspx) -- [How to: Implement Resources in Custom List Views](https://msdn.microsoft.com/library/f8a01a0b-0538-4c4a-b2af-30c3f7f1ff4b%28Office.15%29.aspx) +- [XSLT Global Parameters](https://msdn.microsoft.com/library/13abde86-c820-42bd-863a-c9c8829255a6%28Office.15%29.aspx) +- [How to: Implement Resources in Custom List Views](https://msdn.microsoft.com/library/f8a01a0b-0538-4c4a-b2af-30c3f7f1ff4b%28Office.15%29.aspx) - [List Views](https://msdn.microsoft.com/library/43e6ba7e-eddb-418a-a570-c0815016fc17%28Office.15%29.aspx) - diff --git a/docs/schema/parameterbindings-element-list.md b/docs/schema/parameterbindings-element-list.md index 69afcd177..3c03ecd11 100644 --- a/docs/schema/parameterbindings-element-list.md +++ b/docs/schema/parameterbindings-element-list.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: @@ -17,9 +16,9 @@ description: Contains a collection of stylesheet parameter bindings to make info # ParameterBindings element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Contains a collection of stylesheet parameter bindings to make information available to the XSL that renders the view. - + ```vb ``` @@ -31,28 +30,27 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [ParameterBinding](parameterbinding-element-list.md) - + ### Parent elements - [View](view-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ### Remarks For information about how to use this element, see [XSLT Parameter Bindings](https://msdn.microsoft.com/library/0e63af9c-c94b-4425-8b93-989dad1dd49d%28Office.15%29.aspx). - + ## See also - [XSLT Parameter Bindings](https://msdn.microsoft.com/library/0e63af9c-c94b-4425-8b93-989dad1dd49d%28Office.15%29.aspx) -- [XSLT Global Parameters](https://msdn.microsoft.com/library/13abde86-c820-42bd-863a-c9c8829255a6%28Office.15%29.aspx) -- [How to: Implement Resources in Custom List Views](https://msdn.microsoft.com/library/f8a01a0b-0538-4c4a-b2af-30c3f7f1ff4b%28Office.15%29.aspx) +- [XSLT Global Parameters](https://msdn.microsoft.com/library/13abde86-c820-42bd-863a-c9c8829255a6%28Office.15%29.aspx) +- [How to: Implement Resources in Custom List Views](https://msdn.microsoft.com/library/f8a01a0b-0538-4c4a-b2af-30c3f7f1ff4b%28Office.15%29.aspx) - [List Views](https://msdn.microsoft.com/library/43e6ba7e-eddb-418a-a570-c0815016fc17%28Office.15%29.aspx) - diff --git a/docs/schema/parameters-element-action-elementactions-elementworkflowinfo-elementaction4.md b/docs/schema/parameters-element-action-elementactions-elementworkflowinfo-elementaction4.md index 14bca00a1..a496392eb 100644 --- a/docs/schema/parameters-element-action-elementactions-elementworkflowinfo-elementaction4.md +++ b/docs/schema/parameters-element-action-elementactions-elementworkflowinfo-elementaction4.md @@ -1,15 +1,15 @@ --- title: Parameters element (Action element) +description: Describes the Parameters element (Action element) and provides the usage, the element information, a definition, and the elements and attributes. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d262c2e2-9bd5-c394-0a7d-d30e93160a43 --- -# Parameters element (Action element) +# Parameters element (Action element) (Actions element) (WorkflowInfo element) (Action4) @@ -56,7 +56,7 @@ Container for **Parameter** elements that includes descriptions of the parameter ```XML - + ``` ## Elements and attributes @@ -114,11 +114,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** ### Attributes None. - - - - - - - - diff --git a/docs/schema/parameters-element-coercion-elementcoercions-elementworkflowinfo-elementaction4.md b/docs/schema/parameters-element-coercion-elementcoercions-elementworkflowinfo-elementaction4.md index 630bfb105..8ca023a60 100644 --- a/docs/schema/parameters-element-coercion-elementcoercions-elementworkflowinfo-elementaction4.md +++ b/docs/schema/parameters-element-coercion-elementcoercions-elementworkflowinfo-elementaction4.md @@ -1,15 +1,15 @@ --- title: Parameters element (Coercion element) +description: Describes the Parameters element (Coercion element) and provides the usage, the element information, a definition, and the elements and attributes. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: e7990cac-8f21-2881-3428-3aa9866d666e --- -# Parameters element (Coercion element) +# Parameters element (Coercion element) (Coercions element) (WorkflowInfo element) (Action4) @@ -56,7 +56,7 @@ Container for **Parameter** elements that includes descriptions of the parameter ```XML - + ``` ## Elements and attributes @@ -114,11 +114,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** ### Attributes None. - - - - - - - - diff --git a/docs/schema/parameters-element-condition-elementconditions-elementworkflowinfo-elementaction.md b/docs/schema/parameters-element-condition-elementconditions-elementworkflowinfo-elementaction.md index 745fef0ce..b6d724cbe 100644 --- a/docs/schema/parameters-element-condition-elementconditions-elementworkflowinfo-elementaction.md +++ b/docs/schema/parameters-element-condition-elementconditions-elementworkflowinfo-elementaction.md @@ -1,15 +1,15 @@ --- title: Parameters element (Condition element) +description: Describes the Parameters element (Condition element) and provides the usage, the element information, a definition, the elements and attributes, and an example. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 634793ca-8e14-818d-1e5c-3dd2b7b1626d --- -# Parameters element (Condition element) +# Parameters element (Condition element) (Conditions element) (WorkflowInfo element) (Action4) @@ -28,7 +28,7 @@ Container for **Parameter** elements that includes descriptions of the parameter -``` +``` ## Element information @@ -57,7 +57,7 @@ Container for **Parameter** elements that includes descriptions of the parameter ```XML - + ``` ## Elements and attributes @@ -162,10 +162,3 @@ The following example demonstrates how to construct the **Parameters** element s ```
    - - - - - - - diff --git a/docs/schema/parameters-element-feature.md b/docs/schema/parameters-element-feature.md index e6c4fdef1..e4da98404 100644 --- a/docs/schema/parameters-element-feature.md +++ b/docs/schema/parameters-element-feature.md @@ -1,11 +1,11 @@ --- title: Parameters Element (Feature) +description: Describes the Parameters element (Feature) and provides a definition and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 87a46d01-d770-4b5c-9619-bf95ddfde200 --- @@ -18,7 +18,7 @@ Specifies the list of parameters to be applied during a Feature upgrade. ## Definition ```XML - + ``` @@ -70,11 +70,3 @@ None - - - - - - - - diff --git a/docs/schema/parameters-element-flow-elementflows-elementworkflowinfo-elementaction4.md b/docs/schema/parameters-element-flow-elementflows-elementworkflowinfo-elementaction4.md index 43bd4ed20..57431649c 100644 --- a/docs/schema/parameters-element-flow-elementflows-elementworkflowinfo-elementaction4.md +++ b/docs/schema/parameters-element-flow-elementflows-elementworkflowinfo-elementaction4.md @@ -1,15 +1,15 @@ --- title: Parameters element (Flow element) +description: Describes the Parameters element (Flow element) and provides the usage, the element information, a definition, and the elements and attributes. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 426b5695-1857-b535-6355-09701ef153bd --- -# Parameters element (Flow element) +# Parameters element (Flow element) (Flows element) (WorkflowInfo element) (Action4) @@ -57,7 +57,7 @@ Container for **Parameter** elements that includes descriptions of the parameter ```XML - + ``` ## Elements and attributes @@ -115,11 +115,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** ### Attributes None. - - - - - - - - diff --git a/docs/schema/parameters-element-in-actiondefinition-solutionmanifestdeclarativeextensions-sch.md b/docs/schema/parameters-element-in-actiondefinition-solutionmanifestdeclarativeextensions-sch.md index 4db5c4ce4..85c970c88 100644 --- a/docs/schema/parameters-element-in-actiondefinition-solutionmanifestdeclarativeextensions-sch.md +++ b/docs/schema/parameters-element-in-actiondefinition-solutionmanifestdeclarativeextensions-sch.md @@ -1,15 +1,15 @@ --- title: Parameters Element in ActionDefinition +description: Describes the Parameters element in ActionDefinition and provides the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 70ecf495-6f5d-abb5-c8cc-a3c88faf186b --- -# Parameters Element in ActionDefinition +# Parameters Element in ActionDefinition (SolutionManifestDeclarativeExtensions Schema) @@ -17,7 +17,7 @@ ms.assetid: 70ecf495-6f5d-abb5-c8cc-a3c88faf186b The **Parameters** element lists all the parameters that an action accepts. -**Namespace**: +**Namespace**: `http://schemas.microsoft.com/office/2009/05/BusinessApplications/Manifest/DeclarativeExtensions` **Schema**: SolutionManifestDeclarativeExtensions @@ -36,62 +36,19 @@ None. ### Child elements - ---- - - - - - - - - - - - - - - - - -

    Element

    Description

    ConstantParameter Element in ActionParameterDefinitions (SolutionManifestDeclarativeExtensions Schema)

    The **ConstantParameter** element defines a constant parameter for an action.

    ExpressionParameter Element in ActionParameterDefinitions (SolutionManifestDeclarativeExtensions Schema)

    The **ExpressionParameter** element defines a parameter for an action that can take a value from the context of the current item.

    +| Element | Description | +| --- | --- | +| [ConstantParameter Element in ActionParameterDefinitions (SolutionManifestDeclarativeExtensions Schema)](constantparameter-element-in-actionparameterdefinitions-solutionmanifestdeclarat.md) | The **ConstantParameter** element defines a constant parameter for an action. | +| [ExpressionParameter Element in ActionParameterDefinitions (SolutionManifestDeclarativeExtensions Schema)](expressionparameter-element-in-actionparameterdefinitions-solutionmanifestdeclar.md) | The **ExpressionParameter** element defines a parameter for an action that can take a value from the context of the current item. | ### Parent elements - ---- - - - - - - - - - - - - - - - - -

    Element

    Description

    UrlAction Element in Actions (SolutionManifestDeclarativeExtensions Schema)

    The **UrlAction** element is used to execute a URL-based action.

    CodeMethodAction Element in Actions (SolutionManifestDeclarativeExtensions Schema)

    The **CodeMethodAction** element is used to execute a custom code action or one of the predefined actions that are provided by Microsoft Business Connectivity Services (BCS).

    +| Element | Description | +| --- | --- | +| [UrlAction Element in Actions (SolutionManifestDeclarativeExtensions Schema)](urlaction-element-in-actions-solutionmanifestdeclarativeextensions-schema.md) | The **UrlAction** element is used to execute a URL-based action. | +| [CodeMethodAction Element in Actions (SolutionManifestDeclarativeExtensions Schema)](codemethodaction-element-in-actions-solutionmanifestdeclarativeextensions-schema.md) | The **CodeMethodAction** element is used to execute a custom code action or one of the predefined actions that are provided by Microsoft Business Connectivity Services (BCS). |

    - - - - - - - diff --git a/docs/schema/parameters-element-in-method-bdcmetadata-schema.md b/docs/schema/parameters-element-in-method-bdcmetadata-schema.md index 72ca09f6e..f5a0ed665 100644 --- a/docs/schema/parameters-element-in-method-bdcmetadata-schema.md +++ b/docs/schema/parameters-element-in-method-bdcmetadata-schema.md @@ -1,14 +1,13 @@ --- title: Parameters Element in Method (BDCMetadata Schema) -description: Details on the Parameters Element in Method (BDCMetadata Schema) +description: Describes the Parameters element in Method (BDCMetadata Schema) and provides the elements and attributes. manager: soliver -ms.date: 01/27/2021 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.Parameters -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 343f4c25-e122-1a4c-2b80-bb8f25e3cc82 --- @@ -36,50 +35,14 @@ None. ### Child elements - ---- - - - - - - - - - - - - -

    Element

    Description

    Parameter Element in Parameters (BDCMetadata Schema)

    A parameter.

    - -### Parent elements - - ---- - - - - - - - - - - - - -

    Element

    Description

    Method Element in Methods (BDCMetadata Schema)

    The method these parameters belong to.

    - - - - +| Element | Description | +| --- | --- | +| [Parameter Element in Parameters (BDCMetadata Schema)](parameter-element-in-parameters-bdcmetadata-schema.md) | A parameter. | +### Parent elements +| Element | Description | +| --- | --- | +| [Method Element in Methods (BDCMetadata Schema)](method-element-in-methods-bdcmetadata-schema.md) | The method these parameters belong to. | diff --git a/docs/schema/parameters-element-in-method-bdcmetadataresource-schema.md b/docs/schema/parameters-element-in-method-bdcmetadataresource-schema.md index 0e6a6eddf..1321f10e6 100644 --- a/docs/schema/parameters-element-in-method-bdcmetadataresource-schema.md +++ b/docs/schema/parameters-element-in-method-bdcmetadataresource-schema.md @@ -1,12 +1,11 @@ --- title: Parameters Element in Method (BDCMetadataResource Schema) -description: Details on the Parameters Element in Method (BDCMetadataResource Schema) +description: Describes the Parameters element in Method (BDCMetadataResource Schema) and provides the elements and attributes. manager: soliver -ms.date: 01/27/2021 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f7ce7810-f817-9560-6154-b4742a8cf162 --- @@ -34,44 +33,12 @@ None. ### Child elements - --- - - - - - - - - - - -

    Element

    Parameter Element in Parameters (BDCMetadataResource Schema)

    +| Element | +| --- | +| [Parameter Element in Parameters (BDCMetadataResource Schema)](parameter-element-in-parameters-bdcmetadataresource-schema.md) | ### Parent elements - --- - - - - - - - - - - -

    Element

    Method Element in Methods (BDCMetadataResource Schema)

    - - - - - - - - +| Element | +| --- | +| [Method Element in Methods (BDCMetadataResource Schema)](method-element-in-methods-bdcmetadataresource-schema.md) | diff --git a/docs/schema/parameters-element-workflowactions.md b/docs/schema/parameters-element-workflowactions.md index 799298750..9856d812b 100644 --- a/docs/schema/parameters-element-workflowactions.md +++ b/docs/schema/parameters-element-workflowactions.md @@ -1,13 +1,13 @@ --- title: Parameters Element (WorkflowActions) +description: Describes the Parameters element (WorkflowActions) and provides a definition and the elements and attributes. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5fe0a140-ab0b-4a03-8e44-36e8f4272132 --- @@ -67,8 +67,3 @@ None - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - diff --git a/docs/schema/parameters-element-workflowconfig.md b/docs/schema/parameters-element-workflowconfig.md index fcfe46240..cdbaf217f 100644 --- a/docs/schema/parameters-element-workflowconfig.md +++ b/docs/schema/parameters-element-workflowconfig.md @@ -1,13 +1,13 @@ --- title: Parameters Element (WorkflowConfig) +description: Describes the Parameters element (WorkflowConfig) and provides a definition, the elements and attributes, remarks, and an example. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 28c73384-447e-45ba-99a5-31ab32ee286a --- @@ -43,29 +43,15 @@ The following sections describe attributes, child elements, and parent elements. ### Child elements - --- - - - - - -

    Parameter Element (WorkflowConfig)

    +|Element| +|---| +|[Parameter Element (WorkflowConfig)](parameter-element-workflowconfig.md)| ### Parent elements - --- - - - - - -

    Initiation Element (WorkflowConfig)

    +|Element| +|---| +|[Initiation Element (WorkflowConfig)](initiation-element-workflowconfig.md)| ### Remarks @@ -87,13 +73,13 @@ The element also contains a Fields element, which in turn contains a Field eleme This example has been edited for clarity. ```XML - - Standard review of new documents @@ -111,11 +97,3 @@ This example has been edited for clarity. - [Workflow Development for Windows SharePoint Services](https://msdn.microsoft.com/library/office/ms414613.aspx) - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Office SharePoint Designer Overview](https://msdn.microsoft.com/library/office/ms454098.aspx) - - - - - - - - diff --git a/docs/schema/parameters-element-workflowinfo.md b/docs/schema/parameters-element-workflowinfo.md index bc4e092d8..aec9d8f32 100644 --- a/docs/schema/parameters-element-workflowinfo.md +++ b/docs/schema/parameters-element-workflowinfo.md @@ -1,13 +1,13 @@ --- title: Parameters Element (WorkflowInfo) +description: Describes the Parameters element (WorkflowInfo) and provides a definition, the elements and attributes, and an example. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 300b5383-cbdd-4a74-aaee-556c70dab65b --- @@ -124,9 +124,3 @@ The following example demonstrates how to construct the **Parameters** element s - [Default Workflow Conditions](default-workflow-conditions-workflowinfo.md) - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - diff --git a/docs/schema/parameterstype-complextype-action4.md b/docs/schema/parameterstype-complextype-action4.md index 7fd60e322..a486b5375 100644 --- a/docs/schema/parameterstype-complextype-action4.md +++ b/docs/schema/parameterstype-complextype-action4.md @@ -1,11 +1,11 @@ --- title: parametersType complexType (Action4) +description: Describes the parametersType complexType (Action4) and provides the type information, a definition, and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 35bb99bb-066d-0876-f257-4abeed4f4e04 --- @@ -54,7 +54,7 @@ Base type … xxxxxxxxxx. - + ``` @@ -90,11 +90,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** ### Attributes None. - - - - - - - - diff --git a/docs/schema/password-element-accountauthcredentials-complextypesps15xsdsearchset2.md b/docs/schema/password-element-accountauthcredentials-complextypesps15xsdsearchset2.md index 15702a367..a31098c3f 100644 --- a/docs/schema/password-element-accountauthcredentials-complextypesps15xsdsearchset2.md +++ b/docs/schema/password-element-accountauthcredentials-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Password element (AccountAuthCredentials complexType) (SPS15XSDSearchSet2)" +description: Describes the Password element (AccountAuthCredentials complexType) (SPS15XSDSearchSet2) and provides the element information, a definition, and the elements and attributes. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f53fe49d-6b40-643d-2660-4f06e0fb0914 -description: "Last modified: March 09, 2015" --- # Password element (AccountAuthCredentials complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Resource | File | |:-----|:-----| -|**Element type**
    |xs:string
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +| **Element type** |xs:string
    | +| **Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | +| **Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd
    | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/permissionset-element-solution.md b/docs/schema/permissionset-element-solution.md index d7337f328..022a327b0 100644 --- a/docs/schema/permissionset-element-solution.md +++ b/docs/schema/permissionset-element-solution.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Solution Schema api_type: @@ -17,9 +16,9 @@ description: Specifies the permissions for a solution's code access security pol # PermissionSet element (Solution) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies the permissions for a solution's code access security policy. - + ```XML |Optional **Text**. A description of the permission set.
    | |**Name**
    |Optional **Text**. The name of the permission set.
    | |**version**
    |Required **Text**. The version of the permission set.
    | - + ### Child elements - [IPermission](ipermission-element-solution.md) - + ### Parent elements - [PolicyItem](policyitem-element-solution.md) - + ## Example For an example of how this element is used, see [Solution schema](solution-schema.md). - - diff --git a/docs/schema/personalization-element-deploymentmanifest.md b/docs/schema/personalization-element-deploymentmanifest.md index 91833397e..a851fda42 100644 --- a/docs/schema/personalization-element-deploymentmanifest.md +++ b/docs/schema/personalization-element-deploymentmanifest.md @@ -1,28 +1,27 @@ --- title: "Personalization Element (DeploymentManifest)" +description: Describes the Personalization element (DeploymentManifest) and provides a definition, the type, and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: dc42dabd-68d3-4bba-bbe6-3e5571620ead -description: "Last modified: March 09, 2015" --- # Personalization Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents personalization data pertaining to an instance of a Windows SharePoint Services 3.0 file ([SPFile](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFile.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents personalization data pertaining to an instance of a Windows SharePoint Services 3.0 file ([SPFile](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFile.aspx)) object. ## Definition ```XML DECLARATION - USAGE @@ -41,7 +40,7 @@ USAGE ## Type **SPPersonalization** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -57,17 +56,16 @@ The following sections describe attributes, child elements, and parent elements. |**IsIncluded**
    |xs:string
    |Optional.
    | |**FrameState**
    |xs:string
    |Optional.
    | |**UserProperties**
    |xs:string
    |Optional.
    | - + ### Child elements None - + ### Parent elements [Personalizations Element (DeploymentManifest)](personalizations-element-deploymentmanifest.md) - + ## See also - [SPFile](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFile.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/personalizations-element-deploymentmanifest.md b/docs/schema/personalizations-element-deploymentmanifest.md index 8e96c8a25..ede5ccd83 100644 --- a/docs/schema/personalizations-element-deploymentmanifest.md +++ b/docs/schema/personalizations-element-deploymentmanifest.md @@ -1,28 +1,27 @@ --- title: "Personalizations Element (DeploymentManifest)" +description: Describes the Personalizations element (DeploymentManifest) and provides a definition, the type, and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a771f7ce-7108-4dc7-a14d-7f2e5ec59fe8 -description: "Last modified: March 09, 2015" --- # Personalizations Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a collection of personalization elements pertaining to an instance of a Windows SharePoint Services 3.0 file ([SPFile](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFile.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a collection of personalization elements pertaining to an instance of a Windows SharePoint Services 3.0 file ([SPFile](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFile.aspx)) object. ## Definition ```XML DECLARATION - USAGE @@ -36,7 +35,7 @@ USAGE ## Type **SPPersonalizationCollection** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -44,17 +43,16 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [Personalization Element (DeploymentManifest)](personalization-element-deploymentmanifest.md) - + ### Parent elements [File Element (DeploymentManifest - SPGenericObject)](file-element-deploymentmanifestspgenericobject.md) - + ## See also - [SPFile](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFile.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/picture-element-in-declarativeformregion-solutionmanifestdeclarativeextensions-s.md b/docs/schema/picture-element-in-declarativeformregion-solutionmanifestdeclarativeextensions-s.md index 2840ea9a3..f6f1becbf 100644 --- a/docs/schema/picture-element-in-declarativeformregion-solutionmanifestdeclarativeextensions-s.md +++ b/docs/schema/picture-element-in-declarativeformregion-solutionmanifestdeclarativeextensions-s.md @@ -1,15 +1,15 @@ --- title: Picture Element in DeclarativeFormRegion +description: Describes the Picture element in DeclarativeFormRegion and provides the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a8155b3f-7afd-ee92-af0d-64ac1452d539 --- -# Picture Element in DeclarativeFormRegion +# Picture Element in DeclarativeFormRegion (SolutionManifestDeclarativeExtensions Schema) @@ -17,7 +17,7 @@ ms.assetid: a8155b3f-7afd-ee92-af0d-64ac1452d539 The **Picture** element is used to describe the icon to use for a form region in Microsoft Outlook 2010. -**Namespace**: +**Namespace**: `http://schemas.microsoft.com/office/2009/05/BusinessApplications/Manifest/DeclarativeExtensions` **Schema**: SolutionManifestDeclarativeExtensions @@ -65,33 +65,10 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    DeclarativeFormRegion Element in DeclarativeFormRegions (SolutionManifestDeclarativeExtensions Schema)

    The form region that this picture is for.

    +| Element | Description | +| --- | --- | +| [DeclarativeFormRegion Element in DeclarativeFormRegions (SolutionManifestDeclarativeExtensions Schema)](declarativeformregion-element-in-declarativeformregions-solutionmanifestdeclarat.md) | The form region that this picture is for. |

    - - - - - - - - diff --git a/docs/schema/picture-element.md b/docs/schema/picture-element.md index 49168dc69..0f721bdc3 100644 --- a/docs/schema/picture-element.md +++ b/docs/schema/picture-element.md @@ -1,11 +1,11 @@ --- title: Picture Element +description: Describes the Picture element and provides the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 3ca1d9db-6066-46e4-921a-94f0756a6fc8 --- @@ -88,11 +88,3 @@ None.

    - - - - - - - - diff --git a/docs/schema/picturelibrary-element-deploymentmanifest.md b/docs/schema/picturelibrary-element-deploymentmanifest.md index de2b26ea4..a7931ae32 100644 --- a/docs/schema/picturelibrary-element-deploymentmanifest.md +++ b/docs/schema/picturelibrary-element-deploymentmanifest.md @@ -1,20 +1,19 @@ --- title: "PictureLibrary Element (DeploymentManifest)" +description: Describes the PictureLibrary element (DeploymentManifest) and provides a definition, type, the elements and attributes, and remarks. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 34d26579-a495-4442-8fff-834a36b6255d -description: "Last modified: March 09, 2015" --- # PictureLibrary Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents an instance of a Windows SharePoint Services 3.0 picture library ([SPPictureLibrary](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPPictureLibrary.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents an instance of a Windows SharePoint Services 3.0 picture library ([SPPictureLibrary](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPPictureLibrary.aspx)) object. ## Definition @@ -35,8 +34,8 @@ USAGE ## Type -[SPPictureLibrary](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPPictureLibrary.aspx) object - +[SPPictureLibrary](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPPictureLibrary.aspx) object + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -48,25 +47,24 @@ The following sections describe attributes, child elements, and parent elements. |**ThumbnailSize**
    |xs:int
    |Optional. Specifies the size, in pixels, of the height or width, whichever is greatest, to use for the thumnails in the picture library.
    | |**WebImageHeight**
    |xs:int
    |Optional. Specifies the height, in pixels, used to display images in the picture library.
    | |**WebImageWidth**
    |xs:int
    |Optional. Specifies the width, in pixels, used to display images in the picture library.
    | - + ### Child elements None - + ### Parent elements [SPObject Element (DeploymentManifest)](spobject-element-deploymentmanifest.md) - + ### Remarks -The base type [Microsoft.SharePoint.SPPictureLibrary](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPPictureLibrary.aspx) extends another base type, [Microsoft.SharePoint.SPDocumentLibrary](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPDocumentLibrary.aspx). That type, in turn, extends the [Microsoft.SharePoint.SPList](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPList.aspx) type. - +The base type [Microsoft.SharePoint.SPPictureLibrary](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPPictureLibrary.aspx) extends another base type, [Microsoft.SharePoint.SPDocumentLibrary](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPDocumentLibrary.aspx). That type, in turn, extends the [Microsoft.SharePoint.SPList](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPList.aspx) type. + For attributes of the **SPDocumentLibrary** type, see [DocumentLibrary Element (DeploymentManifest)](documentlibrary-element-deploymentmanifest.md). For attributes of the **SPList** type, see [List Element (DeploymentManifest)](list-element-deploymentmanifest.md). - + ## See also - [SPPictureLibrary](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPPictureLibrary.aspx) -- [SPDocumentLibrary](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPDocumentLibrary.aspx) +- [SPDocumentLibrary](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPDocumentLibrary.aspx) - [SPList](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPList.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/pid-element-managedpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/pid-element-managedpropertyinfo-complextypesps15xsdsearchset2.md index bfc074eb9..5ce778ad7 100644 --- a/docs/schema/pid-element-managedpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/pid-element-managedpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Pid element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" +description: Describes the Pid element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) and provides the element information, a definition, and the elements and attributes. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4acd20c4-a80b-2472-6674-f484ddac48c4 -description: "Last modified: March 09, 2015" --- # Pid element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Resource | File | |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +| **Element type** |xs:int
    | +| **Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | +| **Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd
    | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/policyitem-element-solution.md b/docs/schema/policyitem-element-solution.md index 2ab72c995..5a78c2a7d 100644 --- a/docs/schema/policyitem-element-solution.md +++ b/docs/schema/policyitem-element-solution.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Solution Schema api_type: @@ -17,9 +16,9 @@ description: Specifies a code access security policy for a solution. # PolicyItem element (Solution) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies a code access security policy for a solution. - + ```XML @@ -28,20 +27,18 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - -
    - +- Maximum: Unbounded +
    diff --git a/docs/schema/project-element-site.md b/docs/schema/project-element-site.md index 589f71873..895d87a2b 100644 --- a/docs/schema/project-element-site.md +++ b/docs/schema/project-element-site.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: @@ -17,9 +16,9 @@ description: Serves as the top-level element in an Onet.xml file that contains a # Project element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Serves as the top-level element in an [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx) file that contains a site definition configuration or Web template configuration for a new website. - + +Serves as the top-level element in an [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx) file that contains a site definition configuration or Web template configuration for a new website. + ```XML |Optional **Text**. Provides a description of the site logo.
    | |**Title**
    |Required **Text**. Specifies a default name for websites that are created from the site definition.
    | |**UIVersion**
    |Optional **Integer**. Specifies the version of the SharePoint Foundation UI that is being used by the sites based on the site definition.
    | - + ### Child elements - [BaseTypes](basetypes-element-site.md) @@ -63,22 +62,20 @@ The following sections describe attributes, child elements, and parent elements. - [Modules](modules-element-site.md) - [NavBars](navbars-element-site.md) - [ServerEmailFooter](serveremailfooter-element-site.md)| - + ### Parent elements None - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ## Example The following example shows the opening line of the [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx) file for the standard SharePoint Foundation site definition (**STS**). - + ```XML ``` - - diff --git a/docs/schema/projectedfields-element-view.md b/docs/schema/projectedfields-element-view.md index 4d1dd3859..5c08da65f 100644 --- a/docs/schema/projectedfields-element-view.md +++ b/docs/schema/projectedfields-element-view.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: @@ -17,12 +16,12 @@ description: Specifies the fields in joined lists that can be included in the vi # ProjectedFields element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies the fields in joined lists that can be included in the view when one or more other lists have been joined in a query. - + ```XML - - + + ``` @@ -34,38 +33,38 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [Field](field-element-list.md) - + > [!NOTE] -> There is a maximum number of [Field](field-element-list.md) child elements. It is defined as the difference between the maximum number of allowed fields in the list and the number of fields that are already in the list. - +> There is a maximum number of [Field](field-element-list.md) child elements. It is defined as the difference between the maximum number of allowed fields in the list and the number of fields that are already in the list. + ### Parent elements [View](view-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 +- Maximum: 1 > [!NOTE] -> The [View](view-element-list.md) element cannot have a **ProjectedFields** element unless it has a [Joins](joins-element-view.md) element that has at least one [Join](join-element-view.md) child element. However, a **ProjectedFields** element that forms the value of a **SPQuery.ProjectedFields** property, and therefore, is not a child of a [View](view-element-list.md) element, can be used to support an implicit join without a [Joins](joins-element-view.md) element. +> The [View](view-element-list.md) element cannot have a **ProjectedFields** element unless it has a [Joins](joins-element-view.md) element that has at least one [Join](join-element-view.md) child element. However, a **ProjectedFields** element that forms the value of a **SPQuery.ProjectedFields** property, and therefore, is not a child of a [View](view-element-list.md) element, can be used to support an implicit join without a [Joins](joins-element-view.md) element. > -> We do not recommend working without a [Joins](joins-element-view.md) element. You will maximize your solution's chances of being compatible with future releases of Microsoft SharePoint Foundation by always using an explicit **Join** element. For more information about implicit joins with **ProjectedFields** elements, see [List Joins and Projections](https://msdn.microsoft.com/library/f8e07793-3053-4930-97aa-556e38b9f21b%28Office.15%29.aspx). - +> We do not recommend working without a [Joins](joins-element-view.md) element. You will maximize your solution's chances of being compatible with future releases of Microsoft SharePoint Foundation by always using an explicit **Join** element. For more information about implicit joins with **ProjectedFields** elements, see [List Joins and Projections](https://msdn.microsoft.com/library/f8e07793-3053-4930-97aa-556e38b9f21b%28Office.15%29.aspx). + ### Remarks -If a field from a joined list is not represented in **ProjectedFields**, it cannot be included in the [ViewFields](viewfields-element-list.md) element. - +If a field from a joined list is not represented in **ProjectedFields**, it cannot be included in the [ViewFields](viewfields-element-list.md) element. + ## Example -The following example shows how to add another field to the results that are returned by the query. The value of the **List** attribute is an alias to the foreign list. The alias is defined in a [Join Element (View)](join-element-view.md). The **ShowField** attribute must be set to the internal name of the foreign field. - -The **Type** attribute does not indicate the data type of the field as it usually does in a [Field](field-element-list.md) element. When a [Field](field-element-list.md) element is a child of a **ProjectedFields** element, **Type** simply indicates whether the [Join](join-element-view.md) element (in the [Joins](joins-element-view.md) element on which the **ProjectedFields** element depends) is based on an existing lookup relation between the lists. As of SharePoint Foundation 2010, all joins must be based on an existing lookup relation, so **Type** always has the value "Lookup". The actual data type of the field is not indicated when it is a child of the **ProjectedFields** element. However, the field's data type does matter because only the following types of fields can be included in a **ProjectedFields** element: - +The following example shows how to add another field to the results that are returned by the query. The value of the **List** attribute is an alias to the foreign list. The alias is defined in a [Join Element (View)](join-element-view.md). The **ShowField** attribute must be set to the internal name of the foreign field. + +The **Type** attribute does not indicate the data type of the field as it usually does in a [Field](field-element-list.md) element. When a [Field](field-element-list.md) element is a child of a **ProjectedFields** element, **Type** simply indicates whether the [Join](join-element-view.md) element (in the [Joins](joins-element-view.md) element on which the **ProjectedFields** element depends) is based on an existing lookup relation between the lists. As of SharePoint Foundation 2010, all joins must be based on an existing lookup relation, so **Type** always has the value "Lookup". The actual data type of the field is not indicated when it is a child of the **ProjectedFields** element. However, the field's data type does matter because only the following types of fields can be included in a **ProjectedFields** element: + - Calculated (treated as plain text) - ContentTypeId - Counter @@ -77,7 +76,7 @@ The **Type** attribute does not indicate the data type of the field as it usuall - Number - Text -
    +
    ```XML @@ -90,5 +89,3 @@ The **Type** attribute does not indicate the data type of the field as it usuall ``` For an example of a **ProjectedFields** element whose child **Field** element has a **FieldRef** attribute instead of a **List** attribute, see [List Joins and Projections](https://msdn.microsoft.com/library/f8e07793-3053-4930-97aa-556e38b9f21b%28Office.15%29.aspx). - - diff --git a/docs/schema/projectproperty-element-view.md b/docs/schema/projectproperty-element-view.md index b8c540a73..71c94be7f 100644 --- a/docs/schema/projectproperty-element-view.md +++ b/docs/schema/projectproperty-element-view.md @@ -1,32 +1,31 @@ --- title: "ProjectProperty element (View)" manager: soliver -ms.date: 3/9/2015 +ms.date: 03/28/2023 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: - schema ms.assetid: b334ab94-ecf1-4fe2-bfb7-20be79d5b072 -description: Used to return a global property of the current SharePoint site. +description: Used to return a global property of the current SharePoint site. --- # ProjectProperty element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -The **ProjectProperty** element can be used to return a global property of the current SharePoint site. - + +The **ProjectProperty** element can be used to return a global property of the current SharePoint site. + ```XML |Optional **Boolean**. **TRUE** to surround text with `    ` tags if the text appears like a hyperlink (for example, `www.microsoft.com`).
    | -|**AutoHyperLinkNoEncoding**
    |Optional **Boolean**. **TRUE** to surround text with `    ` tags if the text appears like a hyperlink (for example, `www.microsoft.com`) but without HTML encoding.
    | -|**AutoNewLine**
    |Optional **Boolean**. **TRUE** to insert `
    ` tags into the text stream and to replace multiple spaces with a nonbreaking space (` `).
    | -|**Default**
    |Optional **Text**. Renders the text assigned to this attribute if the value returned by a selection is an empty string (`""`).
    | -|**ExpandXML**
    |Optional **Boolean**. **TRUE** to re-pass the rendered content through the Collaborative Application Markup Language (CAML) interpreter, which allows CAML to render CAML.
    | -|**HTMLEncode**
    |Optional **Boolean**. **TRUE** to convert embedded characters so that they are displayed as text in the browser. In other words, characters that could be confused with HTML tags are converted to entities.
    | -|**Select**
    |Required **Text**. Specifies the name of the property to select.
    | -|**StripWS**
    |Optional **Boolean**. **TRUE** to remove white space from the beginning and end of the value returned by the element.
    | -|**URLEncode**
    |Optional **Boolean**. **TRUE** to convert special characters, such as spaces, to quoted UTF-8 format (for example, `%c3%ab` for character `ë`).
    | -|**URLEncodeAsURL**
    |Optional **Boolean**. Like **URLEncode**, but **TRUE** to specify that the string to encode is a path component of a URL so that forward slashes (`/`) are not encoded.
    | - +| Attribute | Description | +| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **AutoHyperLink** | Optional **Boolean**. **TRUE** to surround text with `    ` tags if the text appears like a hyperlink (for example, `www.microsoft.com`). | +| **AutoHyperLinkNoEncoding** | Optional **Boolean**. **TRUE** to surround text with `` tags if the text appears like a hyperlink (for example, `www.microsoft.com`) but without HTML encoding. | +| **AutoNewLine** | Optional **Boolean**. **TRUE** to insert `
    ` tags into the text stream and to replace multiple spaces with a nonbreaking space (` `). | +| **Default** | Optional **Text**. Renders the text assigned to this attribute if the value returned by a selection is an empty string (`""`). | +| **ExpandXML** | Optional **Boolean**. **TRUE** to re-pass the rendered content through the Collaborative Application Markup Language (CAML) interpreter, which allows CAML to render CAML. | +| **HTMLEncode** | Optional **Boolean**. **TRUE** to convert embedded characters so that they are displayed as text in the browser. In other words, characters that could be confused with HTML tags are converted to entities. | +| **Select** | Required **Text**. Specifies the name of the property to select. | +| **StripWS** | Optional **Boolean**. **TRUE** to remove white space from the beginning and end of the value returned by the element. | +| **URLEncode** | Optional **Boolean**. **TRUE** to convert special characters, such as spaces, to quoted UTF-8 format (for example, `%c3%ab` for character `ë`). | +| **URLEncodeAsURL** | Optional **Boolean**. Like **URLEncode**, but **TRUE** to specify that the string to encode is a path component of a URL so that forward slashes (`/`) are not encoded. | + ### Child elements None - + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ## Example -The following line of code returns the **Title** property from the current website. - +The following line of code returns the **Title** property from the current website. + ```XML ``` ## See also -- [ListProperty element (View)](listproperty-element-view.md) +- [ListProperty element (View)](listproperty-element-view.md) - [Property element (View)](property-element-view.md) - diff --git a/docs/schema/promotedproperty-element-in-viewinstancedefinition-solutionmanifestdefinitions-s.md b/docs/schema/promotedproperty-element-in-viewinstancedefinition-solutionmanifestdefinitions-s.md index 58ebb6f9e..61125b091 100644 --- a/docs/schema/promotedproperty-element-in-viewinstancedefinition-solutionmanifestdefinitions-s.md +++ b/docs/schema/promotedproperty-element-in-viewinstancedefinition-solutionmanifestdefinitions-s.md @@ -1,15 +1,15 @@ --- title: PromotedProperty Element in ViewInstanceDefinition +description: Describes the PromotedProperty element in ViewInstanceDefinition and provides the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 12a4acb8-df31-bdca-1dea-b6534c7c6195 --- -# PromotedProperty Element in ViewInstanceDefinition +# PromotedProperty Element in ViewInstanceDefinition (SolutionManifestDefinitions Schema) @@ -84,33 +84,11 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    View Element in EntityInstanceDefinition (SolutionManifestDefinitions Schema)

    The view this promoted property belongs to.

    -
    +| Element | Description | +| --- | --- | +| [View Element in EntityInstanceDefinition (SolutionManifestDefinitions Schema)](view-element-in-entityinstancedefinition-solutionmanifestdefinitions-schema.md) | The view this promoted property belongs to. |
    - - - - - - - +
    diff --git a/docs/schema/properties-element-alerttemplates.md b/docs/schema/properties-element-alerttemplates.md index 484dc8281..c75dd2568 100644 --- a/docs/schema/properties-element-alerttemplates.md +++ b/docs/schema/properties-element-alerttemplates.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - AlertTemplates schema api_type: @@ -17,9 +16,9 @@ description: Excludes fields from the list that is displayed in the alert messag # Properties element (AlertTemplates) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Excludes fields from the list that is displayed in the alert message. - + ```XML [ @@ -43,20 +42,20 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -- [ImmediateNotificationExcludedFields](immediatenotificationexcludedfields-element-alerttemplates.md) -- [DigestNotificationExcludedFields](digestnotificationexcludedfields-element-alerttemplates.md) -- [NotificationHandlerAssembly](notificationhandlerassembly-element-alert-templates.md) -- [NotificationHandlerClassName](notificationhandlerclassname-element-alerttemplates.md) -- [UpdateHandlerAssembly](updatehandlerassembly-element-alerttemplates.md) -- [UpdateHandlerClassName](updatehandlerclassname-element-alerttemplates.md) - +- [ImmediateNotificationExcludedFields](immediatenotificationexcludedfields-element-alerttemplates.md) +- [DigestNotificationExcludedFields](digestnotificationexcludedfields-element-alerttemplates.md) +- [NotificationHandlerAssembly](notificationhandlerassembly-element-alert-templates.md) +- [NotificationHandlerClassName](notificationhandlerclassname-element-alerttemplates.md) +- [UpdateHandlerAssembly](updatehandlerassembly-element-alerttemplates.md) +- [UpdateHandlerClassName](updatehandlerclassname-element-alerttemplates.md) + ### Parent elements - [AlertTemplate](alerttemplate-element-alerttemplates.md) - + ## Example ```XML @@ -73,5 +72,3 @@ None ``` - - diff --git a/docs/schema/properties-element-appdefinition-complextypesharepoint-add-in-manifest.md b/docs/schema/properties-element-appdefinition-complextypesharepoint-add-in-manifest.md index d07732a1e..2df279d87 100644 --- a/docs/schema/properties-element-appdefinition-complextypesharepoint-add-in-manifest.md +++ b/docs/schema/properties-element-appdefinition-complextypesharepoint-add-in-manifest.md @@ -1,15 +1,15 @@ --- title: Properties element (AppDefinition complexType) +description: Describes the Properties element (AppDefinition complexType) and provides the element information, a definition, and the elements and attributes. manager: soliver -ms.date: 9/17/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: e1f48a2f-cd69-9457-7036-43e5bbfa10ac --- -# Properties element (AppDefinition complexType) +# Properties element (AppDefinition complexType) (SharePoint Add-in Manifest) @@ -17,23 +17,23 @@ ms.assetid: e1f48a2f-cd69-9457-7036-43e5bbfa10ac Contains information that is global to the add-in. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Resource | File | |---|---| -| **Element type** | PropertiesDefinition | -| **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | -| **Schema file** | appmanifest.xsd | +| **Element type** | PropertiesDefinition | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | +| **Schema file** | appmanifest.xsd | ## Definition ```XML  - + ``` ## Elements and attributes @@ -138,9 +138,3 @@ None.

    - - - - - - diff --git a/docs/schema/properties-element-clientwebpartdefinition-complextypeapphostwebfeatures.md b/docs/schema/properties-element-clientwebpartdefinition-complextypeapphostwebfeatures.md index d6c4c85b8..c2a1312e4 100644 --- a/docs/schema/properties-element-clientwebpartdefinition-complextypeapphostwebfeatures.md +++ b/docs/schema/properties-element-clientwebpartdefinition-complextypeapphostwebfeatures.md @@ -1,28 +1,28 @@ --- title: Properties element (ClientWebPartDefinition complexType) +description: Describes the Properties element (ClientWebPartDefinition complexType) and provides the element information, a definition, and the elements and attributes. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4aa16313-3172-c658-a072-e477f8140709 --- -# Properties element (ClientWebPartDefinition complexType) +# Properties element (ClientWebPartDefinition complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Resource | File | |---|---| -| **Element type** | ClientWebPartProperties | -| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | -| **Schema file** | apphostwebfeatures.xsd | +| **Element type** | ClientWebPartProperties | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | +| **Schema file** | apphostwebfeatures.xsd | ## Definition @@ -59,7 +59,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements @@ -85,20 +85,12 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/properties-element-deploymentmanifestspattachment.md b/docs/schema/properties-element-deploymentmanifestspattachment.md index ac54d2ad6..9009f927a 100644 --- a/docs/schema/properties-element-deploymentmanifestspattachment.md +++ b/docs/schema/properties-element-deploymentmanifestspattachment.md @@ -1,20 +1,19 @@ --- title: "Properties Element (DeploymentManifest - SPAttachment)" +description: Describes the Properties element (DeploymentManifest - SPAttachment) and provides a definition, the type, and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 67a3c058-34d2-4b96-ae8d-b4faf6e194a9 -description: "Last modified: March 09, 2015" --- # Properties Element (DeploymentManifest - SPAttachment) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a collection of properties on a Windows SharePoint Services 3.0 attachment. Use the Attachments property of the **SPListItem** class to retrieve a collection of attachements for a list item. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a collection of properties on a Windows SharePoint Services 3.0 attachment. Use the Attachments property of the **SPListItem** class to retrieve a collection of attachements for a list item. ## Definition @@ -34,7 +33,7 @@ USAGE ## Type **Dictionary** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -42,16 +41,15 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [Property Element (DeploymentManifest)](property-element-deploymentmanifest.md) - + ### Parent elements [Attachment Element (DeploymentManifest)](attachment-element-deploymentmanifest.md) - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/properties-element-deploymentmanifestspfile.md b/docs/schema/properties-element-deploymentmanifestspfile.md index 9d6eff2bf..b92cb9fff 100644 --- a/docs/schema/properties-element-deploymentmanifestspfile.md +++ b/docs/schema/properties-element-deploymentmanifestspfile.md @@ -1,20 +1,19 @@ --- title: "Properties Element (DeploymentManifest - SPFile)" +description: Describes the Properties element (DeploymentManifest - SPFile) and provides a definition, the type, and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 57ce0f76-68ed-44d3-b6b8-8947650fcf8b -description: "Last modified: March 09, 2015" --- # Properties Element (DeploymentManifest - SPFile) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a collection of properties on an instannce of a Windows SharePoint Services 3.0 file ([SPFile](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFile.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a collection of properties on an instannce of a Windows SharePoint Services 3.0 file ([SPFile](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFile.aspx)) object. ## Definition @@ -34,7 +33,7 @@ USAGE ## Type **Dictionary** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -42,17 +41,16 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [Property Element (DeploymentManifest)](property-element-deploymentmanifest.md) - + ### Parent elements [File Element (DeploymentManifest - SPGenericObject)](file-element-deploymentmanifestspgenericobject.md) - + ## See also - [SPFile](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFile.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/properties-element-deploymentmanifestspfolder.md b/docs/schema/properties-element-deploymentmanifestspfolder.md index 47e3f5b27..82f532e65 100644 --- a/docs/schema/properties-element-deploymentmanifestspfolder.md +++ b/docs/schema/properties-element-deploymentmanifestspfolder.md @@ -1,20 +1,19 @@ --- title: "Properties Element (DeploymentManifest - SPFolder)" +description: Represents a collection of properties on an instance of a Windows SharePoint Services 3.0 folder. manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b2bdf3ad-5452-4c44-bdca-304597b0efd2 -description: "Last modified: March 09, 2015" --- # Properties Element (DeploymentManifest - SPFolder) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a collection of properties on an instance of a Windows SharePoint Services 3.0 folder ([SPFolder](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFolder.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a collection of properties on an instance of a Windows SharePoint Services 3.0 folder ([SPFolder](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFolder.aspx)) object. ## Definition @@ -33,8 +32,8 @@ USAGE ## Type -[Dictionary](https://docs.microsoft.com/dotnet/api/system.collections.generic.dictionary-2) - +[Dictionary](/dotnet/api/system.collections.generic.dictionary-2) + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -42,18 +41,17 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [Property Element (DeploymentManifest)](property-element-deploymentmanifest.md) - + ### Parent elements [Folder Element (DeploymentManifest)](folder-element-deploymentmanifest.md) - + ## See also - [SPFolder](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPFolder.aspx) -- [Dictionary](https://docs.microsoft.com/dotnet/api/system.collections.generic.dictionary-2) +- [Dictionary](/dotnet/api/system.collections.generic.dictionary-2) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/properties-element-deploymentmanifestspmodule.md b/docs/schema/properties-element-deploymentmanifestspmodule.md index ad6dac4ea..a5cdcfa10 100644 --- a/docs/schema/properties-element-deploymentmanifestspmodule.md +++ b/docs/schema/properties-element-deploymentmanifestspmodule.md @@ -1,20 +1,19 @@ --- title: "Properties Element (DeploymentManifest - SPModule)" +description: Describes the Properties element (DeploymentManifest - SPModule) and provides a definition, the type, and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2804fb78-9819-4cbb-b0fd-44eb0645a3b4 -description: "Last modified: March 09, 2015" --- # Properties Element (DeploymentManifest - SPModule) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a collection of properties on an instance of a Windows SharePoint Services 3.0 module ([SPModule](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPModule.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a collection of properties on an instance of a Windows SharePoint Services 3.0 module ([SPModule](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPModule.aspx)) object. ## Definition @@ -33,7 +32,7 @@ USAGE ## Type [Dictionary](https://msdn.microsoft.com/library/System.Collections.Generic.Dictionary.aspx) - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -41,18 +40,17 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [Property Element (DeploymentManifest)](property-element-deploymentmanifest.md) - + ### Parent elements [Module Element (DeploymentManifest)](module-element-deploymentmanifest.md) - + ## See also - [SPModule](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPModule.aspx) - [Dictionary](https://msdn.microsoft.com/library/System.Collections.Generic.Dictionary.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/properties-element-deploymentmanifestspweb.md b/docs/schema/properties-element-deploymentmanifestspweb.md index 344a2211f..4fc0f4d79 100644 --- a/docs/schema/properties-element-deploymentmanifestspweb.md +++ b/docs/schema/properties-element-deploymentmanifestspweb.md @@ -1,20 +1,19 @@ --- title: "Properties Element (DeploymentManifest - SPWeb)" +description: Describes the Properties element (DeploymentManifest - SPWeb) and provides a definition, the type, and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 846e7a27-468e-4b7f-a911-5c923f4e774c -description: "Last modified: March 09, 2015" --- # Properties Element (DeploymentManifest - SPWeb) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a collection of properties on an instance of a Windows SharePoint Services 3.0 Web ([SPWeb](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPWeb.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a collection of properties on an instance of a Windows SharePoint Services 3.0 Web ([SPWeb](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPWeb.aspx)) object. ## Definition @@ -34,7 +33,7 @@ USAGE ## Type [Dictionary](https://msdn.microsoft.com/library/System.Collections.Generic.Dictionary.aspx) - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -42,18 +41,17 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [Property Element (DeploymentManifest)](property-element-deploymentmanifest.md) - + ### Parent elements [Web Element (DeploymentManifest)](web-element-deploymentmanifest.md) - + ## See also - [SPWeb](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPWeb.aspx) - [Dictionary](https://msdn.microsoft.com/library/System.Collections.Generic.Dictionary.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/properties-element-feature.md b/docs/schema/properties-element-feature.md index 740875ccd..9d23e3a1f 100644 --- a/docs/schema/properties-element-feature.md +++ b/docs/schema/properties-element-feature.md @@ -1,11 +1,11 @@ --- title: Properties Element (Feature) +description: Describes the Properties element (Feature) and provides a definition, the elements and attributes, and an example. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5fda72f7-0f87-423f-9893-819bc03f2a6d --- @@ -74,11 +74,3 @@ None ## Example For an example of how this element is used, see [Feature.xml Files](feature-xml-files.md). - - - - - - - - diff --git a/docs/schema/properties-element-featuredefinition-complextypeapphostwebfeatures.md b/docs/schema/properties-element-featuredefinition-complextypeapphostwebfeatures.md index 28d886d39..35790042f 100644 --- a/docs/schema/properties-element-featuredefinition-complextypeapphostwebfeatures.md +++ b/docs/schema/properties-element-featuredefinition-complextypeapphostwebfeatures.md @@ -1,28 +1,28 @@ --- title: Properties element (FeatureDefinition complexType) +description: Describes the Properties element (FeatureDefinition complexType) and provides the element information, a definition, and the elements and attributes. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 13132ab0-0417-8d3f-de21-bc3b6be1e7ad --- -# Properties element (FeatureDefinition complexType) +# Properties element (FeatureDefinition complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Resource | Files | |---|---| -| **Element type** | FeaturePropertyDefinitions | -| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | -| **Schema file** | apphostwebfeatures.xsd | +| **Element type** | FeaturePropertyDefinitions | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | +| **Schema file** | apphostwebfeatures.xsd | ## Definition @@ -33,7 +33,7 @@ ms.assetid: 13132ab0-0417-8d3f-de21-bc3b6be1e7ad ## Elements and attributes If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - + ### Parent elements @@ -59,7 +59,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements @@ -85,20 +85,12 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/properties-element-featuretemplatereference-complextypeapphostwebfeatures.md b/docs/schema/properties-element-featuretemplatereference-complextypeapphostwebfeatures.md index 4199cf0b0..ba2b6636b 100644 --- a/docs/schema/properties-element-featuretemplatereference-complextypeapphostwebfeatures.md +++ b/docs/schema/properties-element-featuretemplatereference-complextypeapphostwebfeatures.md @@ -1,30 +1,30 @@ --- title: Properties element (FeatureTemplateReference complexType) +description: Describes the Properties element (FeatureTemplateReference complexType) and provides the element information, a definition, and the elements and attributes. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d0072541-fbe7-4ac4-2687-17b0829b8c43 --- -# Properties element (FeatureTemplateReference complexType) +# Properties element (FeatureTemplateReference complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Resource | File | |---|---| -| **Element type** | FeaturePropertyDefinitions | -| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | -| **Schema file** | apphostwebfeatures.xsd | +| **Element type** | FeaturePropertyDefinitions | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | +| **Schema file** | apphostwebfeatures.xsd | -## Definition +## Definition ```XML @@ -59,7 +59,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements @@ -85,20 +85,12 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/properties-element-in-metadataobject-bdcmetadata-schema.md b/docs/schema/properties-element-in-metadataobject-bdcmetadata-schema.md index 614eecf03..0d7ed21ad 100644 --- a/docs/schema/properties-element-in-metadataobject-bdcmetadata-schema.md +++ b/docs/schema/properties-element-in-metadataobject-bdcmetadata-schema.md @@ -7,8 +7,7 @@ ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.Properties -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9901904f-96ee-0cbb-64a9-c2aad9d72128 --- diff --git a/docs/schema/properties-element-in-metadataobject-bdcmetadataresource-schema.md b/docs/schema/properties-element-in-metadataobject-bdcmetadataresource-schema.md index 70c279ef1..af4105c62 100644 --- a/docs/schema/properties-element-in-metadataobject-bdcmetadataresource-schema.md +++ b/docs/schema/properties-element-in-metadataobject-bdcmetadataresource-schema.md @@ -5,8 +5,7 @@ manager: soliver ms.date: 01/27/2021 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 65a8fe10-08f8-0464-682b-35ea71842eed --- diff --git a/docs/schema/properties-element-in-metadataobject-subscription-schema.md b/docs/schema/properties-element-in-metadataobject-subscription-schema.md index fb72b050d..4f29c4d3f 100644 --- a/docs/schema/properties-element-in-metadataobject-subscription-schema.md +++ b/docs/schema/properties-element-in-metadataobject-subscription-schema.md @@ -5,8 +5,7 @@ manager: soliver ms.date: 01/27/2021 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 391e8202-e3b4-7d98-6033-c9b0ecc152dc --- # Properties Element in MetadataObject (Subscription Schema) diff --git a/docs/schema/properties-element-site.md b/docs/schema/properties-element-site.md index 5c536bdb1..c54d213d9 100644 --- a/docs/schema/properties-element-site.md +++ b/docs/schema/properties-element-site.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: - schema ms.assetid: cc3e73da-e9c5-44fb-a43c-f7fa17b6c144 -description: Specifies custom property values to implement within the Feature. +description: Specifies custom property values to implement within the Feature. --- # Properties element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Specifies custom property values to implement within the Feature. - + +Specifies custom property values to implement within the Feature. + ```XML - +- Maximum: 1 +
    diff --git a/docs/schema/propertiesdefinition-complextype-sharepoint-add-in-manifest.md b/docs/schema/propertiesdefinition-complextype-sharepoint-add-in-manifest.md index 202a1f020..7257aca93 100644 --- a/docs/schema/propertiesdefinition-complextype-sharepoint-add-in-manifest.md +++ b/docs/schema/propertiesdefinition-complextype-sharepoint-add-in-manifest.md @@ -1,30 +1,30 @@ --- title: PropertiesDefinition complexType +description: Describes the PropertiesDefinition complexType) and provides the type information, a definition, and the elements and attributes. manager: soliver -ms.date: 9/17/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2c430e31-cb39-7c9a-67fa-1e584068245f --- -# PropertiesDefinition complexType +# PropertiesDefinition complexType (SharePoint Add-in Manifest) **Applies to**: SharePoint Add-ins | SharePoint Foundation 2013 | SharePoint Server 2013 -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +| Resource | File | |---|---| -| **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | -| **Schema file** | appmanifest.xsd | -| **Extension base** | None | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | +| **Schema file** | appmanifest.xsd | +| **Extension base** | None | ## Definition @@ -36,42 +36,42 @@ ms.assetid: 2c430e31-cb39-7c9a-67fa-1e584068245f maxOccurs="1" > - + - + - + - + - + - + - + ``` @@ -149,10 +149,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** ### Attributes None. - - - - - - - diff --git a/docs/schema/propertiestype-complextype-action4.md b/docs/schema/propertiestype-complextype-action4.md index bac2f258b..c174f5a80 100644 --- a/docs/schema/propertiestype-complextype-action4.md +++ b/docs/schema/propertiestype-complextype-action4.md @@ -1,11 +1,11 @@ --- title: propertiesType complexType (Action4) +description: Describes the propertiesType complexType (Action4) and provides the type information, a definition, and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b70e4eac-5848-8936-cd1d-8b532402635f --- @@ -49,7 +49,7 @@ Base type for defining a [Property element (propertiesType complexType) (Action4 - + @@ -120,11 +120,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** - - - - - - - - diff --git a/docs/schema/property-bag-schema.md b/docs/schema/property-bag-schema.md index b74eeae39..f321b46e9 100644 --- a/docs/schema/property-bag-schema.md +++ b/docs/schema/property-bag-schema.md @@ -1,11 +1,11 @@ --- title: Property Bag schema +description: Describes the Property Bag schema and provides examples. manager: soliver -ms.date: 11/16/2014 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: dd003614-115e-4eb4-aa20-ffcfb0d0b805 --- @@ -43,10 +43,3 @@ The following example shows how to add a DaysToLive property and its value to th ``` - - - - - - - diff --git a/docs/schema/property-element-apppermissionrequestdefinition-complextypesharepoint-add-in-man.md b/docs/schema/property-element-apppermissionrequestdefinition-complextypesharepoint-add-in-man.md index 67c3893c2..9cc53a902 100644 --- a/docs/schema/property-element-apppermissionrequestdefinition-complextypesharepoint-add-in-man.md +++ b/docs/schema/property-element-apppermissionrequestdefinition-complextypesharepoint-add-in-man.md @@ -1,15 +1,15 @@ --- title: Property element (AppPermissionRequestDefinition complexType) +description: Describes the Property element (AppPermissionRequestDefinition complexType) and provides the element information, a definition, and the elements and attributes. manager: soliver -ms.date: 9/17/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 69cd6425-593f-c412-cb30-5e59ed341330 --- -# Property element (AppPermissionRequestDefinition complexType) +# Property element (AppPermissionRequestDefinition complexType) (SharePoint Add-in Manifest) @@ -17,16 +17,16 @@ ms.assetid: 69cd6425-593f-c412-cb30-5e59ed341330 Add-in Permission Property. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Resource | File | |---|---| -| **Element type** | AppPermissionPropertyDefinition | -| **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | -| **Schema file** | appmanifest.xsd | +| **Element type** | AppPermissionPropertyDefinition | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | +| **Schema file** | appmanifest.xsd | ## Definition @@ -36,7 +36,7 @@ Add-in Permission Property. maxOccurs="1000" > -``` +``` ## Elements and attributes @@ -113,9 +113,3 @@ None.

    - - - - - - diff --git a/docs/schema/property-element-clientwebpartproperties-complextypeapphostwebfeatures.md b/docs/schema/property-element-clientwebpartproperties-complextypeapphostwebfeatures.md index 5bbddf9cc..b4c30baae 100644 --- a/docs/schema/property-element-clientwebpartproperties-complextypeapphostwebfeatures.md +++ b/docs/schema/property-element-clientwebpartproperties-complextypeapphostwebfeatures.md @@ -1,28 +1,28 @@ --- title: Property element (ClientWebPartProperties complexType) +description: Describes the Property element (ClientWebPartProperties complexType) and provides the element information, a definition, and the elements and attributes. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8e87451c-6146-2e5b-c37f-a932f2a2e68a --- -# Property element (ClientWebPartProperties complexType) +# Property element (ClientWebPartProperties complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Resource | File | |---|---| -| **Element type** | ClientWebPartProperty | -| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | -| **Schema file** | apphostwebfeatures.xsd | +| **Element type** | ClientWebPartProperty | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | +| **Schema file** | apphostwebfeatures.xsd | ## Definition @@ -59,7 +59,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements @@ -85,7 +85,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Attributes @@ -201,14 +201,6 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/property-element-delegate-control.md b/docs/schema/property-element-delegate-control.md index eecf58b8f..10d6aafcb 100644 --- a/docs/schema/property-element-delegate-control.md +++ b/docs/schema/property-element-delegate-control.md @@ -1,11 +1,11 @@ --- title: Property element (Delegate Control) +description: Describes the Property element (Delegate Control) and provides a definition and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6ae5810a-4bc9-417e-945d-dd39a0eeb350 --- @@ -95,11 +95,3 @@ When the control is instantiated, the properties specified in this element are a ## See also - [How to: Customize a Delegate Control](https://msdn.microsoft.com/library/9db44a39-33df-43d9-b873-3b41310090af(Office.15).aspx) - - - - - - - - diff --git a/docs/schema/property-element-deploymentmanifest.md b/docs/schema/property-element-deploymentmanifest.md index 279437566..688141916 100644 --- a/docs/schema/property-element-deploymentmanifest.md +++ b/docs/schema/property-element-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "Property Element (DeploymentManifest)" +description: Describes the Property element (DeploymentManifest) and provides a definition, the type, and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: bb088270-da19-42a2-85ef-7555a57e8d69 -description: "Last modified: March 09, 2015" --- # Property element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Represents a property value on an instance of a Windows SharePoint Services 3.0 object. ## Definition @@ -39,7 +38,7 @@ USAGE ## Type [DictionaryEntry](https://msdn.microsoft.com/library/System.Collections.DictionaryEntry.aspx) - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -54,17 +53,16 @@ The following sections describe attributes, child elements, and parent elements. |Id
    |[Guid Simple Type (DeploymentManifest)](guid-simple-type-deploymentmanifest.md)
    |Optional. Unique identifier of the property.
    | |Type
    |[SPDictionaryEntryValueType Simple Type (DeploymentManifest)](spdictionaryentryvaluetype-simple-type-deploymentmanifest.md)
    |Optional. Enumeration of property value types.
    The default type is **string**.
    | |Access
    |[SPDictionaryEntryAccess Simple Type (DeploymentManifest)](spdictionaryentryaccess-simple-type-deploymentmanifest.md)
    |Optional. An enumeration of two available access modes settings: **ReadOnly** and **ReadWrite**.
    The default access mode is **ReadWrite**.
    | - + ### Child elements None - + ### Parent elements [Properties Element (DeploymentManifest - SPAttachment)](properties-element-deploymentmanifestspattachment.md) - + ## See also - [DictionaryEntry](https://msdn.microsoft.com/library/System.Collections.DictionaryEntry.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/property-element-feature.md b/docs/schema/property-element-feature.md index 1eebd1320..6bdff90f7 100644 --- a/docs/schema/property-element-feature.md +++ b/docs/schema/property-element-feature.md @@ -1,11 +1,11 @@ --- title: Property element (Feature) +description: Describes the Property element (Feature) and provides a definition, the elements and attributes, and an example. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6656ccd6-a806-4643-81d5-c02524ee16ab --- @@ -88,11 +88,3 @@ None ## Example For an example of how this element is used, see [Feature.xml Files](feature-xml-files.md). - - - - - - - - diff --git a/docs/schema/property-element-featurepropertydefinitions-complextypeapphostwebfeatures.md b/docs/schema/property-element-featurepropertydefinitions-complextypeapphostwebfeatures.md index 025d428b7..675d5fe6a 100644 --- a/docs/schema/property-element-featurepropertydefinitions-complextypeapphostwebfeatures.md +++ b/docs/schema/property-element-featurepropertydefinitions-complextypeapphostwebfeatures.md @@ -1,30 +1,30 @@ --- title: Property element (FeaturePropertyDefinitions complexType) +description: Describes the Property element (FeaturePropertyDefinitions complexType) and provides the element information, a definition, and the elements and attributes. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5fd3a969-0f50-a8d3-1342-9c98668ee32a --- -# Property element (FeaturePropertyDefinitions complexType) +# Property element (FeaturePropertyDefinitions complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Resource | File | |---|---| -| **Element type** | FeaturePropertyDefinitions | -| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | -| **Schema file** | apphostwebfeatures.xsd | +| **Element type** | FeaturePropertyDefinitions | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | +| **Schema file** | apphostwebfeatures.xsd | -## Definition +## Definition ```XML @@ -64,13 +64,13 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements None. -
    +
    ### Attributes @@ -109,14 +109,6 @@ None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/property-element-featuresitetemplateassociation.md b/docs/schema/property-element-featuresitetemplateassociation.md index cb304c0bc..dc61f1c80 100644 --- a/docs/schema/property-element-featuresitetemplateassociation.md +++ b/docs/schema/property-element-featuresitetemplateassociation.md @@ -1,11 +1,11 @@ --- title: Property element (FeatureSiteTemplateAssociation) +description: Describes the Property element (FeatureSiteTemplateAssociation) and provides a definition and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 60db0486-d2c3-4c97-a98e-260f6c9193e2 --- @@ -73,11 +73,3 @@ None ## Example For an example of how this element is used, see [Feature/Site Template Associations](feature-site-template-associations.md). - - - - - - - - diff --git a/docs/schema/property-element-in-properties-bdcmetadata-schema.md b/docs/schema/property-element-in-properties-bdcmetadata-schema.md index 1f32d713f..26b870b5b 100644 --- a/docs/schema/property-element-in-properties-bdcmetadata-schema.md +++ b/docs/schema/property-element-in-properties-bdcmetadata-schema.md @@ -1,13 +1,13 @@ --- title: Property element in Properties (BDCMetadata) +description: Describes the Property element in Properties (BDCMetadata) and provides the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.Property -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2e6e8d5d-ef3b-c536-f3d1-ad2039b92c24 --- @@ -64,29 +64,7 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    Properties Element in MetadataObject (BDCMetadata Schema)

    The **Properties** element that contains this property.

    - - - - - - - +| Element | Description | +| --- | --- | +| [Properties Element in MetadataObject (BDCMetadata Schema)](properties-element-in-metadataobject-bdcmetadata-schema.md) | The **Properties** element that contains this property. | diff --git a/docs/schema/property-element-in-properties-bdcmetadataresource-schema.md b/docs/schema/property-element-in-properties-bdcmetadataresource-schema.md index 3135c4cc3..5528d3dfd 100644 --- a/docs/schema/property-element-in-properties-bdcmetadataresource-schema.md +++ b/docs/schema/property-element-in-properties-bdcmetadataresource-schema.md @@ -1,11 +1,11 @@ --- title: Property element in Properties (BDCMetadataResource) +description: Describes the Property element in Properties (BDCMetadataResource) and provides the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 642aaff0-f011-7d6f-b677-538eb95eef89 --- @@ -60,26 +60,6 @@ None. ### Parent elements - --- - - - - - - - - - - -

    Element

    Properties Element in MetadataObject (BDCMetadataResource Schema)

    - - - - - - - - +| Element | +| --- | +| [Properties Element in MetadataObject (BDCMetadataResource Schema)](properties-element-in-metadataobject-bdcmetadataresource-schema.md) | diff --git a/docs/schema/property-element-in-properties-subscription-schema.md b/docs/schema/property-element-in-properties-subscription-schema.md index effc4512e..4c7f60a29 100644 --- a/docs/schema/property-element-in-properties-subscription-schema.md +++ b/docs/schema/property-element-in-properties-subscription-schema.md @@ -1,11 +1,11 @@ --- title: Property Element in Properties (Subscription) +description: Describes the Property element in Properties (Subscription) and provides the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ac84b248-6d84-3815-5f66-03e431fa9221 --- @@ -62,29 +62,7 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    Properties Element in MetadataObject (Subscription Schema)

    - - - - - - - +| Element | Description | +| --- | --- | +| [Properties Element in MetadataObject (Subscription Schema)](properties-element-in-metadataobject-subscription-schema.md) | | diff --git a/docs/schema/property-element-list-instance.md b/docs/schema/property-element-list-instance.md index 4c5835fb7..9c6cc73ef 100644 --- a/docs/schema/property-element-list-instance.md +++ b/docs/schema/property-element-list-instance.md @@ -1,11 +1,11 @@ --- title: Property Element (List Instance) +description: Describes the Property element (List Instance) and provides the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 93b34073-8dd2-4b68-a692-c8ee6bb307bd --- @@ -18,7 +18,7 @@ Specifies a property for a list instance. ## Definition ```XML - @@ -91,11 +91,3 @@ None ### Remarks See the Remarks section of the topic [DataSource Element (List Instance)](datasource-element-list-instance.md) for information about the use of this element. - - - - - - - - diff --git a/docs/schema/property-element-list.md b/docs/schema/property-element-list.md index 83f344941..c50149e84 100644 --- a/docs/schema/property-element-list.md +++ b/docs/schema/property-element-list.md @@ -1,23 +1,22 @@ --- title: "Property element (List)" +description: Describes the Property element (List) and provides the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: - schema ms.assetid: 28ac9fde-722e-4d03-aaf3-d12882deb014 -description: "Last modified: March 09, 2015" --- # Property element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + ```XML @@ -30,20 +29,18 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [ArrayOfProperty](arrayofproperty-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - -
    - +- Maximum: Unbounded +
    diff --git a/docs/schema/property-element-module.md b/docs/schema/property-element-module.md index 1fe4e2a82..4a2f585e5 100644 --- a/docs/schema/property-element-module.md +++ b/docs/schema/property-element-module.md @@ -1,11 +1,11 @@ --- title: Property element (Module) +description: Describes the Property element (Module) and provides a definition and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7aa5ec15-223f-4cf2-868f-2b10f27ade65 --- @@ -88,7 +88,7 @@ None -## Example +## Example For an example of how this element is used, see [Modules](modules.md). @@ -97,9 +97,3 @@ For an example of how this element is used, see [Modules](modules.md). - [Module](https://msdn.microsoft.com/library/e5eeed6e-d785-496d-82b5-08d153588045(Office.15).aspx) - [How to: Provision a File](https://msdn.microsoft.com/library/438d5a75-7f39-4fa9-a365-d86e8ba967b6(Office.15).aspx) - - - - - - diff --git a/docs/schema/property-element-propertiestype-complextypeaction4.md b/docs/schema/property-element-propertiestype-complextypeaction4.md index 32ec5933e..a41ec8d4e 100644 --- a/docs/schema/property-element-propertiestype-complextypeaction4.md +++ b/docs/schema/property-element-propertiestype-complextypeaction4.md @@ -1,15 +1,15 @@ --- title: Property element (propertiesType complexType) +description: Describes the Property element (propertiesType complexType) and provides the usage, the element information, a definition, and the elements and attributes. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 86e5f37b-d8ec-2825-2d4d-03da34be47d0 --- -# Property element (propertiesType complexType) +# Property element (propertiesType complexType) (Action4) @@ -59,7 +59,7 @@ A property of the parent [Block element (Blocks element) (WorkflowInfo element) - + ``` ## Elements and attributes @@ -151,11 +151,3 @@ None. - - - - - - - - diff --git a/docs/schema/property-element-property-bag.md b/docs/schema/property-element-property-bag.md index 7b9973ec3..98e0eb573 100644 --- a/docs/schema/property-element-property-bag.md +++ b/docs/schema/property-element-property-bag.md @@ -1,11 +1,11 @@ --- title: Property element (Property Bag) +description: Describes the Property element (Property Bag) and provides a definition,the elements and attributes, and an example. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Property Bag Schema ms.assetid: 5f636013-7678-4aab-b006-25b8347676e0 @@ -93,11 +93,3 @@ None ## Example For an example of how this element is used, see [Property Bag Schema](property-bag-schema.md). - - - - - - - - diff --git a/docs/schema/property-element-propertybagdefinition-complextypeapphostwebfeatures.md b/docs/schema/property-element-propertybagdefinition-complextypeapphostwebfeatures.md index 6d170875f..9aeb2e045 100644 --- a/docs/schema/property-element-propertybagdefinition-complextypeapphostwebfeatures.md +++ b/docs/schema/property-element-propertybagdefinition-complextypeapphostwebfeatures.md @@ -1,28 +1,28 @@ --- title: Property element (PropertyBagDefinition complexType) +description: Describes the Property element (PropertyBagDefinition complexType) and provides the element information, a definition, and the elements and attributes. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b820d65f-12d5-8521-09c6-3db3902ca4a1 --- -# Property element (PropertyBagDefinition complexType) +# Property element (PropertyBagDefinition complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Information | Location | |---|---| -| **Element type** | PropertyValueAttributeDefinition | -| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | -| **Schema file** | apphostwebfeatures.xsd | +| **Element type** | PropertyValueAttributeDefinition | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | +| **Schema file** | apphostwebfeatures.xsd | ## Definition @@ -30,7 +30,7 @@ ms.assetid: b820d65f-12d5-8521-09c6-3db3902ca4a1 ``` -## Elements and attributes +## Elements and attributes If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. @@ -39,13 +39,13 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** None. -
    +
    ### Child elements None. -
    +
    ### Attributes @@ -91,14 +91,6 @@ None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/property-element-sitefeature.md b/docs/schema/property-element-sitefeature.md index 4af2f1aef..08e75e044 100644 --- a/docs/schema/property-element-sitefeature.md +++ b/docs/schema/property-element-sitefeature.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: @@ -17,9 +16,9 @@ description: Specifies a custom property value to implement within the Feature. # Property element (Site - Feature) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Specifies a custom property value to implement within the Feature. - + +Specifies a custom property value to implement within the Feature. + ```XML |Required **Text**. Specifies the name of the property.
    | |**Value**
    |Required **Text**. Specifies the value to which the property is set.
    | - + ### Child elements None - + ### Parent elements - [Properties](properties-element-site.md) - + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - -
    - +- Maximum: Unbounded +
    diff --git a/docs/schema/property-element-sitemodule.md b/docs/schema/property-element-sitemodule.md index 3e31eef5a..ad4412d8c 100644 --- a/docs/schema/property-element-sitemodule.md +++ b/docs/schema/property-element-sitemodule.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: - schema ms.assetid: a2494c14-25f9-4fc3-8408-42948e8cb652 -description: Specifies a custom property value to implement within the file. +description: Specifies a custom property value to implement within the file. --- # Property element (Site - Module) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Specifies a custom property value to implement within the file. - + +Specifies a custom property value to implement within the file. + ```XML |Required **Text**. Specifies the name of the property.
    | |**Value**
    |Required **Text**. Specifies the value to which the property is set.
    | - + ### Child elements None - + ### Parent elements - [File](file-element.md) - + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - -
    - +- Maximum: Unbounded +
    diff --git a/docs/schema/property-element-view.md b/docs/schema/property-element-view.md index 47f349d07..b9a1ff4cf 100644 --- a/docs/schema/property-element-view.md +++ b/docs/schema/property-element-view.md @@ -1,32 +1,31 @@ --- title: "Property element (View)" manager: soliver -ms.date: 3/9/2015 +ms.date: 03/28/2023 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: - schema ms.assetid: c01137cb-20ca-4574-b843-31d046388897 -description: Returns the property from the context of the current ForEach loop. When a view or field is selected, the Property element can be used to retrieve a specific attribute value from it. +description: Returns the property from the context of the current ForEach loop. When a view or field is selected, the Property element can be used to retrieve a specific attribute value from it. --- # Property element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Returns the property from the context of the current [ForEach](foreach-element-view.md) loop. When a view or field is selected, the **Property** element can be used to retrieve a specific attribute value from it. - + +Returns the property from the context of the current [ForEach](foreach-element-view.md) loop. When a view or field is selected, the **Property** element can be used to retrieve a specific attribute value from it. + ```XML |Optional **Boolean**. **TRUE** to surround text with `    ` tags if the text appears like a hyperlink (for example, `www.microsoft.com`).
    | -|**AutoHyperLinkNoEncoding**
    |Optional **Boolean**. **TRUE** to surround text with `    ` tags if the text appears like a hyperlink (for example, `www.microsoft.com`) but without HTML encoding.
    | -|**AutoNewLine**
    |Optional **Boolean**. **TRUE** to insert `
    ` tags into the text stream and to replace multiple spaces with a nonbreaking space (` `).
    | -|**Default**
    |Optional **Text**. Renders the text assigned to this attribute if the value returned by a selection is an empty string (`""`).
    | -|**ExpandXML**
    |Optional **Boolean**. **TRUE** to re-pass the rendered content through the Collaborative Application Markup Language (CAML) interpreter, which allows CAML to render CAML.
    | -|**HTMLEncode**
    |Optional **Boolean**. **TRUE** to convert embedded characters so that they are displayed as text in the browser. In other words, characters that could be confused with HTML tags are converted to entities.
    | -|**Name**
    |Optional **Text**. Specifies the name of the property.
    | -|**OuterLookupField**
    |Optional **Text**. Used in field definitions
    | -|**Select**
    |Required **Text**. Specifies the name of the property to select.
    | -|**StripWS**
    |Optional **Boolean**. **TRUE** to remove white space from the beginning and end of the value returned by the element.
    | -|**URLEncode**
    |Optional **Boolean**. **TRUE** to convert special characters, such as spaces, to quoted UTF-8 format (for example, `%c3%ab` for character `ë`).
    | -|**URLEncodeAsURL**
    |Optional **Boolean**. Like **URLEncode**, but **TRUE** to specify that the string to encode is a path component of a URL so that forward slashes (`/`) are not encoded.
    | - +|**AutoHyperLink** |Optional **Boolean**. **TRUE** to surround text with `    ` tags if the text appears like a hyperlink (for example, `www.microsoft.com`). | +|**AutoHyperLinkNoEncoding** |Optional **Boolean**. **TRUE** to surround text with `` tags if the text appears like a hyperlink (for example, `www.microsoft.com`) but without HTML encoding. | +|**AutoNewLine** |Optional **Boolean**. **TRUE** to insert `
    ` tags into the text stream and to replace multiple spaces with a nonbreaking space (` `). | +|**Default** |Optional **Text**. Renders the text assigned to this attribute if the value returned by a selection is an empty string (`""`). | +|**ExpandXML** |Optional **Boolean**. **TRUE** to re-pass the rendered content through the Collaborative Application Markup Language (CAML) interpreter, which allows CAML to render CAML. | +|**HTMLEncode** |Optional **Boolean**. **TRUE** to convert embedded characters so that they are displayed as text in the browser. In other words, characters that could be confused with HTML tags are converted to entities. | +|**Name** |Optional **Text**. Specifies the name of the property. | +|**OuterLookupField** |Optional **Text**. Used in field definitions | +|**Select** |Required **Text**. Specifies the name of the property to select. | +|**StripWS** |Optional **Boolean**. **TRUE** to remove white space from the beginning and end of the value returned by the element. | +|**URLEncode** |Optional **Boolean**. **TRUE** to convert special characters, such as spaces, to quoted UTF-8 format (for example, `%c3%ab` for character `ë`). | +|**URLEncodeAsURL** |Optional **Boolean**. Like **URLEncode**, but **TRUE** to specify that the string to encode is a path component of a URL so that forward slashes (`/`) are not encoded. | + ### Child elements None - + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ### Remarks -The line `` returns the body of the element in the schema that is being enumerated. For example, within a **ForEach** statement such as `` specifying `` would return the text of one of the conditionals. - -If a property cannot be found, a subelement of the current element in the schema enumeration is evaluated whose name is equal to the text specified by **Select**. For example, if a **Field** element has no property called **Default**, `` will also search for a subelement called **Default** and render its body text if found. - +The line `` returns the body of the element in the schema that is being enumerated. For example, within a **ForEach** statement such as `` specifying `` would return the text of one of the conditionals. + +If a property cannot be found, a subelement of the current element in the schema enumeration is evaluated whose name is equal to the text specified by **Select**. For example, if a **Field** element has no property called **Default**, `` will also search for a subelement called **Default** and render its body text if found. + ## Example -The following line of code returns the **Name** property from the current field or view. - +The following line of code returns the **Name** property from the current field or view. + ```XML ``` @@ -89,4 +88,3 @@ The following line of code returns the **Name** property from the current field - [ListProperty element (View)](listproperty-element-view.md) - [ProjectProperty element (View)](projectproperty-element-view.md) - diff --git a/docs/schema/propertybag-element-property-bag.md b/docs/schema/propertybag-element-property-bag.md index 5f7d7c255..6aa5f6777 100644 --- a/docs/schema/propertybag-element-property-bag.md +++ b/docs/schema/propertybag-element-property-bag.md @@ -1,11 +1,11 @@ --- title: PropertyBag Element (Property Bag) +description: Describes the PropertyBag element (Property Bag) and provides a definition, the elements and attributes, and an example. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Property Bag Schema ms.assetid: f249df32-1c9a-4d60-96e7-a97f0dd8f5f4 @@ -115,11 +115,3 @@ The following sections describe attributes, child elements, and parent elements. ## Example For an example of how this element is used, see [Property Bag Schema](property-bag-schema.md). - - - - - - - - diff --git a/docs/schema/propertybagdefinition-complextype-apphostwebfeatures.md b/docs/schema/propertybagdefinition-complextype-apphostwebfeatures.md index 7d1eb4175..78067b2f0 100644 --- a/docs/schema/propertybagdefinition-complextype-apphostwebfeatures.md +++ b/docs/schema/propertybagdefinition-complextype-apphostwebfeatures.md @@ -1,28 +1,28 @@ --- title: PropertyBagDefinition complexType +description: Describes the PropertyBagDefinition complexType and provides the type information, a definition, and the elements and attributes. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8e445cc3-7419-cd8a-befd-35b720f06815 --- -# PropertyBagDefinition complexType +# PropertyBagDefinition complexType (AppHostWebFeatures) -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +| Resource | File | |---|---| -| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | -| **Schema file** | apphostwebfeatures.xsd | -| **Extension base** | None | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | +| **Schema file** | apphostwebfeatures.xsd | +| **Extension base** | None | ## Definition @@ -130,10 +130,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs**

    - - - - - - - diff --git a/docs/schema/propertybagparenttypedefinition-simpletype-apphostwebfeatures.md b/docs/schema/propertybagparenttypedefinition-simpletype-apphostwebfeatures.md index dc8dd12b4..ff755207e 100644 --- a/docs/schema/propertybagparenttypedefinition-simpletype-apphostwebfeatures.md +++ b/docs/schema/propertybagparenttypedefinition-simpletype-apphostwebfeatures.md @@ -1,29 +1,29 @@ --- title: PropertyBagParentTypeDefinition simpleType +description: Describes the PropertyBagParentTypeDefinition simpleType and provides the type information, a definition, and the enumeration values. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 71bc7f6c-12dd-ba2e-40ba-de4be9f9c39d --- -# PropertyBagParentTypeDefinition simpleType +# PropertyBagParentTypeDefinition simpleType (AppHostWebFeatures) -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +| Resource | File | |---|---| -| **Base Type** | xs:string | -| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | -| **Schema file** | apphostwebfeatures.xsd | +| **Base Type** | xs:string | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | +| *Schema file** | apphostwebfeatures.xsd | ## Definition @@ -74,10 +74,3 @@ ms.assetid: 71bc7f6c-12dd-ba2e-40ba-de4be9f9c39d

    - - - - - - - diff --git a/docs/schema/propertybagtype-simpletype-apphostwebfeatures.md b/docs/schema/propertybagtype-simpletype-apphostwebfeatures.md index d9ff37c11..884c0baff 100644 --- a/docs/schema/propertybagtype-simpletype-apphostwebfeatures.md +++ b/docs/schema/propertybagtype-simpletype-apphostwebfeatures.md @@ -1,29 +1,29 @@ --- title: PropertyBagType simpleType +description: Describes the PropertyBagType simpleType and provides the type information, a definition, and the enumeration values. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/09/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 28cd4136-0394-13b0-a2a6-17bdc2891beb --- -# PropertyBagType simpleType +# PropertyBagType simpleType (AppHostWebFeatures) -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +| Resource | File | |---|---| -| **Base Type** | xs:string | -| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | -| **Schema file** | apphostwebfeatures.xsd | +| **Base Type** | xs:string | +| **Namespace** | `http://schemas.microsoft.com/sharepoint/` | +| **Schema file** | apphostwebfeatures.xsd | ## Definition @@ -69,10 +69,3 @@ ms.assetid: 28cd4136-0394-13b0-a2a6-17bdc2891beb

    - - - - - - - diff --git a/docs/schema/propertyname-element-propertyrule-complextypesps15xsdsearchset2.md b/docs/schema/propertyname-element-propertyrule-complextypesps15xsdsearchset2.md index bb1969fcf..75bf82c88 100644 --- a/docs/schema/propertyname-element-propertyrule-complextypesps15xsdsearchset2.md +++ b/docs/schema/propertyname-element-propertyrule-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "PropertyName element (PropertyRule complexType) (SPS15XSDSearchSet2)" +description: Describes the PropertyName element (PropertyRule complexType) (SPS15XSDSearchSet2) and provides the element information, a definition, and the elements and attributes. manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 41558fa1-925c-3c33-7391-aab06e42fdd0 -description: "Last modified: March 09, 2015" --- # PropertyName element (PropertyRule complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |xs:string
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +| **Element type** |xs:string
    | +| **Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | +| **Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd
    | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/propertyoperator-element-propertyrule-complextypesps15xsdsearchset2.md b/docs/schema/propertyoperator-element-propertyrule-complextypesps15xsdsearchset2.md index 77ed548c2..e80a5755e 100644 --- a/docs/schema/propertyoperator-element-propertyrule-complextypesps15xsdsearchset2.md +++ b/docs/schema/propertyoperator-element-propertyrule-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "PropertyOperator element (PropertyRule complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the PropertyOperator element (PropertyRule complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 15ffbb16-0a08-3102-ad8f-59e3996f840f -description: "Last modified: March 09, 2015" --- # PropertyOperator element (PropertyRule complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:PropertyRuleOperator
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:PropertyRuleOperator| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/propertyrule-complextype-sps15xsdsearchset2.md b/docs/schema/propertyrule-complextype-sps15xsdsearchset2.md index 31ce717f8..0fbed91c5 100644 --- a/docs/schema/propertyrule-complextype-sps15xsdsearchset2.md +++ b/docs/schema/propertyrule-complextype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "PropertyRule complexType (SPS15XSDSearchSet2)" +description: "Describes the definition, type, element, and attribute information for the PropertyRule complexType (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 300ff8c8-f118-9c05-248c-fcfbd9585a22 -description: "Last modified: March 09, 2015" --- # PropertyRule complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |None
    | - +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| +|**Extension base**|None| + ## Definition ```XML @@ -38,8 +37,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -48,9 +47,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[PropertyOperator](propertyoperator-element-propertyrule-complextypesps15xsdsearchset2.md)
    |tns:PropertyRuleOperator
    || |[PropertyValues](propertyvalues-element-propertyrule-complextypesps15xsdsearchset2.md)
    |q1:ArrayOfstring
    || |[RuleNameLSID](rulenamelsid-element-propertyrule-complextypesps15xsdsearchset2.md)
    |q2:LocStringId
    || - + ### Attributes None. - - diff --git a/docs/schema/propertyrule-element-arrayofpropertyrule-complextypesps15xsdsearchset2.md b/docs/schema/propertyrule-element-arrayofpropertyrule-complextypesps15xsdsearchset2.md index 9295626c8..6a0691431 100644 --- a/docs/schema/propertyrule-element-arrayofpropertyrule-complextypesps15xsdsearchset2.md +++ b/docs/schema/propertyrule-element-arrayofpropertyrule-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "PropertyRule element (ArrayOfPropertyRule complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the PropertyRule element (ArrayOfPropertyRule complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 02e69943-0418-6cd0-61a4-0cf2603c8cae -description: "Last modified: March 09, 2015" --- # PropertyRule element (ArrayOfPropertyRule complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:PropertyRule
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:PropertyRule| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/propertyrule-element-sps15xsdsearchset2.md b/docs/schema/propertyrule-element-sps15xsdsearchset2.md index bdc78bc61..4a4797d33 100644 --- a/docs/schema/propertyrule-element-sps15xsdsearchset2.md +++ b/docs/schema/propertyrule-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "PropertyRule element (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the PropertyRule element (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8421bb58-3cfc-3236-b8b4-19a60e0c64b7 -description: "Last modified: March 09, 2015" --- # PropertyRule element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:PropertyRule
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:PropertyRule| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/propertyrulecollection-complextype-sps15xsdsearchset2.md b/docs/schema/propertyrulecollection-complextype-sps15xsdsearchset2.md index bc8cb8db9..f423283dd 100644 --- a/docs/schema/propertyrulecollection-complextype-sps15xsdsearchset2.md +++ b/docs/schema/propertyrulecollection-complextype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "PropertyRuleCollection complexType (SPS15XSDSearchSet2)" +description: "Describes the definition, type, element, and attribute information for the PropertyRuleCollection complexType (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c055590f-4dbb-62fa-0eab-6d80c903d15a -description: "Last modified: March 09, 2015" --- # PropertyRuleCollection complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |None
    | - +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| +|**Extension base**|None| + ## Definition ```XML @@ -35,16 +34,14 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| |:-----|:-----|:-----| -|[PropertyRules](propertyrules-element-propertyrulecollection-complextypesps15xsdsearchset2.md)
    |tns:ArrayOfPropertyRule
    || - +|[PropertyRules](propertyrules-element-propertyrulecollection-complextypesps15xsdsearchset2.md)|tns:ArrayOfPropertyRule|| + ### Attributes None. - - diff --git a/docs/schema/propertyrulecollection-element-sps15xsdsearchset2.md b/docs/schema/propertyrulecollection-element-sps15xsdsearchset2.md index 288afedb4..4c857b7a0 100644 --- a/docs/schema/propertyrulecollection-element-sps15xsdsearchset2.md +++ b/docs/schema/propertyrulecollection-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "PropertyRuleCollection element (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the PropertyRuleCollection element (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9e2c35d4-3f39-e9eb-cab1-4868a7b8b771 -description: "Last modified: March 09, 2015" --- # PropertyRuleCollection element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |tns:PropertyRuleCollection
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/propertyruleoperator-complextype-sps15xsdsearchset2.md b/docs/schema/propertyruleoperator-complextype-sps15xsdsearchset2.md index 1cb6decd4..a19e40788 100644 --- a/docs/schema/propertyruleoperator-complextype-sps15xsdsearchset2.md +++ b/docs/schema/propertyruleoperator-complextype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "PropertyRuleOperator complexType (SPS15XSDSearchSet2)" +description: "Describes the definition, type, element, and attribute information for the PropertyRuleOperator complexType (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c5f383ac-7e8e-a38e-4ccf-f509965f4789 -description: "Last modified: March 09, 2015" --- # PropertyRuleOperator complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |None
    | - +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| +|**Extension base**|None| + ## Definition ```XML @@ -41,8 +40,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -54,9 +53,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[Name](name-element-propertyruleoperator-complextypesps15xsdsearchset2.md)
    |xs:string
    || |[NameLSID](namelsid-element-propertyruleoperator-complextypesps15xsdsearchset2.md)
    |q4:LocStringId
    || |[Representation](representation-element-propertyruleoperator-complextypesps15xsdsearchset2.md)
    |xs:string
    || - + ### Attributes None. - - diff --git a/docs/schema/propertyruleoperator-element-sps15xsdsearchset2.md b/docs/schema/propertyruleoperator-element-sps15xsdsearchset2.md index 9f2e0c8d3..2768bca7a 100644 --- a/docs/schema/propertyruleoperator-element-sps15xsdsearchset2.md +++ b/docs/schema/propertyruleoperator-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "PropertyRuleOperator element (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the PropertyRuleOperator element (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 40c7716f-b303-b4b1-630d-5bbf5fa1815a -description: "Last modified: March 09, 2015" --- # PropertyRuleOperator element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:PropertyRuleOperator
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:PropertyRuleOperator| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/propertyrules-element-propertyrulecollection-complextypesps15xsdsearchset2.md b/docs/schema/propertyrules-element-propertyrulecollection-complextypesps15xsdsearchset2.md index 7bbf543a3..d650c60df 100644 --- a/docs/schema/propertyrules-element-propertyrulecollection-complextypesps15xsdsearchset2.md +++ b/docs/schema/propertyrules-element-propertyrulecollection-complextypesps15xsdsearchset2.md @@ -1,48 +1,41 @@ --- title: "PropertyRules element (PropertyRuleCollection complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the PropertyRules element (PropertyRuleCollection complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/28/2022 ms.audience: ITPro -ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.topic: conceptual +ms.localizationpriority: medium ms.assetid: 9594a45e-b0b6-741b-b416-98cd770236ea -description: "Last modified: March 09, 2015" --- - # PropertyRules element (PropertyRuleCollection complexType) (SPS15XSDSearchSet2) - - ## Element information -||| -|:-----|:-----| -|**Element type**
    |tns:ArrayOfPropertyRule
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +| Information | Location | +| :--------------- | :------------------------------------------------------------------------------------ | +| **Element type** | tns:ArrayOfPropertyRule | +| **Namespace** | http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +| **Schema file** | schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition -```XML +```xml - ``` ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/propertyschema-element-field-types.md b/docs/schema/propertyschema-element-field-types.md index fa88cfeb8..7104959a1 100644 --- a/docs/schema/propertyschema-element-field-types.md +++ b/docs/schema/propertyschema-element-field-types.md @@ -6,28 +6,27 @@ ms.audience: Developer ms.topic: reference keywords: - field type definition schema, propertyschema element (field types) -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Field Types XML ms.assetid: 5723244b-2041-4424-97e5-8dbd828ecdf7 -description: Represents the schema of certain special variable properties of a custom field type, with each property defined as a Field element. +description: Represents the schema of certain special variable properties of a custom field type, with each property defined as a Field element. --- # PropertySchema element (Field Types) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 -Represents the schema of certain special variable properties of a custom field type, with each property defined as a **Field** element. - +Represents the schema of certain special variable properties of a custom field type, with each property defined as a **Field** element. + ```XML ``` > [!IMPORTANT] -> This topic describes markup that was used in an obsolete method of rendering custom field type properties. It is provided solely to assist with the debugging of custom field type properties developed against earlier versions of SharePoint Foundation. For information about the recommended method, see [Custom Field Type Property Rendering](https://msdn.microsoft.com/library/a959ad5b-6f3a-462c-80b9-e2d00bb0d62a%28Office.15%29.aspx). - +> This topic describes markup that was used in an obsolete method of rendering custom field type properties. It is provided solely to assist with the debugging of custom field type properties developed against earlier versions of SharePoint Foundation. For information about the recommended method, see [Custom Field Type Property Rendering](https://msdn.microsoft.com/library/a959ad5b-6f3a-462c-80b9-e2d00bb0d62a%28Office.15%29.aspx). + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -35,46 +34,46 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [Fields element (Field Types Property Schema)](fields-element-field-types-property-schema.md) - + ### Parent elements - [FieldType element (Field Types)](fieldtype-element-field-types.md) - + ### Remarks -Custom field types may have special properties whose value will vary from one column based on the field type to another column based on the same field type. Consider a custom regular expression field type that is designed to hold [String](https://msdn2.microsoft.com/library/s1wwdcbf) values that match a certain regular expression, such as `^(\d{3})\d{3}-\d{4}$` for American telephone numbers. +Custom field types may have special properties whose value will vary from one column based on the field type to another column based on the same field type. Consider a custom regular expression field type that is designed to hold [String](https://msdn2.microsoft.com/library/s1wwdcbf) values that match a certain regular expression, such as `^(\d{3})\d{3}-\d{4}$` for American telephone numbers. + +Rather than create separate custom regular expression field types for British license plate numbers, American Social Security numbers, Chinese telephone numbers, etc., it is more efficient to create a single regular expression field type and enable users who create columns based on the field type to set the regular expression that needs to be matched on a column-by-column basis. For example, a user creating a "US Telephone Number" column would set the column's regular expression to the string above. Another user, creating a "Brazilian Post Box" column would set his column's regular expression to `^\d{5}\-\d{3}$`. + +To do this, the custom field needs to have a **RegularExpression** property that is rendered in an editable control on the user interface (UI) when a new column is created. In SharePoint Foundation, this is in the **Additional Column Settings** section on the **New Site Column** page and the **Create Column** page. The **PropertySchema** element in the `fldtypes*.xml` file is where such variable properties are declared and given a default rendering schema. Optionally, they can also be given default values. -Rather than create separate custom regular expression field types for British license plate numbers, American Social Security numbers, Chinese telephone numbers, etc., it is more efficient to create a single regular expression field type and enable users who create columns based on the field type to set the regular expression that needs to be matched on a column-by-column basis. For example, a user creating a "US Telephone Number" column would set the column's regular expression to the string above. Another user, creating a "Brazilian Post Box" column would set his column's regular expression to `^\d{5}\-\d{3}$`. - -To do this, the custom field needs to have a **RegularExpression** property that is rendered in an editable control on the user interface (UI) when a new column is created. In SharePoint Foundation, this is in the **Additional Column Settings** section on the **New Site Column** page and the **Create Column** page. The **PropertySchema** element in the `fldtypes*.xml` file is where such variable properties are declared and given a default rendering schema. Optionally, they can also be given default values. - > [!NOTE] -> If you define the variable properties of the custom field type in the **PropertySchema** element, SharePoint Foundation automatically renders those properties based on the schema. - +> If you define the variable properties of the custom field type in the **PropertySchema** element, SharePoint Foundation automatically renders those properties based on the schema. + ## Example -The following example defines a property schema for a custom field type called **RegularExpressionMatch**. The schema declares a field for use by column creators when they base a column on the field type. The purpose of the field is to enable a column creator to set a *different* regular expression for each column she bases on the RegularExpressionMatch field type. - -The **DisplayName** and an editable **Text** field will appear in the **Additional Column Settings** section on the **New Site Column** page and the **Create Column** page. The **MaxLength** attribute sets the maximum length, in characters, of the regular expression, and the **DisplaySize** sets the size of the field that holds it. Users can scroll within the field to see the rest of the regular expression if it is longer than **DisplaySize**. - +The following example defines a property schema for a custom field type called **RegularExpressionMatch**. The schema declares a field for use by column creators when they base a column on the field type. The purpose of the field is to enable a column creator to set a *different* regular expression for each column she bases on the RegularExpressionMatch field type. + +The **DisplayName** and an editable **Text** field will appear in the **Additional Column Settings** section on the **New Site Column** page and the **Create Column** page. The **MaxLength** attribute sets the maximum length, in characters, of the regular expression, and the **DisplaySize** sets the size of the field that holds it. Users can scroll within the field to see the rest of the regular expression if it is longer than **DisplaySize**. + No default has been set in this example, but if the developer of the field type knew that in most cases it would be used to create columns containing American telephone numbers, the developer could set the default as `^(\d{3})\d{3}-\d{4}$`. - + The following code example has been edited for clarity. - + ```XML RegularExpressionMatch … - @@ -86,7 +85,7 @@ The following code example has been edited for clarity. ## See also -- [Custom Field Types](https://msdn.microsoft.com/library/1345b345-226d-443a-918f-af123a3c7b13%28Office.15%29.aspx) -- [Custom Field Classes](https://msdn.microsoft.com/library/436a9d9b-7a6f-4e8f-86e8-f42ded85c069%28Office.15%29.aspx) -- [Custom Field Type Property Rendering](https://msdn.microsoft.com/library/a959ad5b-6f3a-462c-80b9-e2d00bb0d62a%28Office.15%29.aspx) -- [Custom Field Type Definition](https://msdn.microsoft.com/library/b3315997-671f-4c29-9518-48cc4592f205%28Office.15%29.aspx) +- [Custom Field Types](https://msdn.microsoft.com/library/1345b345-226d-443a-918f-af123a3c7b13%28Office.15%29.aspx) +- [Custom Field Classes](https://msdn.microsoft.com/library/436a9d9b-7a6f-4e8f-86e8-f42ded85c069%28Office.15%29.aspx) +- [Custom Field Type Property Rendering](https://msdn.microsoft.com/library/a959ad5b-6f3a-462c-80b9-e2d00bb0d62a%28Office.15%29.aspx) +- [Custom Field Type Definition](https://msdn.microsoft.com/library/b3315997-671f-4c29-9518-48cc4592f205%28Office.15%29.aspx) diff --git a/docs/schema/propertyvalueattributedefinition-complextype-apphostwebfeatures.md b/docs/schema/propertyvalueattributedefinition-complextype-apphostwebfeatures.md index 92e04a3a7..220efd879 100644 --- a/docs/schema/propertyvalueattributedefinition-complextype-apphostwebfeatures.md +++ b/docs/schema/propertyvalueattributedefinition-complextype-apphostwebfeatures.md @@ -1,24 +1,24 @@ --- title: PropertyValueAttributeDefinition complexType +description: Describes the definition, type, element, and attribute information for the PropertyValueAttributeDefinition complexType. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 124616c4-9d87-64b7-e9e8-2f49a9a5ab58 --- -# PropertyValueAttributeDefinition complexType +# PropertyValueAttributeDefinition complexType (AppHostWebFeatures) -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +|Information|Location| |---|---| | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | | **Schema file** | apphostwebfeatures.xsd | @@ -93,10 +93,3 @@ None.

    - - - - - - - diff --git a/docs/schema/propertyvalues-element-propertyrule-complextypesps15xsdsearchset2.md b/docs/schema/propertyvalues-element-propertyrule-complextypesps15xsdsearchset2.md index 7a89910fe..cb1225024 100644 --- a/docs/schema/propertyvalues-element-propertyrule-complextypesps15xsdsearchset2.md +++ b/docs/schema/propertyvalues-element-propertyrule-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "PropertyValues element (PropertyRule complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the PropertyValues element (PropertyRule complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9894c725-7b66-8a63-c6bf-5105c97e88e3 -description: "Last modified: March 09, 2015" --- # PropertyValues element (PropertyRule complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |q1:ArrayOfstring
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|q1:ArrayOfstring| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/propset-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/propset-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md index 730fd40db..54dca07da 100644 --- a/docs/schema/propset-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/propset-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Propset element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the Propset element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 412c8627-15da-2551-d84a-82127b6e321c -description: "Last modified: March 09, 2015" --- # Propset element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |ser:guid
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|ser:guid| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/providerid-element-source-complextypesps15xsdsearchset1.md b/docs/schema/providerid-element-source-complextypesps15xsdsearchset1.md index 5347aaa63..168fd50df 100644 --- a/docs/schema/providerid-element-source-complextypesps15xsdsearchset1.md +++ b/docs/schema/providerid-element-source-complextypesps15xsdsearchset1.md @@ -1,27 +1,26 @@ --- title: "ProviderId element (Source complexType) (SPS15XSDSearchSet1)" +description: "Describes the definition, element, and attribute information for the ProviderId element (Source complexType) (SPS15XSDSearchSet1)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 3813f189-967b-b672-af26-e6a445f82f31 -description: "Last modified: March 09, 2015" --- # ProviderId element (Source complexType) (SPS15XSDSearchSet1) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |ser:guid
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.Query.xsd
    | - +|**Element type**|ser:guid| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.Query.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/proxy-element-in-lobsystem-bdcmetadata-schema.md b/docs/schema/proxy-element-in-lobsystem-bdcmetadata-schema.md index e95f2738e..6200acc24 100644 --- a/docs/schema/proxy-element-in-lobsystem-bdcmetadata-schema.md +++ b/docs/schema/proxy-element-in-lobsystem-bdcmetadata-schema.md @@ -1,17 +1,17 @@ --- title: Proxy element in LobSystem +description: Proxy element in LobSystem specifies a user-provided proxy that is identical to the one that would be generated if this element were not present. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.Proxy -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8ec2e7b0-156f-ff4a-a87b-fe5764e4875b --- -# Proxy element in LobSystem +# Proxy element in LobSystem (BDCMetadata Schema) @@ -23,6 +23,8 @@ Specifies a user-provided proxy that is identical to the one that would be gener **Schema**: BDCMetadata +## Definition + ```XML ``` @@ -41,33 +43,10 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    LobSystem Element in LobSystems (BDCMetadata Schema)

    The **LobSystem** element that this proxy applies to.

    +|Element|Description| +|-------|-----------| +[LobSystem Element in LobSystems (BDCMetadata Schema)](lobsystem-element-in-lobsystems-bdcmetadata-schema.md)|The **LobSystem** element that this proxy applies to.| ## Text value **String** - - - - - - - - diff --git a/docs/schema/qat-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/qat-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index 18e6cf219..1b014af95 100644 --- a/docs/schema/qat-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/qat-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,24 +1,24 @@ --- title: QAT element (CommandUIDefinitionType complexType) +description: Describes the definition, element, and attribute information for the QAT element (CommandUIDefinitionType complexType). manager: soliver -ms.date: 9/16/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 44a8617a-eb05-bbb2-fcb0-61e6a9f4d246 --- -# QAT element (CommandUIDefinitionType complexType) +# QAT element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +|Information|Location| |---|---| | **Element type** | QATType | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | @@ -37,27 +37,9 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** ### Parent elements - ----- - - - - - - - - - - - - - - -

    Element

    Type

    Description

    CommandUIDefinition

    CommandUIDefinitionType

    +|Element|Type|Description| +|-------|----|-----------| +|[CommandUIDefinition](commanduidefinition-element-commanduidefinitionstype-complextypeapphostwebfeatur.md)|[CommandUIDefinitionType](commanduidefinitiontype-complextype-apphostwebfeatures.md)|| ### Child elements @@ -66,15 +48,3 @@ None. ### Attributes None. - -
    - -
    - - - - - - - - diff --git a/docs/schema/qat-element.md b/docs/schema/qat-element.md index 189f29726..71bf14a2c 100644 --- a/docs/schema/qat-element.md +++ b/docs/schema/qat-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines a quick-access toolbar. # QAT element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a quick-access toolbar. - + ```XML |Optional. The name of a CSS class selector to be applied to the up arrow image.
    | |**ImageUpArrowLeft**
    |Optional. A negative integer that represents an offset for the left edge of the image. Use this attribute when the **ImageUpArrow** attribute points to an image file that contains the images for many icons. The value of the **ImageUpArrowLeft** attribute is used to set the CSS **left** attribute for the inline style of an HTML **img** tag when the page is created.
    | |**ImageUpArrowTop**
    |Optional. A negative integer that represents an offset for the top edge of the image. Use this attribute when the **ImageUpArrow** attribute points to an image file that contains the images for many icons. The value of the **ImageUpArrowTop** attribute is used to set the CSS **top** attribute for the inline style of an HTML **img** tag when the page is created.
    | - + ### Child elements - [Controls](controls-element-group.md) - + ### Parent elements - [CommandUI](commandui-element.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - - +- Maximum: 1 diff --git a/docs/schema/queries-element-in-subscription-subscription-schema.md b/docs/schema/queries-element-in-subscription-subscription-schema.md index a294709ea..c6436b529 100644 --- a/docs/schema/queries-element-in-subscription-subscription-schema.md +++ b/docs/schema/queries-element-in-subscription-subscription-schema.md @@ -1,15 +1,15 @@ --- title: Queries Element in Subscription +description: Describes the elements and attributes for Queries Element in Subscription, which is a list of queries that this cache subscription contains. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d094da28-8be1-a1fb-27f0-bd842044ad93 --- -# Queries Element in Subscription +# Queries Element in Subscription (Subscription Schema) @@ -35,50 +35,12 @@ None. ### Child elements - ---- - - - - - - - - - - - - -

    Element

    Description

    Query Element in Queries (Subscription Schema)

    A query (**Finder** or **IDEnumerator** method instance) that returns the external items to populate in the cache.

    +| Element | Description | +|---------|-------------| +| [Query Element in Queries (Subscription Schema)](query-element-in-queries-subscription-schema.md) | A query (**Finder** or **IDEnumerator** method instance) that returns the external items to populate in the cache. | ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    Subscription Element (Subscription Schema)

    The cache subscription that contains this list of queries.

    - - - - - - - - +| Element | Description | +|---------|-------------| +| [Subscription Element (Subscription Schema)](subscription-element-subscription-schema.md) | The cache subscription that contains this list of queries. | diff --git a/docs/schema/query-element-alerttemplates.md b/docs/schema/query-element-alerttemplates.md index 9c0c0c165..cad282674 100644 --- a/docs/schema/query-element-alerttemplates.md +++ b/docs/schema/query-element-alerttemplates.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - AlertTemplates schema api_type: @@ -17,9 +16,9 @@ description: Specifies a query for the alert template filter. # Query element (AlertTemplates) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Specifies a query for the alert template filter. Define the query element inside the filter by using Collaborative Application Markup Language (CAML). For more information about CAML query schema, see [Query schema](query-schema.md). The **Query** element in the Alerts schema contains no **Where** element. - + +Specifies a query for the alert template filter. Define the query element inside the filter by using Collaborative Application Markup Language (CAML). For more information about CAML query schema, see [Query schema](query-schema.md). The **Query** element in the Alerts schema contains no **Where** element. + ```XML @@ -38,18 +37,16 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -- [GroupBy](groupby-element-query.md) -- [OrderBy](orderby-element-query.md) - +- [GroupBy](groupby-element-query.md) +- [OrderBy](orderby-element-query.md) + ### Parent elements - [FilterDefinition](filterdefinition-element-alerttemplates.md) - + ## Example For an example of how this element is used, see [FilterDefinition element (AlertTemplates)](filterdefinition-element-alerttemplates.md). - - diff --git a/docs/schema/query-element-deploymentmanifestspview.md b/docs/schema/query-element-deploymentmanifestspview.md index 93235184f..bb0c03536 100644 --- a/docs/schema/query-element-deploymentmanifestspview.md +++ b/docs/schema/query-element-deploymentmanifestspview.md @@ -1,20 +1,19 @@ --- title: "Query Element (DeploymentManifest - SPView)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 27ffcb1d-70c2-4a3f-b495-ed613a4e6b00 -description: "Last modified: March 09, 2015" +description: "Describes the Query Element, which represents a query on an instance of a Windows SharePoint Services 3.0 view SPView object." --- # Query Element (DeploymentManifest - SPView) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a query on an instance of a Windows SharePoint Services 3.0 view ([SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a query on an instance of a Windows SharePoint Services 3.0 view ([SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx)) object. ## Definition @@ -32,7 +31,7 @@ USAGE ## Type xs:string - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -40,17 +39,16 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements [View Element (DeploymentManifest)](view-element-deploymentmanifest.md) - + ## See also - [SPQuery](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPQuery.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/query-element-deploymentmanifestspwebpart.md b/docs/schema/query-element-deploymentmanifestspwebpart.md index 0ed9c8e81..18d983509 100644 --- a/docs/schema/query-element-deploymentmanifestspwebpart.md +++ b/docs/schema/query-element-deploymentmanifestspwebpart.md @@ -1,20 +1,19 @@ --- title: "Query Element (DeploymentManifest - SPWebPart)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6f38c731-c8b2-44e4-8292-b65f888870c8 -description: "Last modified: March 09, 2015" +description: "Describes the Query Element (DeploymentManifest - SPWebPart), which represents a query on an instance of a Windows SharePoint Services 3.0 view SPView object." --- # Query Element (DeploymentManifest - SPWebPart) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a query on an instance of a Windows SharePoint Services 3.0 web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents a query on an instance of a Windows SharePoint Services 3.0 web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)) object. ## Definition @@ -32,7 +31,7 @@ USAGE ## Type xs:string - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -40,21 +39,20 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements [WebPart Element (DeploymentManifest)](webpart-element-deploymentmanifest.md) - + ### Remarks -Web Parts can derive from either of two base classes - an ASP.NET web part ([WebPart](https://msdn.microsoft.com/library/System.Web.UI.WebControls.WebParts.WebPart.aspx)), or a SharePoint Foundation web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)). - +Web Parts can derive from either of two base classes - an ASP.NET web part ([WebPart](https://msdn.microsoft.com/library/System.Web.UI.WebControls.WebParts.WebPart.aspx)), or a SharePoint Foundation web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)). + ## See also - [SPQuery](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPQuery.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/query-element-in-queries-subscription-schema.md b/docs/schema/query-element-in-queries-subscription-schema.md index 052f5ce6b..9ad2ed314 100644 --- a/docs/schema/query-element-in-queries-subscription-schema.md +++ b/docs/schema/query-element-in-queries-subscription-schema.md @@ -1,15 +1,15 @@ --- title: Query Element in Queries manager: soliver -ms.date: 3/9/2015 +description: Describes the Query element in Queries, which specifies a Finder or IDEnumerator method instance to execute to populate the cache. +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2de9afb8-7c23-7f22-a48b-07a4f31154cc --- -# Query Element in Queries +# Query Element in Queries (Subscription Schema) @@ -84,58 +84,14 @@ The following sections describe attributes, child elements, and parent elements. ### Child elements - ---- - - - - - - - - - - - - - - - - - - - - -

    Element

    Description

    LocalizedDisplayNames Element in MetadataObject (Subscription Schema)

    A list of localized display names for this query.

    Properties Element in MetadataObject (Subscription Schema)

    This is not used by Business Connectivity Services in this release.

    FilterValues Element in Query (Subscription Schema)

    A list of filter values for the **Finder** or the **IDEnumerator** method instance.

    +|Element|Description| +| --- | --- | +|[LocalizedDisplayNames Element in MetadataObject (Subscription Schema)](localizeddisplaynames-element-in-metadataobject-subscription-schema.md)|A list of localized display names for this query.| +|[Properties Element in MetadataObject (Subscription Schema)](properties-element-in-metadataobject-subscription-schema.md)|This is not used by Business Connectivity Services in this release.| +|[FilterValues Element in Query (Subscription Schema)](filtervalues-element-in-query-subscription-schema.md)|A list of filter values for the **Finder** or the **IDEnumerator** method instance.| ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    Queries Element in Subscription (Subscription Schema)

    The list of queries that contains this query.

    - - - - - - - - +|Element|Description| +| --- | --- | +|[Queries Element in Subscription (Subscription Schema)](queries-element-in-subscription-subscription-schema.md)|The list of queries that contains this query.| diff --git a/docs/schema/query-element-list.md b/docs/schema/query-element-list.md index 1ccf57117..6faec7e4f 100644 --- a/docs/schema/query-element-list.md +++ b/docs/schema/query-element-list.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: @@ -17,9 +16,9 @@ description: Defines the query for a view. # Query element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines the query for a view. - + ```XML ... @@ -39,26 +38,26 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [GroupBy](groupby-element-query.md) - [OrderBy](orderby-element-query.md) - [Where](where-element-query.md) - + ### Parent elements - [View](view-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ## Example -The following example queries the Status field for cases where the value does not equal Completed or is **null**, returning the results according to a descending sort on the Modified field. The **Where** element contains an **Or** element to group the filters. - +The following example queries the Status field for cases where the value does not equal Completed or is **null**, returning the results according to a descending sort on the Modified field. The **Where** element contains an **Or** element to group the filters. + ```XML @@ -82,4 +81,3 @@ The following example queries the Status field for cases where the value does no - [Query schema](query-schema.md) - [List Views](https://msdn.microsoft.com/library/43e6ba7e-eddb-418a-a570-c0815016fc17%28Office.15%29.aspx) - diff --git a/docs/schema/query-schema.md b/docs/schema/query-schema.md index 2a96a86c2..a5f2f6948 100644 --- a/docs/schema/query-schema.md +++ b/docs/schema/query-schema.md @@ -4,7 +4,7 @@ manager: soliver ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -localization_priority: Normal +ms.localizationpriority: medium api_name: - Query schema api_type: diff --git a/docs/schema/queryable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/queryable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md index c275e82ff..77ed5c71f 100644 --- a/docs/schema/queryable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/queryable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Queryable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the Queryable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 83d34fdd-fc4e-a20f-af5d-986f9e228452 -description: "Last modified: March 09, 2015" --- # Queryable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |xs:boolean
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:boolean| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/queryactionenableonclickthroughoptions-element-sps15xsdsearchset4.md b/docs/schema/queryactionenableonclickthroughoptions-element-sps15xsdsearchset4.md index 79bb5e0d3..f27aec9f7 100644 --- a/docs/schema/queryactionenableonclickthroughoptions-element-sps15xsdsearchset4.md +++ b/docs/schema/queryactionenableonclickthroughoptions-element-sps15xsdsearchset4.md @@ -1,29 +1,28 @@ --- title: "QueryActionEnableOnClickThroughOptions element (SPS15XSDSearchSet4)" +description: "Describes the definition, element, and attribute information for the QueryActionEnableOnClickThroughOptions element (SPS15XSDSearchSet4)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 83703acf-7f6f-7895-e38b-ec6ec5cb5412 -description: "Last modified: March 09, 2015" --- # QueryActionEnableOnClickThroughOptions element (SPS15XSDSearchSet4) - - + + **Applies to:** SharePoint Server 2013 - + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |tns:QueryActionEnableOnClickThroughOptions
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query.Rules
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.Rules.xsd
    | - +|**Element type**|tns:QueryActionEnableOnClickThroughOptions| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query.Rules| +|**Schema file**|schema_Microsoft.Office.Server.Search.Query.Rules.xsd| + ## Definition ```XML @@ -33,18 +32,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/queryactionenableonclickthroughoptions-simpletype-sps15xsdsearchset4.md b/docs/schema/queryactionenableonclickthroughoptions-simpletype-sps15xsdsearchset4.md index 14eff3da7..135b2eb8b 100644 --- a/docs/schema/queryactionenableonclickthroughoptions-simpletype-sps15xsdsearchset4.md +++ b/docs/schema/queryactionenableonclickthroughoptions-simpletype-sps15xsdsearchset4.md @@ -1,34 +1,31 @@ --- title: "QueryActionEnableOnClickThroughOptions simpleType (SPS15XSDSearchSet4)" +description: "Describes the definition and type information for QueryActionEnableOnClickThroughOptions simpleType (SPS15XSDSearchSet4)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1eb2d949-3633-a49e-8ed7-629cbcdf165d -description: "Last modified: March 09, 2015" --- # QueryActionEnableOnClickThroughOptions simpleType (SPS15XSDSearchSet4) - - + + **Applies to:** SharePoint Server 2013 - + ## Type information -||| +| Information | Location | |:-----|:-----| -|**Base type**
    || -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query.Rules
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.Rules.xsd
    | - +|**Base type**|| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query.Rules| +|**Schema file**|schema_Microsoft.Office.Server.Search.Query.Rules.xsd| + ## Definition ```XML ``` - - diff --git a/docs/schema/queryauthenticationtype-element-sps15xsdsearchset5.md b/docs/schema/queryauthenticationtype-element-sps15xsdsearchset5.md index ef3819258..3e1196f92 100644 --- a/docs/schema/queryauthenticationtype-element-sps15xsdsearchset5.md +++ b/docs/schema/queryauthenticationtype-element-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "QueryAuthenticationType element (SPS15XSDSearchSet5)" +description: "Describes the definition, element, and attribute information for the QueryAuthenticationType element (SPS15XSDSearchSet5)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 0a887ad1-e333-74c4-dc05-d53ba1f797ab -description: "Last modified: March 09, 2015" --- # QueryAuthenticationType element (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |tns:QueryAuthenticationType
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Element type**|tns:QueryAuthenticationType| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query| +|**Schema file**|schema_Microsoft.Office.Server.Search.Query.xsd| + ## Definition ```XML @@ -33,18 +32,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/queryauthenticationtype-simpletype-sps15xsdsearchset5.md b/docs/schema/queryauthenticationtype-simpletype-sps15xsdsearchset5.md index 381ec17d3..c0317fb99 100644 --- a/docs/schema/queryauthenticationtype-simpletype-sps15xsdsearchset5.md +++ b/docs/schema/queryauthenticationtype-simpletype-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "QueryAuthenticationType simpleType (SPS15XSDSearchSet5)" +description: "Describes the definition, type information, and enumeration values for QueryAuthenticationType simpleType (SPS15XSDSearchSet5)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9a7a4dd1-a39e-1873-2b39-7570365739c5 -description: "Last modified: March 09, 2015" --- # QueryAuthenticationType simpleType (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Type information -||| +| Information | Location | |:-----|:-----| -|**Base type**
    |xs:string
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Base type**|xs:string| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query| +|**Schema file**|schema_Microsoft.Office.Server.Search.Query.xsd| + ## Definition ```XML @@ -42,5 +41,3 @@ description: "Last modified: March 09, 2015" |:-----|:-----| |NtAuthenticatedQuery
    || |PluggableAuthenticatedQuery
    || - - diff --git a/docs/schema/queryhint-element-sps15xsdsearchset5.md b/docs/schema/queryhint-element-sps15xsdsearchset5.md index b991946fe..7b4aced27 100644 --- a/docs/schema/queryhint-element-sps15xsdsearchset5.md +++ b/docs/schema/queryhint-element-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "QueryHint element (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: cc5c3d1d-e52d-5f91-2283-886131fd6a49 -description: "Last modified: March 09, 2015" +description: "Describes the QueryHint element (SPS15XSDSearchSet5). Applies to SharePoint Server 2013." --- # QueryHint element (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Info type|Value| |:-----|:-----| |**Element type**
    |tns:QueryHint
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - + ## Definition ```XML @@ -33,18 +32,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/queryhint-simpletype-sps15xsdsearchset5.md b/docs/schema/queryhint-simpletype-sps15xsdsearchset5.md index a9c03d06e..191e86c32 100644 --- a/docs/schema/queryhint-simpletype-sps15xsdsearchset5.md +++ b/docs/schema/queryhint-simpletype-sps15xsdsearchset5.md @@ -1,34 +1,31 @@ --- title: "QueryHint simpleType (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 463310c8-5d92-fde2-ea05-d8410bb08c5f -description: "Last modified: March 09, 2015" +description: "Describes the QueryHint simpleType (SPS15XSDSearchSet5). Applies to SharePoint Server 2013." --- # QueryHint simpleType (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Type information -||| +|Info type|Value| |:-----|:-----| |**Base type**
    || |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - + ## Definition ```XML ``` - - diff --git a/docs/schema/queryrulegroups-element-searchqueryconfigurationsettings-complextypesps15xsdsear.md b/docs/schema/queryrulegroups-element-searchqueryconfigurationsettings-complextypesps15xsdsear.md index 091970002..b13a49e82 100644 --- a/docs/schema/queryrulegroups-element-searchqueryconfigurationsettings-complextypesps15xsdsear.md +++ b/docs/schema/queryrulegroups-element-searchqueryconfigurationsettings-complextypesps15xsdsear.md @@ -1,27 +1,26 @@ --- title: QueryRuleGroups element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3) manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 051d4be2-bb66-5523-251d-e3e3a6f5393d -description: "Last modified: March 09, 2015" +description: "Describes the QueryRuleGroups element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3)." --- # QueryRuleGroups element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Info type|Value| |:-----|:-----| |**Element type**
    |q2:ArrayOfQueryRuleGroup
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/queryrules-element-searchqueryconfigurationsettings-complextypesps15xsdsearchset.md b/docs/schema/queryrules-element-searchqueryconfigurationsettings-complextypesps15xsdsearchset.md index 7d83b27bd..66589351a 100644 --- a/docs/schema/queryrules-element-searchqueryconfigurationsettings-complextypesps15xsdsearchset.md +++ b/docs/schema/queryrules-element-searchqueryconfigurationsettings-complextypesps15xsdsearchset.md @@ -1,27 +1,26 @@ --- title: "QueryRules element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 3d0d2fd5-344d-95df-c6c4-743a30e925ba -description: "Last modified: March 09, 2015" +description: "Describes the QueryRules element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3)." --- # QueryRules element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Info type|Value| |:-----|:-----| |**Element type**
    |q3:ArrayOfQueryRule
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/querytransform-element-source-complextypesps15xsdsearchset1.md b/docs/schema/querytransform-element-source-complextypesps15xsdsearchset1.md index 3e910ac2c..0d0fd1db5 100644 --- a/docs/schema/querytransform-element-source-complextypesps15xsdsearchset1.md +++ b/docs/schema/querytransform-element-source-complextypesps15xsdsearchset1.md @@ -1,27 +1,26 @@ --- title: "QueryTransform element (Source complexType) (SPS15XSDSearchSet1)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7bc707da-2c18-4112-ef3e-51d64f59d34a -description: "Last modified: March 09, 2015" +description: "Describes the QueryTransform element (Source complexType) (SPS15XSDSearchSet1). Applies to SharePoint Server 2013." --- # QueryTransform element (Source complexType) (SPS15XSDSearchSet1) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Info type|Value| |:-----|:-----| |**Element type**
    |q3:QueryTransform
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.Query.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/querytransformparenttype-element-sps15xsdsearchset4.md b/docs/schema/querytransformparenttype-element-sps15xsdsearchset4.md index 2bff4ef17..28922c456 100644 --- a/docs/schema/querytransformparenttype-element-sps15xsdsearchset4.md +++ b/docs/schema/querytransformparenttype-element-sps15xsdsearchset4.md @@ -1,29 +1,28 @@ --- title: "QueryTransformParentType element (SPS15XSDSearchSet4)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 0bdda245-46c6-735d-1bd8-45b4c94c2657 -description: "Last modified: March 09, 2015" +description: "Describes the QueryTransformParentType element (SPS15XSDSearchSet4)." --- # QueryTransformParentType element (SPS15XSDSearchSet4) - - + + **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Info type|Value| |:-----|:-----| |**Element type**
    |tns:QueryTransformParentType
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query.Rules
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.Rules.xsd
    | - + ## Definition ```XML @@ -33,18 +32,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/querytransformparenttype-simpletype-sps15xsdsearchset4.md b/docs/schema/querytransformparenttype-simpletype-sps15xsdsearchset4.md index 5d54722a0..7cbb17108 100644 --- a/docs/schema/querytransformparenttype-simpletype-sps15xsdsearchset4.md +++ b/docs/schema/querytransformparenttype-simpletype-sps15xsdsearchset4.md @@ -1,29 +1,28 @@ --- title: "QueryTransformParentType simpleType (SPS15XSDSearchSet4)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 59305aac-635b-bcab-17d4-5ea82b108432 -description: "Last modified: March 09, 2015" +description: "Describes the QueryTransformParentType simpleType (SPS15XSDSearchSet4). Applies to SharePoint Server 2013." --- # QueryTransformParentType simpleType (SPS15XSDSearchSet4) - - + + **Applies to:** SharePoint Server 2013 - + ## Type information -||| +|Info type|Value| |:-----|:-----| |**Base type**
    |xs:string
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query.Rules
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.Rules.xsd
    | - + ## Definition ```XML @@ -44,5 +43,3 @@ description: "Last modified: March 09, 2015" |Action
    || |UserDefined
    || |Source
    || - - diff --git a/docs/schema/quotedxml-element.md b/docs/schema/quotedxml-element.md index 9a7e51a20..fa26a06ab 100644 --- a/docs/schema/quotedxml-element.md +++ b/docs/schema/quotedxml-element.md @@ -4,18 +4,17 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9731bc10-8986-4597-97d5-eea87ea2962b -description: Used to HTML-decode and execute the Collaborative Application Markup Language (CAML) that the element contains. +description: Used to HTML-decode and execute the Collaborative Application Markup Language (CAML) that the element contains. --- # QuotedXML element **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Used to HTML-decode and execute the Collaborative Application Markup Language (CAML) that the element contains. This can be useful if you want to put CAML somewhere that is intolerant of the concatenation characters ("&"), for example, inside a hyperlink, an HTML attribute, or a Microsoft JScript string literal. - + ```XML @@ -28,28 +27,26 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ## Example -In the following example, the **QuotedXML** element contains content that will be executed as CAML. - +In the following example, the **QuotedXML** element contains content that will be executed as CAML. + ```XML &lt;ListProperty Select=&quot;Title&quot;/&gt; ``` - - diff --git a/docs/schema/rankingmodels-element-searchrankingmodelconfigurationsettings-complextypesps15xs.md b/docs/schema/rankingmodels-element-searchrankingmodelconfigurationsettings-complextypesps15xs.md index 0ae9b86a0..0ac33e876 100644 --- a/docs/schema/rankingmodels-element-searchrankingmodelconfigurationsettings-complextypesps15xs.md +++ b/docs/schema/rankingmodels-element-searchrankingmodelconfigurationsettings-complextypesps15xs.md @@ -1,27 +1,26 @@ --- title: "RankingModels element (SearchRankingModelConfigurationSettings complexType) (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 88c68026-ddad-5877-f982-885fc853b2f2 -description: "Last modified: March 09, 2015" +description: "Describes the RankingModels element (SearchRankingModelConfigurationSettings complexType) (SPS15XSDSearchSet3)." --- # RankingModels element (SearchRankingModelConfigurationSettings complexType) (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Info type|Value| |:-----|:-----| |**Element type**
    |q7:ArrayOfstring
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/readsecurity-element.md b/docs/schema/readsecurity-element.md index a675b9159..7f5575834 100644 --- a/docs/schema/readsecurity-element.md +++ b/docs/schema/readsecurity-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b9961811-42e2-449d-9484-2134962adccd description: Contains the Read security setting for a list. --- @@ -13,9 +12,9 @@ description: Contains the Read security setting for a list. # ReadSecurity element **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Contains the Read security setting for a list. - + ```XML @@ -28,32 +27,31 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [Security](security-element.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ### Remarks -The **ReadSecurity** element can contain the following values: - -- **1** — All users have Read access to all items. - -- **2** — Users have Read access only to items that they create. - -For an example that shows how to use the **ReadSecurity** element, see [Security element](security-element.md). - +The **ReadSecurity** element can contain the following values: + +- **1** — All users have Read access to all items. + +- **2** — Users have Read access only to items that they create. + +For an example that shows how to use the **ReadSecurity** element, see [Security element](security-element.md). + ## See also -- [SchemaSecurity element](schemasecurity-element.md) +- [SchemaSecurity element](schemasecurity-element.md) - [WriteSecurity element](writesecurity-element.md) - diff --git a/docs/schema/receiver-element-event.md b/docs/schema/receiver-element-event.md index 0ba2a927f..75ccf6484 100644 --- a/docs/schema/receiver-element-event.md +++ b/docs/schema/receiver-element-event.md @@ -1,11 +1,11 @@ --- title: Receiver Element (Event) +description: Describes the Receiver Element (Event), which describes an event receiver for handling list item events. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a9adf70d-8a6d-4201-9838-157150e9a18f --- @@ -39,14 +39,14 @@ None     @@ -84,11 +84,3 @@ None ## Example For an example of how this element is used, see [Event Registrations](event-registrations.md). - - - - - - - - diff --git a/docs/schema/receivers-element-event.md b/docs/schema/receivers-element-event.md index c34ddea93..af2833911 100644 --- a/docs/schema/receivers-element-event.md +++ b/docs/schema/receivers-element-event.md @@ -1,11 +1,11 @@ --- title: Receivers Element (Event) +description: The Receivers Element (Event) contains the description of an event receiver for handling item events in lists created through the specified list template. manager: soliver -ms.date: 3/9/2015 +ms.date: 07/01/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1290b4ef-956f-4775-82cc-07f9b812c0f9 --- @@ -33,41 +33,13 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Attribute

    Description

    **ListTemplateId**

    Optional **Text**. Specifies the index of the list template to which the event receiver applies. For a list of the default list template types, see SPListTemplateType.

    **ListTemplateOwner**

    Optional **Text**. Specifies the GUID of the list template owner if the list template is registered through Features, or the name of the site definition if the list template is registered by a site definition.

    **ListUrl**

    Optional **string**. Specifies the URL of the list to which the event receiver applies.

    **RootWebOnly**

    Optional **Boolean**. **True** if the event receiver applies only to the root Web; otherwise, **False**.

    **Scope**

    Optional **enumeration**. The scope of the event receiver. This can be **Site** or **Web**. When the **Scope** attribute is set to **Site**, event receivers that are defined inside of a Feature that is scoped to the site collection are registered at the site collection level. When the **Scope** attribute is set to **Web**, event receivers that are defined inside of a Feature that is scoped to a Web are registered on the Web.

    - +|Attribute|Description| +| --- | --- | +|**ListTemplateId**|Optional **Text**. Specifies the index of the list template to which the event receiver applies. For a list of the default list template types, see [SPListTemplateType](/dotnet/api/microsoft.sharepoint.splisttemplate.type).| +|**ListTemplateOwner**|Optional **Text**. Specifies the GUID of the list template owner if the list template is registered through Features, or the name of the site definition if the list template is registered by a site definition.| +|**ListUrl**|Optional **string**. Specifies the URL of the list to which the event receiver applies.| +|**RootWebOnly**|Optional **Boolean**. **True** if the event receiver applies only to the root Web; otherwise, **False**.| +|**Scope**|Optional **enumeration**. The scope of the event receiver. This can be **Site** or **Web**. When the **Scope** attribute is set to **Site**, event receivers that are defined inside of a Feature that is scoped to the site collection are registered at the site collection level. When the **Scope** attribute is set to **Web**, event receivers that are defined inside of a Feature that is scoped to a Web are registered on the Web.| ### Child elements @@ -114,16 +86,8 @@ The following sections describe attributes, child elements, and parent elements. For an example of how this element is used, see [Event Registrations](event-registrations.md). -A **Receivers** tag can imply a site-wide event registration or an event registration for the root Web. The **Scope** attribute is used to define at what level the event receivers are applied. If the **Receivers** tag has no **ListTemplateId** or **ListUrl** attribute, the event receiver is registered at the same scope as the Feature. +A **Receivers** tag can imply a site-wide event registration or an event registration for the root Web. The **Scope** attribute is used to define at what level the event receivers are applied. If the **Receivers** tag has no **ListTemplateId** or **ListUrl** attribute, the event receiver is registered at the same scope as the Feature. For example, a Feature that is scoped to the Web results in an event receiver being added to an event receiver collection that is scoped to the Web.
    - - - - - - - - diff --git a/docs/schema/recurrence-element.md b/docs/schema/recurrence-element.md index 36bf9692e..ab8e791b9 100644 --- a/docs/schema/recurrence-element.md +++ b/docs/schema/recurrence-element.md @@ -1,24 +1,21 @@ --- title: "Recurrence element" manager: soliver -ms.date: 11/16/2014 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5f164e5b-47b6-4242-b6b9-8d650090a831 -description: This type or member supports Microsoft SharePoint Foundation and is not intended to be used directly from your code. +description: The Recurrence element supports Microsoft SharePoint Foundation and is not intended to be used directly from your code. --- # Recurrence element **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + This type or member supports Microsoft SharePoint Foundation and is not intended to be used directly from your code. - + ```XML ``` - - diff --git a/docs/schema/refinable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/refinable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md index 865a4d1f0..5de3c209f 100644 --- a/docs/schema/refinable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/refinable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Refinable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b75c3bae-3b9d-37a4-5040-0221b510a840 -description: "Last modified: March 09, 2015" +description: "Describes the Refinable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)." --- # Refinable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Info type|Value| |:-----|:-----| |**Element type**
    |xs:boolean
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/refineranchoring-element-sps15xsdsearchset2.md b/docs/schema/refineranchoring-element-sps15xsdsearchset2.md index 9641e65f4..702468d55 100644 --- a/docs/schema/refineranchoring-element-sps15xsdsearchset2.md +++ b/docs/schema/refineranchoring-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "RefinerAnchoring element (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 0e6e4151-4f20-38d6-4d42-4e49af2e35dc -description: "Last modified: March 09, 2015" +description: "Describes the RefinerAnchoring element (SPS15XSDSearchSet2)." --- # RefinerAnchoring element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Info type|Value| |:-----|:-----| |**Element type**
    |tns:RefinerAnchoring
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/refineranchoring-simpletype-sps15xsdsearchset2.md b/docs/schema/refineranchoring-simpletype-sps15xsdsearchset2.md index 92f766877..fdeb54f5c 100644 --- a/docs/schema/refineranchoring-simpletype-sps15xsdsearchset2.md +++ b/docs/schema/refineranchoring-simpletype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "RefinerAnchoring simpleType (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 45d7c1b5-39dd-f86b-0a07-b2187d0de04a -description: "Last modified: March 09, 2015" +description: "Describes the RefinerAnchoring simpleType (SPS15XSDSearchSet2)." --- # RefinerAnchoring simpleType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Info type|Value| |:-----|:-----| |**Base type**
    |xs:string
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -46,5 +45,3 @@ description: "Last modified: March 09, 2015" |Complete
    || |Prefix
    || |Suffix
    || - - diff --git a/docs/schema/refinerconfiguration-complextype-sps15xsdsearchset2.md b/docs/schema/refinerconfiguration-complextype-sps15xsdsearchset2.md index f6223b5dd..416da0669 100644 --- a/docs/schema/refinerconfiguration-complextype-sps15xsdsearchset2.md +++ b/docs/schema/refinerconfiguration-complextype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "RefinerConfiguration complexType (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ed726d55-576d-1801-4bc7-310389d8e93b -description: "Last modified: March 09, 2015" +description: "Describes the RefinerConfiguration complexType (SPS15XSDSearchSet2)." --- # RefinerConfiguration complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Info type|Value| |:-----|:-----| |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | |**Extension base**
    |None
    | - + ## Definition ```XML @@ -40,8 +39,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -52,9 +51,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[Intervals](intervals-element-refinerconfiguration-complextypesps15xsdsearchset2.md)
    |xs:int
    || |[Resolution](resolution-element-refinerconfiguration-complextypesps15xsdsearchset2.md)
    |xs:int
    || |[Type](type-element-refinerconfiguration-complextypesps15xsdsearchset2.md)
    |tns:RefinerType
    || - + ### Attributes None. - - diff --git a/docs/schema/refinerconfiguration-element-managedpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/refinerconfiguration-element-managedpropertyinfo-complextypesps15xsdsearchset2.md index f0e42ed55..a49c38299 100644 --- a/docs/schema/refinerconfiguration-element-managedpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/refinerconfiguration-element-managedpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "RefinerConfiguration element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f1eb3ae0-eb0a-0acf-3d85-0af59769fd90 -description: "Last modified: March 09, 2015" +description: "Describes the RefinerConfiguration element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" --- # RefinerConfiguration element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Info type|Value| |:-----|:-----| |**Element type**
    |tns:RefinerConfiguration
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/refinerconfiguration-element-sps15xsdsearchset2.md b/docs/schema/refinerconfiguration-element-sps15xsdsearchset2.md index f1c2f1783..aa6b44717 100644 --- a/docs/schema/refinerconfiguration-element-sps15xsdsearchset2.md +++ b/docs/schema/refinerconfiguration-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "RefinerConfiguration element (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b7798bf1-1548-32a2-5a70-bfac7bf7ccf9 -description: "Last modified: March 09, 2015" +description: "Describes the RefinerConfiguration element (SPS15XSDSearchSet2)" --- # RefinerConfiguration element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Info type|Value| |:-----|:-----| |**Element type**
    |tns:RefinerConfiguration
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/refinertype-element-sps15xsdsearchset2.md b/docs/schema/refinertype-element-sps15xsdsearchset2.md index d19fa2554..37c93f0b2 100644 --- a/docs/schema/refinertype-element-sps15xsdsearchset2.md +++ b/docs/schema/refinertype-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "RefinerType element (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9048fe86-eb35-7c10-84ae-77a11054f127 -description: "Last modified: March 09, 2015" +description: "Describes the RefinerType element (SPS15XSDSearchSet2)." --- # RefinerType element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Info type|Value| |:-----|:-----| |**Element type**
    |tns:RefinerType
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/refinertype-simpletype-sps15xsdsearchset2.md b/docs/schema/refinertype-simpletype-sps15xsdsearchset2.md index 22c0f6f3f..acbb26dae 100644 --- a/docs/schema/refinertype-simpletype-sps15xsdsearchset2.md +++ b/docs/schema/refinertype-simpletype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "RefinerType simpleType (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 78485bdb-6003-aae8-6c0a-1fa911aab6bb -description: "Last modified: March 09, 2015" +description: "Describes the RefinerType simpleType (SPS15XSDSearchSet2)." --- # RefinerType simpleType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Info type|Value| |:-----|:-----| |**Base type**
    |xs:string
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -42,5 +41,3 @@ description: "Last modified: March 09, 2015" |Deep
    || |Latent
    || |Shallow
    || - - diff --git a/docs/schema/regional-settings-schema.md b/docs/schema/regional-settings-schema.md index 5d3f3fe30..2fa85f201 100644 --- a/docs/schema/regional-settings-schema.md +++ b/docs/schema/regional-settings-schema.md @@ -1,43 +1,42 @@ --- title: "Regional Settings schema" manager: soliver -ms.date: 11/16/2014 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Regional Settings schema api_type: - schema ms.assetid: 7c9dda02-a11e-4716-b6de-eda33c8d14c8 -description: "Last modified: July 15, 2011" +description: "The Regional Settings schema defines the time zones, locales, languages, and currencies implemented within a SharePoint Foundation deployment." --- # Regional Settings schema **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + The Regional Settings schema is used to define the time zones, locales, languages, and currencies implemented within a SharePoint Foundation deployment. This schema is expressed primarily through two files located in the setup directory, RGNLSTNG.XML (%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\1033\XML) and TIMEZONE.XML (%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\CONFIG). - -You can access or modify regional settings through various members of the following classes in the [Microsoft.SharePoint](https://msdn.microsoft.com/library/Microsoft.SharePoint.aspx) namespace: - + +You can access or modify regional settings through various members of the following classes in the [Microsoft.SharePoint](https://msdn.microsoft.com/library/Microsoft.SharePoint.aspx) namespace: + [SPRegionalSettings](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRegionalSettings.aspx) - + [SPTimeZone](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPTimeZone.aspx) - + [SPTimeZoneCollection](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPTimeZoneCollection.aspx) - + [SPTimeZoneInformation](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPTimeZoneInformation.aspx) - + [SPLocale](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPLocale.aspx) - + [SPLocaleCollection](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPLocaleCollection.aspx) - + [SPLanguage](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPLanguage.aspx) - + [SPLanguageCollection](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPLanguageCollection.aspx) - + ## Regional Settings elements ### RGNLSTNG.XML @@ -60,7 +59,7 @@ You can access or modify regional settings through various members of the follow [TimeZones](timezones-element-regional-settings.md) - + ### TIMEZONE.XML [Bias](bias-element-regional-settings.md) @@ -86,4 +85,3 @@ You can access or modify regional settings through various members of the follow [TimeZone](timezone-element-regional-settings.md) [TimeZones](timezones-element-regional-settings.md) - diff --git a/docs/schema/regionalsettings-element-regional-settings.md b/docs/schema/regionalsettings-element-regional-settings.md index cdc37d8f6..d4f6bb700 100644 --- a/docs/schema/regionalsettings-element-regional-settings.md +++ b/docs/schema/regionalsettings-element-regional-settings.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Regional Settings schema api_type: - schema ms.assetid: d0d3ccfc-881f-4c50-8811-dd875b9555c9 -description: Contains the regional settings for currency, language, locale, and time zone that are used in the deployment of Microsoft SharePoint Foundation. +description: Contains the regional settings for currency, language, locale, and time zone that are used in the deployment of Microsoft SharePoint Foundation. --- # RegionalSettings element (Regional Settings) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Contains the regional settings for currency, language, locale, and time zone that are used in the deployment of Microsoft SharePoint Foundation. Used in TIMEZONE.XML (%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\CONFIG) and RGNLSTNG.XML (%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\1033\XML). - + ```XML @@ -32,32 +31,32 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [Currencies](currencies-element-regional-settings.md) - [Languages](languages-element-regional-settings.md) - [Locales](locales-element-regional-settings.md) - [TimeZones](timezones-element-regional-settings.md) - + ### Parent elements None - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ## Example The following example outlines the structure of the file TIMEZONE.XML. - + ```XML ... - ``` - - diff --git a/docs/schema/remoteendpoint-element-remoteendpointsdefinition-complextypesharepoint-add-in-ma.md b/docs/schema/remoteendpoint-element-remoteendpointsdefinition-complextypesharepoint-add-in-ma.md index 0c3ece266..17c15e81a 100644 --- a/docs/schema/remoteendpoint-element-remoteendpointsdefinition-complextypesharepoint-add-in-ma.md +++ b/docs/schema/remoteendpoint-element-remoteendpointsdefinition-complextypesharepoint-add-in-ma.md @@ -1,15 +1,15 @@ --- title: RemoteEndpoint element (RemoteEndpointsDefinition complexType) +description: Describes the RemoteEndpoint element (RemoteEndpointsDefinition complexType). Applies to SharePoint Add-ins, SharePoint Foundation 2013, and SharePoint Server 2013. manager: soliver -ms.date: 9/17/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 779c6b36-6789-43d9-b5ef-f6de23ed5543 --- -# RemoteEndpoint element (RemoteEndpointsDefinition complexType) +# RemoteEndpoint element (RemoteEndpointsDefinition complexType) (SharePoint Add-in Manifest) @@ -17,12 +17,12 @@ ms.assetid: 779c6b36-6789-43d9-b5ef-f6de23ed5543 Declares an individual remote endpoint that the SharePoint Add-in may access through the JSOM method SP.WebProxy.invoke(). -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +|Info type|Value| |---|---| | **Element type** | RemoteEndpointDefinition | | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | @@ -106,9 +106,3 @@ None.

    - - - - - - diff --git a/docs/schema/remoteendpointdefinition-complextype-sharepoint-add-in-manifest.md b/docs/schema/remoteendpointdefinition-complextype-sharepoint-add-in-manifest.md index 44659fabb..f8b356bc0 100644 --- a/docs/schema/remoteendpointdefinition-complextype-sharepoint-add-in-manifest.md +++ b/docs/schema/remoteendpointdefinition-complextype-sharepoint-add-in-manifest.md @@ -1,26 +1,26 @@ --- title: RemoteEndpointDefinition complexType +description: Describes the RemoteEndpointDefinition complexType (SharePoint Add-in Manifest). Applies to SharePoint Add-ins, SharePoint Foundation 2013, and SharePoint Server 2013. manager: soliver -ms.date: 9/17/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2e8af4be-41fd-3029-5e04-8a63f1e96f10 --- -# RemoteEndpointDefinition complexType +# RemoteEndpointDefinition complexType (SharePoint Add-in Manifest) **Applies to**: SharePoint Add-ins | SharePoint Foundation 2013 | SharePoint Server 2013 -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +|Info type|Value| |---|---| | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | | **Schema file** | appmanifest.xsd | @@ -34,7 +34,7 @@ ms.assetid: 2e8af4be-41fd-3029-5e04-8a63f1e96f10 type="ManifestUri" /> -``` +``` ## Elements and attributes @@ -75,11 +75,3 @@ None. - - - - - - - - diff --git a/docs/schema/remoteendpoints-element-appdefinition-complextypesharepoint-add-in-manifest.md b/docs/schema/remoteendpoints-element-appdefinition-complextypesharepoint-add-in-manifest.md index ddd5d7174..6dad7a77a 100644 --- a/docs/schema/remoteendpoints-element-appdefinition-complextypesharepoint-add-in-manifest.md +++ b/docs/schema/remoteendpoints-element-appdefinition-complextypesharepoint-add-in-manifest.md @@ -1,15 +1,15 @@ --- title: RemoteEndpoints element (AppDefinition complexType) +description: Defines the RemoteEndpoints element (AppDefinition complexType), which is a list of remote endpoints that the SharePoint Add-in may access through SP.WebProxy.invoke(). manager: soliver -ms.date: 9/17/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7a57baca-5ac3-1ebd-80cf-3b29f398889e --- -# RemoteEndpoints element (AppDefinition complexType) +# RemoteEndpoints element (AppDefinition complexType) (SharePoint Add-in Manifest) @@ -17,12 +17,12 @@ ms.assetid: 7a57baca-5ac3-1ebd-80cf-3b29f398889e (Optional) A list of remote endpoints that the SharePoint Add-in may access through SP.WebProxy.invoke(). If this list is empty or not provided, the SharePoint Add-in will not be able to use any remote endpoint through SP.WebProxy.invoke(). -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +|Information|Value| |---|---| | **Element type** | RemoteEndpointsDefinition | | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | @@ -101,9 +101,3 @@ None.

    - - - - - - diff --git a/docs/schema/remoteendpointsdefinition-complextype-sharepoint-add-in-manifest.md b/docs/schema/remoteendpointsdefinition-complextype-sharepoint-add-in-manifest.md index b04493d5e..6ff5a7874 100644 --- a/docs/schema/remoteendpointsdefinition-complextype-sharepoint-add-in-manifest.md +++ b/docs/schema/remoteendpointsdefinition-complextype-sharepoint-add-in-manifest.md @@ -1,26 +1,26 @@ --- title: RemoteEndpointsDefinition complexType +description: Describes the RemoteEndpointsDefinition complexType. Applies to SharePoint Add-ins, SharePoint Foundation 2013, and SharePoint Server 2013. manager: soliver -ms.date: 9/17/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d50c57c6-a824-6c46-fe86-4a3c1da3ddcb --- -# RemoteEndpointsDefinition complexType +# RemoteEndpointsDefinition complexType (SharePoint Add-in Manifest) **Applies to**: SharePoint Add-ins | SharePoint Foundation 2013 | SharePoint Server 2013 -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +|Information type|Value| |---|---| | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | | **Schema file** | appmanifest.xsd | @@ -38,7 +38,7 @@ ms.assetid: d50c57c6-a824-6c46-fe86-4a3c1da3ddcb -``` +``` ## Elements and attributes @@ -73,9 +73,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** ### Attributes None. - - - - - - diff --git a/docs/schema/remotewebapplication-element-appprincipaldefinition-complextypesharepoint-add-in.md b/docs/schema/remotewebapplication-element-appprincipaldefinition-complextypesharepoint-add-in.md index 7c7f9bf85..cb2f90ad2 100644 --- a/docs/schema/remotewebapplication-element-appprincipaldefinition-complextypesharepoint-add-in.md +++ b/docs/schema/remotewebapplication-element-appprincipaldefinition-complextypesharepoint-add-in.md @@ -1,15 +1,15 @@ --- title: RemoteWebApplication element (AppPrincipalDefinition complexType) +description: Defines the RemoteWebApplication element (AppPrincipalDefinition complexType), which specifies properties of a provider-hosted SharePoint Add-in. manager: soliver -ms.date: 9/17/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 516ed600-9f2c-10b4-0110-a8237d4da382 --- -# RemoteWebApplication element (AppPrincipalDefinition complexType) +# RemoteWebApplication element (AppPrincipalDefinition complexType) (SharePoint Add-in Manifest) @@ -17,12 +17,12 @@ ms.assetid: 516ed600-9f2c-10b4-0110-a8237d4da382 Specifies properties of a provider-hosted SharePoint Add-in. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +|Information|Value| |---|---| | **Element type** | Not defined | | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | @@ -33,7 +33,7 @@ Specifies properties of a provider-hosted SharePoint Add-in. ```XML  - + ``` ## Elements and attributes @@ -104,9 +104,3 @@ None.

    - - - - - - diff --git a/docs/schema/removeduplicates-element-managedpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/removeduplicates-element-managedpropertyinfo-complextypesps15xsdsearchset2.md index d64b26438..eab363f89 100644 --- a/docs/schema/removeduplicates-element-managedpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/removeduplicates-element-managedpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "RemoveDuplicates element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1e27dcaf-5870-2fae-5f44-3275a8a5a109 -description: "Last modified: March 09, 2015" +description: "Describes the RemoveDuplicates element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)." --- # RemoveDuplicates element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Value| |:-----|:-----| |**Element type**
    |xs:boolean
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/removefieldref-element-contenttype.md b/docs/schema/removefieldref-element-contenttype.md index 60fd5a6ae..67840b031 100644 --- a/docs/schema/removefieldref-element-contenttype.md +++ b/docs/schema/removefieldref-element-contenttype.md @@ -1,11 +1,11 @@ --- title: RemoveFieldRef element (ContentType) +description: Describes the RemoveFieldRef element (ContentType), which specifies a column reference that is included in the parent content type but is to be removed from this content type. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5f06a5ba-0b74-497d-a88c-9a104225c0a5 --- @@ -48,7 +48,7 @@ You need only specify the ID attribute of the **RemoveFieldRef** element. ShareP ShowInFileDlg="TRUE" | "FALSE" ShowInListSettings="TRUE" | "FALSE" ShowInNewForm="TRUE" | "FALSE" - Sortable="TRUE" | "FALSE" + Sortable="TRUE" | "FALSE" PrimaryPITarget="Text" /> ``` @@ -145,11 +145,3 @@ The following example shows **RemoveFieldRef** elements specifying several colum - [Content Types](https://msdn.microsoft.com/library/f5e56c7c-f699-466c-a7ad-3d91a7d219a1(Office.15).aspx) - [Fields and Field References](https://msdn.microsoft.com/library/6b536c1a-719c-4203-8006-c162de199bfc(Office.15).aspx) - [FieldRef element (ContentType)](fieldref-element-contenttype.md) - - - - - - - - diff --git a/docs/schema/renderpattern-element-field-types.md b/docs/schema/renderpattern-element-field-types.md index a2a77ec32..6fbdb6a80 100644 --- a/docs/schema/renderpattern-element-field-types.md +++ b/docs/schema/renderpattern-element-field-types.md @@ -6,25 +6,24 @@ ms.audience: Developer ms.topic: reference keywords: - field type definition schema, renderpattern element (field types) -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Field Types XML ms.assetid: d1b292bf-6be1-4372-b529-2c87d1f83d7d -description: RenderPattern defines the actual Collaborative Application Markup Language (CAML), HTML, and script that SharePoint Foundation can use to render the field type in the UI. +description: RenderPattern defines the actual Collaborative Application Markup Language (CAML), HTML, and script that SharePoint Foundation can use to render the field type in the UI. --- # RenderPattern element (Field Types) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + > [!IMPORTANT] -> This topic describes markup that was used in a now obsolete method of rendering custom fields types on list views and on the Display, Edit, and New forms. It is provided solely to assist persons who are debugging a custom field type that was originally developed against an earlier version of SharePoint Foundation. For information about the recommended methods, see [Field Rendering Templates](https://msdn.microsoft.com/library/812772eb-03d0-4a78-b212-0ba2875857df%28Office.15%29.aspx) and [Patterns of Custom Field Rendering](https://msdn.microsoft.com/library/aacdc6d1-86c8-4a6b-953d-22ecac209d0f%28Office.15%29.aspx). -> -> Custom fields whose rendering is defined with **RenderPattern** markup still render properly on forms. However, SharePoint Foundation, by default, uses XSLT stylesheets to render fields on list views, even for legacy custom fields whose list view rendering is defined with a **RenderPattern**. To enable the rendering of such a field, a `TRUE` element must be added to the containing **FieldTypes** element in the field type definition file (`fldtype*.xml`). - -**RenderPattern** defines the actual Collaborative Application Markup Language (CAML), HTML, and script that SharePoint Foundation can use to render the field type in the UI. Also, in list views, this element renders the column headers, based on the selected field type. - +> This topic describes markup that was used in a now obsolete method of rendering custom fields types on list views and on the Display, Edit, and New forms. It is provided solely to assist persons who are debugging a custom field type that was originally developed against an earlier version of SharePoint Foundation. For information about the recommended methods, see [Field Rendering Templates](https://msdn.microsoft.com/library/812772eb-03d0-4a78-b212-0ba2875857df%28Office.15%29.aspx) and [Patterns of Custom Field Rendering](https://msdn.microsoft.com/library/aacdc6d1-86c8-4a6b-953d-22ecac209d0f%28Office.15%29.aspx). +> +> Custom fields whose rendering is defined with **RenderPattern** markup still render properly on forms. However, SharePoint Foundation, by default, uses XSLT stylesheets to render fields on list views, even for legacy custom fields whose list view rendering is defined with a **RenderPattern**. To enable the rendering of such a field, a `TRUE` element must be added to the containing **FieldTypes** element in the field type definition file (`fldtype*.xml`). + +**RenderPattern** defines the actual Collaborative Application Markup Language (CAML), HTML, and script that SharePoint Foundation can use to render the field type in the UI. Also, in list views, this element renders the column headers, based on the selected field type. + ```XML @@ -39,48 +38,48 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Description**| |:-----|:-----| |**Name**
    | Required **String**. Represents the name of the render pattern you are defining in this **RenderPattern** element.

    Valid values are:
    - **HeaderPattern**. Defines rendering for the column header on list view pages when CAML rendering is turned on (by including `TRUE` in the containing **FieldTypes** element of the `fldtypes*.xml` file).

    - **DisplayPattern**. Defines rendering of the field for the Display (list item) form. When CAML rendering is turned on (by including `TRUE` in the containing **FieldTypes** element of the `fldtypes*.xml` file), the **DisplayPattern** also defines rendering of the field on list view pages.

    - **EditPattern**. Defines rendering of the field for the Edit (list item) form.

    - **NewPattern**. Defines rendering of the field for the New (list item) form.

    - **PreviewDisplayPattern**. Defines, for use in a WYSIWYG ("what you see is what you get") site designer such as SharePoint Designer, a preview of how the field will look in Display mode using fictitious data.

    - **PreviewEditPattern**. Defines, for use in a WYSIWYG site designer such as SharePoint Designer, a preview of how the field will look in Edit mode using fictitious data.

    - **PreviewNewPattern**. Defines, for use in a WYSIWYG site designer such as SharePoint Designer, a preview of how the field will look in New mode using fictitious data.
    | - + ### Child elements None explicitly defined, but this element is a container of CAML markup from the [View schema](view-schema.md). - + ### Parent elements - [FieldType element (Field Types)](fieldtype-element-field-types.md) - + ## Remarks ### Inheritance of RenderPatterns -If a **RenderPattern** with a particular **Name** value is not provided for a field type, the field type inherits the **RenderPattern** with that name from its parent field type. - +If a **RenderPattern** with a particular **Name** value is not provided for a field type, the field type inherits the **RenderPattern** with that name from its parent field type. + ### HeaderPattern -If CAML rendering is enabled, the field type must have a **HeaderPattern** type of the **RenderPattern** element, either directly or by inheritance, or the column header of the field on list views does not render. The markup in a **HeaderPattern** can be quite simple when the field type cannot be sorted or filtered. However, if the field type can be sorted or filtered, the markup can become quite complex because the header serves not just as the title for the column but also as a drop-down menu control for sorting and filtering. Moreover, because the ability to be sorted and filtered can be disabled for particular columns (even when the field type that the column is based on supports them), the markup must use **Switch** elements to test whether sorting or filtering is enabled for the column. For examples, see %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML\FLDTYPES.XML. - +If CAML rendering is enabled, the field type must have a **HeaderPattern** type of the **RenderPattern** element, either directly or by inheritance, or the column header of the field on list views does not render. The markup in a **HeaderPattern** can be quite simple when the field type cannot be sorted or filtered. However, if the field type can be sorted or filtered, the markup can become quite complex because the header serves not just as the title for the column but also as a drop-down menu control for sorting and filtering. Moreover, because the ability to be sorted and filtered can be disabled for particular columns (even when the field type that the column is based on supports them), the markup must use **Switch** elements to test whether sorting or filtering is enabled for the column. For examples, see %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML\FLDTYPES.XML. + ### DisplayPattern -If CAML rendering is enabled, a field type must have a **DisplayPattern** type of the **RenderPattern** element (by inheritance, if not directly) so that the field can be rendered on list views. This is not necessary to render the field in Display mode, such as on the Display (list item) page, because a field can also be rendered in Display mode by means of a [rendering control (.ascx file)](https://msdn.microsoft.com/library/12616aab-f427-4abe-9e5b-8b9085a9740e%28Office.15%29.aspx). None of the legacy field types that ship with SharePoint Foundation use a rendering control rather than a **DisplayPattern** type of **RenderPattern** element to render the field in Display mode. - -The **DisplayPattern** type of **RenderPattern** can also be used to render the field in each row of a list view. By default, SharePoint Foundation uses XSLT markup in a `fldtypes*.xsl` file located in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\LAYOUTS\XSL to render fields on list views. But the `fldtypes*.xml` file in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML is checked for the presence of `TRUE` in the containing **FieldTypes** element for the field. If it is present, the **DisplayPattern** is used to render the field on list views. - +If CAML rendering is enabled, a field type must have a **DisplayPattern** type of the **RenderPattern** element (by inheritance, if not directly) so that the field can be rendered on list views. This is not necessary to render the field in Display mode, such as on the Display (list item) page, because a field can also be rendered in Display mode by means of a [rendering control (.ascx file)](https://msdn.microsoft.com/library/12616aab-f427-4abe-9e5b-8b9085a9740e%28Office.15%29.aspx). None of the legacy field types that ship with SharePoint Foundation use a rendering control rather than a **DisplayPattern** type of **RenderPattern** element to render the field in Display mode. + +The **DisplayPattern** type of **RenderPattern** can also be used to render the field in each row of a list view. By default, SharePoint Foundation uses XSLT markup in a `fldtypes*.xsl` file located in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\LAYOUTS\XSL to render fields on list views. But the `fldtypes*.xml` file in %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML is checked for the presence of `TRUE` in the containing **FieldTypes** element for the field. If it is present, the **DisplayPattern** is used to render the field on list views. + > [!NOTE] -> Two legacy field types that ship with SharePoint Foundation do not have a **DisplayPattern** type of **RenderPattern** in FLDTYPES.XML: (1) *ContentTypeId* fields are never visible. (2) *Computed* fields are rendered on list views and in Display mode by a **DisplayPattern** element in their **Field** elements within the schema.xml of each list on which they appear. - +> Two legacy field types that ship with SharePoint Foundation do not have a **DisplayPattern** type of **RenderPattern** in FLDTYPES.XML: (1) *ContentTypeId* fields are never visible. (2) *Computed* fields are rendered on list views and in Display mode by a **DisplayPattern** element in their **Field** elements within the schema.xml of each list on which they appear. + ### NewPattern and EditPattern -The **NewPattern** and **EditPattern** types of **RenderPattern** were used to render a field in New mode and Edit mode, respectively, when the field did not require significant data processing or data validation when a list item containing the field was being created or edited. Free-form Note fields, for example, cannot be validated because any text is a valid value. Similarly, Choice fields and Lookup fields, by definition, limit the user's choices to only valid values. Other fields, such as Currency and DateTime, need only minimal validation that can be coded in script. - +The **NewPattern** and **EditPattern** types of **RenderPattern** were used to render a field in New mode and Edit mode, respectively, when the field did not require significant data processing or data validation when a list item containing the field was being created or edited. Free-form Note fields, for example, cannot be validated because any text is a valid value. Similarly, Choice fields and Lookup fields, by definition, limit the user's choices to only valid values. Other fields, such as Currency and DateTime, need only minimal validation that can be coded in script. + For examples of **NewPattern** and **EditPattern** types of **RenderPatterns**, see %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML\FLDTYPES.XML. - + ### RenderPatterns for multicolumn-derived custom field types In the **RenderPattern** markup for a custom MultiColumn field, the **SubcolumnNumber** attribute of a **Column** element is used to specify an individual column in a multicolumn field type. For more information about multicolumn field types, see [Custom Multicolumn Field Classes](https://msdn.microsoft.com/library/62818d63-6473-42d0-b12f-251865887b33%28Office.15%29.aspx). - + ## Example The following example defines a display rendering pattern for a custom field type that inherits from the MultiColumn type. The field is used to store American addresses. The first subcolumn stores the street address followed by an HTML line break. The next subcolumn stores the city name followed by a comma and a space. The third subcolumn stores the state and, following a space, the last subcolumn stores the postal code. - + ```XML @@ -102,10 +101,9 @@ The following example defines a display rendering pattern for a custom field typ ## See also -- [Walkthrough: Creating a Custom Field Type](https://msdn.microsoft.com/library/089a1b8a-cafc-4050-b445-16650602fe4f%28Office.15%29.aspx) -- [Custom Field Types](https://msdn.microsoft.com/library/1345b345-226d-443a-918f-af123a3c7b13%28Office.15%29.aspx) -- [Custom Field Classes](https://msdn.microsoft.com/library/436a9d9b-7a6f-4e8f-86e8-f42ded85c069%28Office.15%29.aspx) -- [Custom Field Type Property Rendering](https://msdn.microsoft.com/library/a959ad5b-6f3a-462c-80b9-e2d00bb0d62a%28Office.15%29.aspx) -- [Custom Field Type Definition](https://msdn.microsoft.com/library/b3315997-671f-4c29-9518-48cc4592f205%28Office.15%29.aspx) +- [Walkthrough: Creating a Custom Field Type](https://msdn.microsoft.com/library/089a1b8a-cafc-4050-b445-16650602fe4f%28Office.15%29.aspx) +- [Custom Field Types](https://msdn.microsoft.com/library/1345b345-226d-443a-918f-af123a3c7b13%28Office.15%29.aspx) +- [Custom Field Classes](https://msdn.microsoft.com/library/436a9d9b-7a6f-4e8f-86e8-f42ded85c069%28Office.15%29.aspx) +- [Custom Field Type Property Rendering](https://msdn.microsoft.com/library/a959ad5b-6f3a-462c-80b9-e2d00bb0d62a%28Office.15%29.aspx) +- [Custom Field Type Definition](https://msdn.microsoft.com/library/b3315997-671f-4c29-9518-48cc4592f205%28Office.15%29.aspx) - [Custom Multicolumn Field Classes](https://msdn.microsoft.com/library/62818d63-6473-42d0-b12f-251865887b33%28Office.15%29.aspx) - diff --git a/docs/schema/reorderingrule-complextype-sps15xsdsearchset5.md b/docs/schema/reorderingrule-complextype-sps15xsdsearchset5.md index b6e0b9ced..8411af43b 100644 --- a/docs/schema/reorderingrule-complextype-sps15xsdsearchset5.md +++ b/docs/schema/reorderingrule-complextype-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "ReorderingRule complexType (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 57993a33-3551-dded-7e63-1a412e3e70ae -description: "Last modified: March 09, 2015" +description: "Describes the ReorderingRule complexType (SPS15XSDSearchSet5). Applies to SharePoint Server 2013." --- # ReorderingRule complexType (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Type information -||| +|Information|Value| |:-----|:-----| |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | |**Extension base**
    |None
    | - + ## Definition ```XML @@ -39,8 +38,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -48,9 +47,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[Boost](boost-element-reorderingrule-complextypesps15xsdsearchset5.md)
    |xs:int
    || |[MatchType](matchtype-element-reorderingrule-complextypesps15xsdsearchset5.md)
    |tns:ReorderingRuleMatchType
    || |[MatchValue](matchvalue-element-reorderingrule-complextypesps15xsdsearchset5.md)
    |xs:string
    || - + ### Attributes None. - - diff --git a/docs/schema/reorderingrule-element-arrayofreorderingrule-complextypesps15xsdsearchset5.md b/docs/schema/reorderingrule-element-arrayofreorderingrule-complextypesps15xsdsearchset5.md index b830ce2c7..c9dce52b0 100644 --- a/docs/schema/reorderingrule-element-arrayofreorderingrule-complextypesps15xsdsearchset5.md +++ b/docs/schema/reorderingrule-element-arrayofreorderingrule-complextypesps15xsdsearchset5.md @@ -4,26 +4,25 @@ manager: arnek ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c11c4d2b-5994-f29f-d413-bdb60c37b215 -description: "Last modified: March 09, 2015" +description: "Describes the ReorderingRule element (ArrayOfReorderingRule complexType) (SPS15XSDSearchSet5). Applies to SharePoint Server 2013." --- # ReorderingRule element (ArrayOfReorderingRule complexType) (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Value| |:-----|:-----| |**Element type**
    |tns:ReorderingRule
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - + ## Definition ```XML @@ -33,18 +32,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/reorderingrule-element-sps15xsdsearchset5.md b/docs/schema/reorderingrule-element-sps15xsdsearchset5.md index 208c8849b..b95309b2f 100644 --- a/docs/schema/reorderingrule-element-sps15xsdsearchset5.md +++ b/docs/schema/reorderingrule-element-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "ReorderingRule element (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 646a439d-d931-db3a-1cc1-847f9de98a8c -description: "Last modified: March 09, 2015" +description: "Describes the ReorderingRule element (SPS15XSDSearchSet5). Applies to SharePoint Server 2013." --- # ReorderingRule element (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Value| |:-----|:-----| |**Element type**
    |tns:ReorderingRule
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - + ## Definition ```XML @@ -33,18 +32,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/reorderingrulematchtype-element-sps15xsdsearchset5.md b/docs/schema/reorderingrulematchtype-element-sps15xsdsearchset5.md index 06585f552..aa22cb68f 100644 --- a/docs/schema/reorderingrulematchtype-element-sps15xsdsearchset5.md +++ b/docs/schema/reorderingrulematchtype-element-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "ReorderingRuleMatchType element (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 75f67f95-169e-468b-ebb7-5b02d2c54114 -description: "Last modified: March 09, 2015" +description: "Describes the ReorderingRuleMatchType element (SPS15XSDSearchSet5). Applies to SharePoint Server 2013." --- # ReorderingRuleMatchType element (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Value| |:-----|:-----| |**Element type**
    |tns:ReorderingRuleMatchType
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - + ## Definition ```XML @@ -33,18 +32,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/reorderingrulematchtype-simpletype-sps15xsdsearchset5.md b/docs/schema/reorderingrulematchtype-simpletype-sps15xsdsearchset5.md index 536d741e3..d8b57350e 100644 --- a/docs/schema/reorderingrulematchtype-simpletype-sps15xsdsearchset5.md +++ b/docs/schema/reorderingrulematchtype-simpletype-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "ReorderingRuleMatchType simpleType (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 32aa6821-50eb-7809-25de-29bf1d98146c -description: "Last modified: March 09, 2015" +description: "Describes the ReorderingRuleMatchType simpleType (SPS15XSDSearchSet5). Applies to SharePoint Server 2013." --- # ReorderingRuleMatchType simpleType (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Type information -||| +|Information|Value| |:-----|:-----| |**Base type**
    |xs:string
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - + ## Definition ```XML @@ -56,5 +55,3 @@ description: "Last modified: March 09, 2015" |FileExtensionMatches
    || |ResultHasTag
    || |ManualCondition
    || - - diff --git a/docs/schema/representation-element-propertyruleoperator-complextypesps15xsdsearchset2.md b/docs/schema/representation-element-propertyruleoperator-complextypesps15xsdsearchset2.md index 5962d8b1b..1ba1a9478 100644 --- a/docs/schema/representation-element-propertyruleoperator-complextypesps15xsdsearchset2.md +++ b/docs/schema/representation-element-propertyruleoperator-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Representation element (PropertyRuleOperator complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d8887d3b-bd69-b967-e1e5-0d170c478fd0 -description: "Last modified: March 09, 2015" +description: "Describes the Representation element (PropertyRuleOperator complexType) (SPS15XSDSearchSet2)." --- # Representation element (PropertyRuleOperator complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Value| |:-----|:-----| |**Element type**
    |xs:string
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/requirement-element-deploymentrequirements.md b/docs/schema/requirement-element-deploymentrequirements.md index be45e4fdb..8cf7bbde9 100644 --- a/docs/schema/requirement-element-deploymentrequirements.md +++ b/docs/schema/requirement-element-deploymentrequirements.md @@ -1,29 +1,28 @@ --- title: "Requirement Element (DeploymentRequirements)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 52eb5087-e0ca-45f8-8137-e6350cfb0481 -description: "Last modified: March 09, 2015" +description: "Describes the Requirement Element, which represents specific deployment export requirement (SPRequirement) objects provided to the content migration package." --- # Requirement Element (DeploymentRequirements) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents specific deployment export requirement (**SPRequirement**) objects provided to the content migration package. ## Definition ```XML DECLARATION - USAGE @@ -40,7 +39,7 @@ USAGE ## Type **SPRequirement** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -49,20 +48,19 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Type**|**Description**| |:-----|:-----|:-----| -|Type
    |[SPRequirementObjectType Simple Type (DeploymentRequirements)](sprequirementobjecttype-simple-type-deploymentrequirements.md)
    |Specifies the requirement object type as defined in the **SPRequirementObjectType** simple type: **FeatureDefinition**, **WebTemplate**, **WebPart**, or **Language**.
    | -|Id
    |xs:string
    |ID of the requirement instance.
    | -|Name
    |xs:string
    |Name of the requirement instance.
    | -|Data
    |xs:string
    |Information about the requirement.
    | - +|Type|[SPRequirementObjectType Simple Type (DeploymentRequirements)](sprequirementobjecttype-simple-type-deploymentrequirements.md)|Specifies the requirement object type as defined in the **SPRequirementObjectType** simple type: **FeatureDefinition**, **WebTemplate**, **WebPart**, or **Language**.| +|Id|xs:string|ID of the requirement instance.| +|Name|xs:string|Name of the requirement instance.| +|Data|xs:string|Information about the requirement.| + ### Child elements None - + ### Parent elements [Requirements Element (DeploymentRequirements)](requirements-element-deploymentrequirements.md) - + ## See also - [DeploymentRequirements Schema](deploymentrequirements-schema.md) - diff --git a/docs/schema/requirements-element-deploymentrequirements.md b/docs/schema/requirements-element-deploymentrequirements.md index a50917ce7..a4696567b 100644 --- a/docs/schema/requirements-element-deploymentrequirements.md +++ b/docs/schema/requirements-element-deploymentrequirements.md @@ -1,28 +1,27 @@ --- title: "Requirements Element (DeploymentRequirements)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1e817b26-085f-46da-9f1a-d24047b21078 -description: "Last modified: March 09, 2015" +description: "Describes the Requirements Element (DeploymentRequirements), which represents a collection of deployment export requirement objects." --- # Requirements Element (DeploymentRequirements) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a collection of deployment export requirement objects. ## Definition ```XML DECLARATION - USAGE @@ -34,7 +33,7 @@ USAGE ## Type **SPImportRequirements** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -42,20 +41,19 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [Requirement Element (DeploymentRequirements)](requirement-element-deploymentrequirements.md) - + ### Parent elements None - + ### Remarks -The **Requirements** element is the root element in the DeploymentRequirements Schema, and therefore has no parent element. - +The **Requirements** element is the root element in the DeploymentRequirements Schema, and therefore has no parent element. + ## See also - [DeploymentRequirements Schema](deploymentrequirements-schema.md) - diff --git a/docs/schema/resolution-element-refinerconfiguration-complextypesps15xsdsearchset2.md b/docs/schema/resolution-element-refinerconfiguration-complextypesps15xsdsearchset2.md index 2ce46a779..6f316ccb5 100644 --- a/docs/schema/resolution-element-refinerconfiguration-complextypesps15xsdsearchset2.md +++ b/docs/schema/resolution-element-refinerconfiguration-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Resolution element (RefinerConfiguration complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 82b47a5d-6dd8-5692-50da-1aab0dc480fa -description: "Last modified: March 09, 2015" +description: "Describes the Resolution element (RefinerConfiguration complexType) (SPS15XSDSearchSet2). If the schema defines specific requirements, see the Definition section." --- # Resolution element (RefinerConfiguration complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information type|Value| |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:int | +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/resource-element-solution.md b/docs/schema/resource-element-solution.md index 11d2d582e..04cfd20f0 100644 --- a/docs/schema/resource-element-solution.md +++ b/docs/schema/resource-element-solution.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Solution Schema api_type: @@ -17,9 +16,9 @@ description: Specifies a binary resource to deploy to an existing Feature folder # Resource element (Solution) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies a binary resource to deploy to an existing Feature folder. - + ```XML @@ -35,17 +34,15 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Description**| |:-----|:-----| |**Location**
    |Required **Text**. Specifies a location relative to %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\FEATURES.
    | - + ### Child elements None - + ### Parent elements - [Resources](resources-element-solution.md) - + ### Remarks Use this element to deploy a binary resource to an existing Feature folder. - - diff --git a/docs/schema/resources-element-solution.md b/docs/schema/resources-element-solution.md index 3a2ee3333..8e21137bb 100644 --- a/docs/schema/resources-element-solution.md +++ b/docs/schema/resources-element-solution.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Solution Schema api_type: @@ -17,9 +16,9 @@ description: Specifies the resources to be deployed to an existing Feature folde # Resources element (Solution) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies the resources to be deployed to an existing Feature folder. - + ```XML |xs:boolean
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | +|**Element type** |xs:boolean | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | ## Definition @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/restrictedint-simpletype-sharepoint-add-in-manifest.md b/docs/schema/restrictedint-simpletype-sharepoint-add-in-manifest.md index 82115696c..c98cd33ba 100644 --- a/docs/schema/restrictedint-simpletype-sharepoint-add-in-manifest.md +++ b/docs/schema/restrictedint-simpletype-sharepoint-add-in-manifest.md @@ -1,38 +1,38 @@ --- title: RestrictedInt simpleType +description: Describes the RestrictedInt simpleType. Applies to SharePoint Add-ins SharePoint Foundation 2013, and SharePoint Server 2013. manager: soliver -ms.date: 9/17/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 38cd6fd4-21f0-1ca0-9e87-fba903746f2c --- -# RestrictedInt simpleType +# RestrictedInt simpleType (SharePoint Add-in Manifest) **Applies to**: SharePoint Add-ins | SharePoint Foundation 2013 | SharePoint Server 2013 -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +|Information type|Value| |---|---| -| **Base type** | xs:int | -| **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | -| **Schema file** | appmanifest.xsd | +| **Base type** | xs:int| +| **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest`| +| **Schema file** | appmanifest.xsd| ## Definition ```XML - + -``` \ No newline at end of file +``` diff --git a/docs/schema/resubmitflag-element-sps15xsdsearchset5.md b/docs/schema/resubmitflag-element-sps15xsdsearchset5.md index df9ab3c4b..506a57435 100644 --- a/docs/schema/resubmitflag-element-sps15xsdsearchset5.md +++ b/docs/schema/resubmitflag-element-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "ResubmitFlag element (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 45466d2b-9534-30df-f10e-2439c1cb26d0 -description: "Last modified: March 09, 2015" +description: "Describes the ResubmitFlag element (SPS15XSDSearchSet5). Applies to SharePoint Server 2013." --- # ResubmitFlag element (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information type|Value| |:-----|:-----| -|**Element type**
    |tns:ResubmitFlag
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Element type**|tns:ResubmitFlag | +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query | +|**Schema file**|schema_Microsoft.Office.Server.Search.Query.xsd | + ## Definition ```XML @@ -33,18 +32,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/resubmitflag-simpletype-sps15xsdsearchset5.md b/docs/schema/resubmitflag-simpletype-sps15xsdsearchset5.md index 8ef1e24ee..bdd56352c 100644 --- a/docs/schema/resubmitflag-simpletype-sps15xsdsearchset5.md +++ b/docs/schema/resubmitflag-simpletype-sps15xsdsearchset5.md @@ -1,28 +1,25 @@ --- title: "ResubmitFlag simpleType (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 06df3649-fa8b-f6d2-6265-c43613a637b2 -description: "Last modified: March 09, 2015" +description: "Describes the ResubmitFlag simpleType (SPS15XSDSearchSet5). Applies to SharePoint Server 2013." --- # ResubmitFlag simpleType (SPS15XSDSearchSet5) - - - **Applies to:** SharePoint Server 2013 - +**Applies to:** SharePoint Server 2013 + ## Type information -||| +|Information type|Value| |:-----|:-----| -|**Base type**
    || -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | +|**Base type**|| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query| +|**Schema file**|schema_Microsoft.Office.Server.Search.Query.xsd| ## Definition @@ -30,5 +27,3 @@ description: "Last modified: March 09, 2015" ``` - - diff --git a/docs/schema/resultitemtype-complextype-sps15xsdsearchset2.md b/docs/schema/resultitemtype-complextype-sps15xsdsearchset2.md index 6aeb85774..e62a95eee 100644 --- a/docs/schema/resultitemtype-complextype-sps15xsdsearchset2.md +++ b/docs/schema/resultitemtype-complextype-sps15xsdsearchset2.md @@ -1,26 +1,25 @@ --- title: "ResultItemType complexType (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 603dee83-8bb5-018a-c519-9c4f98f4fd1f -description: "Last modified: March 09, 2015" +description: "Describes the ResultItemType complexType (SPS15XSDSearchSet2). If the schema defines specific requirements, see the Definition section." --- # ResultItemType complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information type|Value| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |None
    | +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd | +|**Extension base**|None | ## Definition @@ -47,28 +46,26 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| |:-----|:-----|:-----| -|[BuiltIn](builtin-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |xs:boolean
    || -|[DisplayProperties](displayproperties-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |xs:string
    || -|[DisplayTemplateUrl](displaytemplateurl-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |xs:string
    || -|[ID](id-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |xs:int
    || -|[InternalID](internalid-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |ser:guid
    || -|[IsDeleted](isdeleted-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |xs:boolean
    || -|[LastModifiedDate](lastmodifieddate-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |xs:dateTime
    || -|[Name](name-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |xs:string
    || -|[OptimizeForFrequentUse](optimizeforfrequentuse-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |xs:boolean
    || -|[Owner](owner-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |tns:SearchObjectOwner
    || -|[RulePriority](rulepriority-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |xs:int
    || -|[Rules](rules-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |tns:PropertyRuleCollection
    || -|[SourceID](sourceid-element-resultitemtype-complextypesps15xsdsearchset2.md)
    |ser:guid
    || +|[BuiltIn](builtin-element-resultitemtype-complextypesps15xsdsearchset2.md)|xs:boolean || +|[DisplayProperties](displayproperties-element-resultitemtype-complextypesps15xsdsearchset2.md)|xs:string || +|[DisplayTemplateUrl](displaytemplateurl-element-resultitemtype-complextypesps15xsdsearchset2.md)|xs:string || +|[ID](id-element-resultitemtype-complextypesps15xsdsearchset2.md)|xs:int || +|[InternalID](internalid-element-resultitemtype-complextypesps15xsdsearchset2.md)|ser:guid || +|[IsDeleted](isdeleted-element-resultitemtype-complextypesps15xsdsearchset2.md)|xs:boolean || +|[LastModifiedDate](lastmodifieddate-element-resultitemtype-complextypesps15xsdsearchset2.md)|xs:dateTime || +|[Name](name-element-resultitemtype-complextypesps15xsdsearchset2.md)|xs:string || +|[OptimizeForFrequentUse](optimizeforfrequentuse-element-resultitemtype-complextypesps15xsdsearchset2.md)|xs:boolean || +|[Owner](owner-element-resultitemtype-complextypesps15xsdsearchset2.md)|tns:SearchObjectOwner || +|[RulePriority](rulepriority-element-resultitemtype-complextypesps15xsdsearchset2.md)|xs:int || +|[Rules](rules-element-resultitemtype-complextypesps15xsdsearchset2.md)|tns:PropertyRuleCollection || +|[SourceID](sourceid-element-resultitemtype-complextypesps15xsdsearchset2.md)|ser:guid || ### Attributes None. - - diff --git a/docs/schema/resultitemtype-element-arrayofresultitemtype-complextypesps15xsdsearchset2.md b/docs/schema/resultitemtype-element-arrayofresultitemtype-complextypesps15xsdsearchset2.md index b95418831..d4d5a15b3 100644 --- a/docs/schema/resultitemtype-element-arrayofresultitemtype-complextypesps15xsdsearchset2.md +++ b/docs/schema/resultitemtype-element-arrayofresultitemtype-complextypesps15xsdsearchset2.md @@ -1,26 +1,25 @@ --- title: "ResultItemType element (ArrayOfResultItemType complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: dce8db4c-63de-28b9-ec14-fa70969a2a90 -description: "Last modified: March 09, 2015" +description: "Describes the ResultItemType element (ArrayOfResultItemType complexType) (SPS15XSDSearchSet2). If the schema defines specific requirements, see the Definition section." --- # ResultItemType element (ArrayOfResultItemType complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information type|Value| |:-----|:-----| -|**Element type**
    |tns:ResultItemType
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | +|**Element type**|tns:ResultItemType | +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd | ## Definition @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/resultitemtype-element-sps15xsdsearchset2.md b/docs/schema/resultitemtype-element-sps15xsdsearchset2.md index 810e788e8..48e362b9c 100644 --- a/docs/schema/resultitemtype-element-sps15xsdsearchset2.md +++ b/docs/schema/resultitemtype-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "ResultItemType element (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 07/15/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f9df4572-7329-fa94-2f46-aab7795fb15f -description: "Last modified: March 09, 2015" +description: "Describes the ResultItemType element (SPS15XSDSearchSet2) information, definition, elements, and attributes." --- # ResultItemType element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|| Value | |:-----|:-----| |**Element type**
    |tns:ResultItemType
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/resulttype-element-sps15xsdsearchset5.md b/docs/schema/resulttype-element-sps15xsdsearchset5.md index 720f48b2d..dc9bcd8ab 100644 --- a/docs/schema/resulttype-element-sps15xsdsearchset5.md +++ b/docs/schema/resulttype-element-sps15xsdsearchset5.md @@ -1,29 +1,27 @@ --- title: "ResultType element (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 05e80b11-ea14-5b42-cf2f-f02cd4de18de -description: "Last modified: March 09, 2015" +description: "Describes the ResultType element (SPS15XSDSearchSet5). Applies to SharePoint Server 2013." --- # ResultType element (SPS15XSDSearchSet5) - - + **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Value| |:-----|:-----| -|**Element type**
    |tns:ResultType
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Element type** |tns:ResultType | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query | +|**Schema file** |schema_Microsoft.Office.Server.Search.Query.xsd | + ## Definition ```XML @@ -33,18 +31,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/resulttype-simpletype-sps15xsdsearchset5.md b/docs/schema/resulttype-simpletype-sps15xsdsearchset5.md index 06fb8c615..34fb56a15 100644 --- a/docs/schema/resulttype-simpletype-sps15xsdsearchset5.md +++ b/docs/schema/resulttype-simpletype-sps15xsdsearchset5.md @@ -1,34 +1,29 @@ --- title: "ResultType simpleType (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c420df39-2fb6-24f7-e20b-1fbef05a3320 -description: "Last modified: March 09, 2015" +description: "Describes the ResultType simpleType (SPS15XSDSearchSet5). Applies to SharePoint Server 2013." --- # ResultType simpleType (SPS15XSDSearchSet5) - - **Applies to:** SharePoint Server 2013 - + ## Type information -||| +|Information|Value| |:-----|:-----| -|**Base type**
    || -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Base type** || +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query | +|**Schema file** |schema_Microsoft.Office.Server.Search.Query.xsd | + ## Definition ```XML ``` - - diff --git a/docs/schema/resulttypes-element-searchqueryconfigurationsettings-complextypesps15xsdsearchse.md b/docs/schema/resulttypes-element-searchqueryconfigurationsettings-complextypesps15xsdsearchse.md index 087748ca8..fd4c77bfe 100644 --- a/docs/schema/resulttypes-element-searchqueryconfigurationsettings-complextypesps15xsdsearchse.md +++ b/docs/schema/resulttypes-element-searchqueryconfigurationsettings-complextypesps15xsdsearchse.md @@ -1,27 +1,25 @@ --- title: "ResultTypes element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 64381654-15fe-3e5b-0882-5820056f5d31 -description: "Last modified: March 09, 2015" +description: "Describes the ResultTypes element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3)." --- # ResultTypes element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3) - - + ## Element information -||| +|Information|Value| |:-----|:-----| -|**Element type**
    |q4:ArrayOfResultItemType
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type** |q4:ArrayOfResultItemType | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | + ## Definition ```XML @@ -31,18 +29,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/retrievable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/retrievable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md index 7094ef7d5..5d0fef556 100644 --- a/docs/schema/retrievable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/retrievable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,24 @@ --- title: "Retrievable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/10/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 16c2408d-d5a3-65f0-cab0-639975056adb -description: "Last modified: March 09, 2015" +description: "Describes the Retrievable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)." --- # Retrievable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - ## Element information -||| +|Information|Value| |:-----|:-----| -|**Element type**
    |xs:boolean
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |xs:boolean | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +28,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/ribbon-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/ribbon-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index 0f512d9fe..493ade05f 100644 --- a/docs/schema/ribbon-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/ribbon-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,24 +1,24 @@ --- title: Ribbon element (CommandUIDefinitionType complexType) +description: Describes the Ribbon element (CommandUIDefinitionType complexType). manager: soliver -ms.date: 9/16/2015 +ms.date: 06/10/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 84f34bdc-14ec-58f2-1667-5adaae41be7e --- -# Ribbon element (CommandUIDefinitionType complexType) +# Ribbon element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +|Information|Value| |---|---| | **Element type** | RibbonType | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | @@ -30,7 +30,7 @@ ms.assetid: 84f34bdc-14ec-58f2-1667-5adaae41be7e ``` -## Elements and attributes +## Elements and attributes If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. @@ -59,26 +59,18 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements None. -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/ribbon-element.md b/docs/schema/ribbon-element.md index 75e55190d..deeb9b8e5 100644 --- a/docs/schema/ribbon-element.md +++ b/docs/schema/ribbon-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Contains elements that define the server ribbon user interface. # Ribbon element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Contains elements that define the server ribbon user interface. - + ```XML |Optional. Hidden text to convey contextual tab information to screen readers, such as " {0} group. Tab {1} of {2}."
    | |**ATTabPositionText**
    |Optional. Hidden text to convey tab information to screen readers, such as "Tab {0} of {1}."
    | |**NavigationHelpText**
    |Optional. The text of a message that describes how to navigate the ribbon using the keyboard, which is displayed as hidden text for a screen reader.
    | - + ### Child elements -- [Tabs](tabs-element.md) +- [Tabs](tabs-element.md) - [ContextualTabs](contextualtabs-element.md) - + ### Parent elements - [CommandUI](commandui-element.md) - + ### Occurrences -- Minimum: 0 -- Maximum: 1 - +- Minimum: 0 +- Maximum: 1 + ## See also - [Customizing the Server Ribbon](https://msdn.microsoft.com/library/dedfad80-0f32-44cd-9080-1507be3288e7%28Office.15%29.aspx) - diff --git a/docs/schema/ribbontemplates.md b/docs/schema/ribbontemplates.md index fd46015ca..4bbd94557 100644 --- a/docs/schema/ribbontemplates.md +++ b/docs/schema/ribbontemplates.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Contains elements that define group templates. # RibbonTemplates element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Contains elements that define group templates. - + ```XML |Required. A string that unambiguously identifies the element, such as "Ribbon.Templates".
    | - + ### Child elements - [GroupTemplate](grouptemplate-element.md) - + ### Parent elements - [Templates](templates-element.md) - - diff --git a/docs/schema/right-element-in-accesscontrolentry-bdcmetadata-schema.md b/docs/schema/right-element-in-accesscontrolentry-bdcmetadata-schema.md index 4ba27bcc0..988361f06 100644 --- a/docs/schema/right-element-in-accesscontrolentry-bdcmetadata-schema.md +++ b/docs/schema/right-element-in-accesscontrolentry-bdcmetadata-schema.md @@ -7,8 +7,7 @@ ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.Right -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a2e4bd6c-2306-b657-7290-cc9c9b262911 --- # Right Element in AccessControlEntry (BDCMetadata Schema) @@ -112,11 +111,3 @@ None. - - - - - - - - diff --git a/docs/schema/right-element-in-accesscontrolentry-bdcmetadataresource-schema.md b/docs/schema/right-element-in-accesscontrolentry-bdcmetadataresource-schema.md index 81f0b606c..192e7e809 100644 --- a/docs/schema/right-element-in-accesscontrolentry-bdcmetadataresource-schema.md +++ b/docs/schema/right-element-in-accesscontrolentry-bdcmetadataresource-schema.md @@ -1,12 +1,11 @@ --- title: Right Element in AccessControlEntry (BDCMetadataResource Schema) -description: Details on the Right Element in AccessControlEntry (BDCMetadataResource Schema) +description: Describes the elements and attributes for Right Element in AccessControlEntry (BDCMetadataResource Schema). manager: soliver -ms.date: 01/27/2021 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7e38207d-be3b-ea12-aac1-0dd657a33c21 --- @@ -92,29 +91,6 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    AccessControlEntry Element in AccessControlList (BDCMetadataResource Schema)

    - - - - - - - - +| Element | Description | +|---------|-------------| +| [AccessControlEntry Element in AccessControlList (BDCMetadataResource Schema)](accesscontrolentry-element-in-accesscontrollist-bdcmetadataresource-schema.md) | | diff --git a/docs/schema/rightschoices-element-view.md b/docs/schema/rightschoices-element-view.md index febe91294..f1ee02641 100644 --- a/docs/schema/rightschoices-element-view.md +++ b/docs/schema/rightschoices-element-view.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: - schema ms.assetid: d9a55f3c-1490-4808-9af0-7d6c46efc01f -description: Contains specification of the permissions that current users must have in order for the contents of the Then clause within an IfHasRight element to be displayed. +description: Contains specification of the permissions that current users must have in order for the contents of the Then clause within an IfHasRight element to be displayed. --- # RightsChoices element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Contains specification of the permissions that current users must have in order for the contents of the [Then](then-element-view.md) clause within an [IfHasRight](ifhasrights-element-view.md) element to be displayed. - + +Contains specification of the permissions that current users must have in order for the contents of the [Then](then-element-view.md) clause within an [IfHasRight](ifhasrights-element-view.md) element to be displayed. + ```XML - +- Maximum: 1 +
    diff --git a/docs/schema/rightsgroup-element-view.md b/docs/schema/rightsgroup-element-view.md index 4cfe8f126..75359fc2b 100644 --- a/docs/schema/rightsgroup-element-view.md +++ b/docs/schema/rightsgroup-element-view.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: - schema ms.assetid: 2581816d-83ce-4206-9dcc-da6edd82ae52 -description: Specifies a permission that the current user must have to permit the contents of the Then clause within an IfHasRight element to be displayed. +description: Specifies a permission that the current user must have to permit the contents of the Then clause within an IfHasRight element to be displayed. --- # RightsGroup element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Specifies a permission that the current user must have to permit the contents of the [Then](then-element-view.md) clause within an [IfHasRight](ifhasrights-element-view.md) element to be displayed. - + +Specifies a permission that the current user must have to permit the contents of the [Then](then-element-view.md) clause within an [IfHasRight](ifhasrights-element-view.md) element to be displayed. + ```XML @@ -66,20 +65,18 @@ The following sections describe attributes, child elements, and parent elements. |**PermViewPages="Required"**
    |View pages in a website.
    | |**PermViewUsageData="Required"**
    |View reports on website usage.
    | |**PermViewVersions="Required"**
    |View versions of items.
    | - + ### Child elements -None - +None + ### Parent elements - [RightsChoices](rightschoices-element-view.md) - + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - -
    - +- Maximum: Unbounded +
    diff --git a/docs/schema/role-element-deploymentmanifest.md b/docs/schema/role-element-deploymentmanifest.md index d980a1412..fc82f8626 100644 --- a/docs/schema/role-element-deploymentmanifest.md +++ b/docs/schema/role-element-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "Role Element (DeploymentManifest)" +description: "The Role Element (DeploymentManifest) represents an instance of a Windows SharePoint Services 3.0 deployment role (DeploymentRole) object." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 76bf9339-6d33-48a5-b59f-a5d5317c9778 -description: "Last modified: March 09, 2015" --- # Role Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Represents an instance of a Windows SharePoint Services 3.0 deployment role (**DeploymentRole**) object. ## Definition @@ -39,8 +38,8 @@ USAGE ## Type -**DeploymentRole** (based on [SPRole](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRole.aspx)) - +**DeploymentRole** (based on [SPRole](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRole.aspx)) + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -56,19 +55,19 @@ The following sections describe attributes, child elements, and parent elements. |**Hidden**
    |xs:boolean
    |Required. Specifies whether the role is hidden; **true** if the role is hidden, otherwise, **false**.
    | |**RoleOrder**
    |xs:string
    |Optional. Specifies the order in which permission levels are displayed on the **Permission Levels** page of a site collection.
    | |**Type**
    |xs:string
    |Optional. Specifies the role type, as listed in the [Microsoft.SharePoint.SPRoleType](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleType.aspx) enumeration.
    | - + ### Child elements None - + ### Parent elements [Roles Element (DeploymentManifest)](roles-element-deploymentmanifest.md) - + ### Remarks -The value of the **RoleID** property corresponds to the unique member ID for the role, which is specified in the [SPMember.ID](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPMember.ID.aspx) property of the [SPMember](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPMember.aspx) class. - +The value of the **RoleID** property corresponds to the unique member ID for the role, which is specified in the [SPMember.ID](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPMember.ID.aspx) property of the [SPMember](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPMember.aspx) class. + ## See also - [SPRole](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRole.aspx) @@ -76,4 +75,3 @@ The value of the **RoleID** property corresponds to the unique member ID for the - [ID](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPMember.ID.aspx) - [SPRoleType](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleType.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/roleassignment-element-deploymentmanifest.md b/docs/schema/roleassignment-element-deploymentmanifest.md index f980149f1..50f2633c6 100644 --- a/docs/schema/roleassignment-element-deploymentmanifest.md +++ b/docs/schema/roleassignment-element-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "RoleAssignment Element (DeploymentManifest)" +description: "Describes the RoleAssignment Element (DeploymentManifest), which represents an instance of a deployment role assignment (DeploymentRoleAssignment) object." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7a305e0f-5605-4083-bf6a-71e50c601ec9 -description: "Last modified: March 09, 2015" --- # RoleAssignment Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Represents an instance of a deployment role assignment (**DeploymentRoleAssignment**) object. ## Definition @@ -40,8 +39,8 @@ USAGE ## Type -**DeploymentRoleAssignment** (based on [SPRoleAssignment](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleAssignment.aspx)) - +**DeploymentRoleAssignment** (based on [SPRoleAssignment](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleAssignment.aspx)) + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -57,17 +56,16 @@ The following sections describe attributes, child elements, and parent elements. |**ObjectType**
    |xs:string
    |Required. Type of the role assignment object.
    | |**ObjectUrl**
    |xs:string
    |Required. URL to the role assignment object.
    | |**AnonymousPermMask**
    |xs:string
    |Optional. Permission mask for anonymous users.
    | - + ### Child elements [Assignment Element (DeploymentManifest)](assignment-element-deploymentmanifest.md) - + ### Parent elements [RoleAssignments Element (DeploymentManifest)](roleassignments-element-deploymentmanifest.md) - + ## See also - [SPRoleAssignment](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleAssignment.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/roleassignments-element-deploymentmanifest.md b/docs/schema/roleassignments-element-deploymentmanifest.md index 9127a93ce..1e3d3db1c 100644 --- a/docs/schema/roleassignments-element-deploymentmanifest.md +++ b/docs/schema/roleassignments-element-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "RoleAssignments Element (DeploymentManifest)" +description: "Describes the RoleAssignments Element (DeploymentManifest), which Represents a collection of deployment role assignment (DeploymentRoleAssignments) objects." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 14fccefa-96a8-4c07-bb55-87a27dbff332 -description: "Last modified: March 09, 2015" --- # RoleAssignments Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Represents a collection of deployment role assignment (**DeploymentRoleAssignments**) objects. ## Definition @@ -33,8 +32,8 @@ USAGE ## Type -**DeploymentRoleAssignments** (based on [SPRoleAssignmentCollection](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleAssignmentCollection.aspx)) - +**DeploymentRoleAssignments** (based on [SPRoleAssignmentCollection](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleAssignmentCollection.aspx)) + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -42,17 +41,16 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [RoleAssignment Element (DeploymentManifest)](roleassignment-element-deploymentmanifest.md) - + ### Parent elements [SPObject Element (DeploymentManifest)](spobject-element-deploymentmanifest.md) - + ## See also - [SPRoleAssignmentCollection](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleAssignmentCollection.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/roleassignmentx-element-deploymentmanifest.md b/docs/schema/roleassignmentx-element-deploymentmanifest.md index 65a93e148..97f706821 100644 --- a/docs/schema/roleassignmentx-element-deploymentmanifest.md +++ b/docs/schema/roleassignmentx-element-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "RoleAssignmentX Element (DeploymentManifest)" +description: "Describes the RoleAssignmentX Element, which represents a security role assignment in cases where incremental changes to the base object are being deployed." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6fb13349-16fd-4fb6-b0d7-a469e276cb18 -description: "Last modified: March 09, 2015" --- # RoleAssignmentX Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Represents a security role assignment in cases where incremental changes to the base object are being deployed. ## Definition @@ -45,8 +44,8 @@ USAGE ## Type -**DeploymentRoleAssignmentX** (based on [SPRoleAssignment](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleAssignment.aspx)) - +**DeploymentRoleAssignmentX** (based on [SPRoleAssignment](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleAssignment.aspx)) + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -68,18 +67,17 @@ The following sections describe attributes, child elements, and parent elements. |**RoleId**
    |xs:string
    |Optional. Identifier of the security role.
    | |**GroupTitle**
    |xs:string
    |Optional. Display name of the security group that is associated with the role.
    | |**UserLogin**
    |xs:string
    |Optional. Logon credential for users associated with the role.
    | - + ### Child elements None - + ### Parent elements [SPObject Element (DeploymentManifest)](spobject-element-deploymentmanifest.md) - + ## See also - [SPRoleAssignment](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleAssignment.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - [RoleAssignment Element (DeploymentManifest)](roleassignment-element-deploymentmanifest.md) - diff --git a/docs/schema/roles-element-deploymentmanifest.md b/docs/schema/roles-element-deploymentmanifest.md index d21b4fb2d..878e6791b 100644 --- a/docs/schema/roles-element-deploymentmanifest.md +++ b/docs/schema/roles-element-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "Roles Element (DeploymentManifest)" +description: "The Roles Element (DeploymentManifest) represents a collection of Windows SharePoint Services 3.0 deployment role (DeploymentRole) objects." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 605edbbd-b46e-4c62-a012-adbaba0bcf17 -description: "Last modified: March 09, 2015" --- # Roles Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Represents a collection of Windows SharePoint Services 3.0 deployment role (**DeploymentRole**) objects. ## Definition @@ -33,8 +32,8 @@ USAGE ## Type -**DeploymentRoles** (based on [SPRoleCollection](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleCollection.aspx)) - +**DeploymentRoles** (based on [SPRoleCollection](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleCollection.aspx)) + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -42,17 +41,16 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [Role Element (DeploymentManifest)](role-element-deploymentmanifest.md) - + ### Parent elements [SPObject Element (DeploymentManifest)](spobject-element-deploymentmanifest.md) - + ## See also - [SPRoleCollection](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleCollection.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/rolex-element-deploymentmanifest.md b/docs/schema/rolex-element-deploymentmanifest.md index 090e76260..37e9fc660 100644 --- a/docs/schema/rolex-element-deploymentmanifest.md +++ b/docs/schema/rolex-element-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "RoleX Element (DeploymentManifest)" +description: "The RoleX Element (DeploymentManifest) represents a security role in cases where incremental changes to the base object are being deployed." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 57e68176-fe88-40e2-bcb7-bee76b69eb71 -description: "Last modified: March 09, 2015" --- # RoleX Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Represents a security role in cases where incremental changes to the base object are being deployed. ## Definition @@ -45,8 +44,8 @@ USAGE ## Type -**DeploymentRoleX** (based on [SPRole](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRole.aspx)) - +**DeploymentRoleX** (based on [SPRole](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRole.aspx)) + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -68,18 +67,17 @@ The following sections describe attributes, child elements, and parent elements. |**Type**
    |xs:string
    |Optional. Type for the role as listed in the [Microsoft.SharePoint.SPRoleType](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRoleType.aspx) enumeration.
    | |**UserId**
    |xs:string
    |Optional. Identifier of users that belong to the role.
    | |**UserLogin**
    |xs:string
    |Optional. Logon credential for user.
    | - + ### Child elements None - + ### Parent elements [SPObject Element (DeploymentManifest)](spobject-element-deploymentmanifest.md) - + ## See also - [SPRole](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPRole.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - [Role Element (DeploymentManifest)](role-element-deploymentmanifest.md) - diff --git a/docs/schema/rootfile-element-solution.md b/docs/schema/rootfile-element-solution.md index 18a18b064..8c339ea45 100644 --- a/docs/schema/rootfile-element-solution.md +++ b/docs/schema/rootfile-element-solution.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Solution Schema api_type: @@ -17,9 +16,9 @@ description: Specifies a root path to which solution files are copied. # RootFile element (Solution) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies a root path to which solution files are copied. - + ```XML @@ -35,19 +34,19 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Description**| |:-----|:-----| |**Location**
    |Required **Text**. A path that is relative to %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\.
    | - + ### Child elements None - + ### Parent elements - [RootFiles](rootfiles-element-solution.md) - + ### Remarks Use this element to deploy a localization resource that is shared by several features. Shared localization resources are located in the %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\Resources folder. For example, the following XML deploys three shared localization resource files. - + ```XML @@ -62,7 +61,7 @@ For more information about using shared localization resources, see the descript
    Localization resources used by extensions to the Central Administration user interface are located in the %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\Config\AdminResources folder. The following XML deploys localization resource files to that folder. - + ```XML @@ -71,5 +70,3 @@ Localization resources used by extensions to the Central Administration user int ``` - - diff --git a/docs/schema/rootfiles-element-solution.md b/docs/schema/rootfiles-element-solution.md index 1c6983b98..4fc16950c 100644 --- a/docs/schema/rootfiles-element-solution.md +++ b/docs/schema/rootfiles-element-solution.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Solution Schema api_type: @@ -17,9 +16,9 @@ description: Specifies the root paths to which solution files are copied. # RootFiles element (Solution) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies the root paths to which solution files are copied. - + ```XML - - diff --git a/docs/schema/rootobject-element-deploymentrootobjectmap.md b/docs/schema/rootobject-element-deploymentrootobjectmap.md index 2ffc430bd..c8991d76e 100644 --- a/docs/schema/rootobject-element-deploymentrootobjectmap.md +++ b/docs/schema/rootobject-element-deploymentrootobjectmap.md @@ -1,19 +1,18 @@ --- title: "RootObject Element (DeploymentRootObjectMap)" +description: "The RootObject Element (DeploymentRootObjectMap) represents an instance of a root object in a root object map exported to the content migration package." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4ca81cf3-22b7-48e0-81ee-eb0399cfef05 -description: "Last modified: March 09, 2015" --- # RootObject Element (DeploymentRootObjectMap) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents an instance of a root object in a root object map exported to the content migration package. ## Definition @@ -22,7 +21,7 @@ Represents an instance of a root object in a root object map exported to the con DECLARATION USAGE @@ -41,7 +40,7 @@ USAGE ## Type **SPRootObject** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -56,16 +55,15 @@ The following sections describe attributes, child elements, and parent elements. |WebUrl
    |xs:string
    |Optional. URL to the parent website.
    | |Url
    |xs:string
    |Optional. URL to the root object.
    | |IsDependency
    |xs:boolean
    |Optional. Specifies whether the object is a dependent object. The value is **true** if the object is dependent; otherwise, **false**.
    | - + ### Child elements None - + ### Parent elements [RootObjects Element (DeploymentRootObjectMap)](rootobjects-element-deploymentrootobjectmap.md) - + ## See also - [DeploymentRootObjectMap Schema](deploymentrootobjectmap-schema.md) - diff --git a/docs/schema/rootobjects-element-deploymentrootobjectmap.md b/docs/schema/rootobjects-element-deploymentrootobjectmap.md index 6ebcfeff8..34f147117 100644 --- a/docs/schema/rootobjects-element-deploymentrootobjectmap.md +++ b/docs/schema/rootobjects-element-deploymentrootobjectmap.md @@ -1,19 +1,18 @@ --- title: "RootObjects Element (DeploymentRootObjectMap)" +description: "The RootObjects Element (DeploymentRootObjectMap) represents a collection of listed root object (SPRootObject) instances." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b3ce08a1-f231-474f-8f25-922d39d94d64 -description: "Last modified: March 09, 2015" --- # RootObjects Element (DeploymentRootObjectMap) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a collection of listed root object (**SPRootObject**) instances. ## Definition @@ -31,7 +30,7 @@ USAGE ## Type **SPRootObjects** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -39,20 +38,19 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [RootObject Element (DeploymentRootObjectMap)](rootobject-element-deploymentrootobjectmap.md) - + ### Parent elements None - + ### Remarks -The **RootObjects** element is the root element of the DeploymentRootObjectMap schema and therefore has no parent element. - +The **RootObjects** element is the root element of the DeploymentRootObjectMap schema and therefore has no parent element. + ## See also - [DeploymentRootObjectMap Schema](deploymentrootobjectmap-schema.md) - diff --git a/docs/schema/row-dsqueryresponse.md b/docs/schema/row-dsqueryresponse.md index e7b6db66c..ff68f98b6 100644 --- a/docs/schema/row-dsqueryresponse.md +++ b/docs/schema/row-dsqueryresponse.md @@ -5,8 +5,7 @@ manager: soliver ms.date: 12/14/2020 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - dsQueryResponse XML ms.assetid: e2d1bbbe-c920-41d0-994a-f06a122ba3fd diff --git a/docs/schema/row-element-list-instance.md b/docs/schema/row-element-list-instance.md index 9e304cf57..325511195 100644 --- a/docs/schema/row-element-list-instance.md +++ b/docs/schema/row-element-list-instance.md @@ -1,11 +1,11 @@ --- title: Row Element (List Instance) +description: The Row Element (List Instance) is used within the Data element in a list instance definition to provide a set of default data. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: da8a0d62-cb49-4990-a8ae-fe134f2e91f8 --- @@ -75,11 +75,3 @@ None For an example of how this element is used, see [List Instances](list-instances.md).
    - - - - - - - - diff --git a/docs/schema/row-element-site.md b/docs/schema/row-element-site.md index 68ae8f921..aab28fa7c 100644 --- a/docs/schema/row-element-site.md +++ b/docs/schema/row-element-site.md @@ -1,25 +1,24 @@ --- title: "Row element (Site)" +description: "Row element (Site) is used within the Data element in a list definition to provide a set of default data when a list is instantiated during site provisioning." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: - schema ms.assetid: 33449e60-4a1f-4e53-bea7-72b88a742ae0 -description: "Last modified: March 09, 2015" --- # Row element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Used within the [Data](data-element-site.md) element in a list definition to provide a set of default data when a list is instantiated during site provisioning. - + +Used within the [Data](data-element-site.md) element in a list definition to provide a set of default data when a list is instantiated during site provisioning. + ```XML @@ -32,37 +31,35 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [Field](field-element-site.md) - + ### Parent elements - [Rows](rows-element-site.md) - + ### Occurrences - Minimum: 0 - Maximum: Unbounded - + ## Example The following example defines one row of fields for the welcome page. - + ```XML Welcome to your new team website! - You can use this site to share information - with members of the site. To add a new announcement, click - "Add new announcement" below. This is a great way to + You can use this site to share information + with members of the site. To add a new announcement, click + "Add new announcement" below. This is a great way to communicate news with your team. ``` - - diff --git a/docs/schema/row-element.md b/docs/schema/row-element.md index 104c1ac31..ae937edc9 100644 --- a/docs/schema/row-element.md +++ b/docs/schema/row-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines a row in a section of a layout. # Row element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a row in a section of a layout. - + ```XML ``` @@ -34,23 +33,23 @@ None ### Child elements -- [ControlRef](controlref-element.md) -- [Strip](strip-element.md) -- [OverflowArea](overflowarea-element.md) - +- [ControlRef](controlref-element.md) +- [Strip](strip-element.md) +- [OverflowArea](overflowarea-element.md) + ### Parent elements - [Section](section-element.md) - + ### Occurrences - Minimum: 0 -- Maximum: 3 - +- Maximum: 3 + ## Example The following example is a fragment from the default server ribbon definition. - + ```XML @@ -78,5 +77,3 @@ The following example is a fragment from the default server ribbon definition. ``` - - diff --git a/docs/schema/rowfields-element-alerttemplates.md b/docs/schema/rowfields-element-alerttemplates.md index 3009706fd..80288d8bf 100644 --- a/docs/schema/rowfields-element-alerttemplates.md +++ b/docs/schema/rowfields-element-alerttemplates.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - AlertTemplates schema api_type: @@ -17,9 +16,9 @@ description: Specifies row fields for the alert message. # RowFields element (AlertTemplates) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies row fields for the alert message. - + ```XML @@ -32,13 +31,11 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [Digest](digest-element-alerttemplates.md) - - diff --git a/docs/schema/rowfooter-element-alerttemplates.md b/docs/schema/rowfooter-element-alerttemplates.md index bbaf834bb..b42eb75b1 100644 --- a/docs/schema/rowfooter-element-alerttemplates.md +++ b/docs/schema/rowfooter-element-alerttemplates.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - AlertTemplates schema api_type: @@ -17,9 +16,9 @@ description: Specifies row footer information for the alert message. # RowFooter element (AlertTemplates) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies row footer information for the alert message. - + ```XML @@ -32,13 +31,11 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [Digest](digest-element-alerttemplates.md) - - diff --git a/docs/schema/rowheader-element-alerttemplates.md b/docs/schema/rowheader-element-alerttemplates.md index 469e7f12e..f2c49e3a7 100644 --- a/docs/schema/rowheader-element-alerttemplates.md +++ b/docs/schema/rowheader-element-alerttemplates.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - AlertTemplates schema api_type: @@ -17,9 +16,9 @@ description: Specifies row header information for the alert message. # RowHeader element (AlertTemplates) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies row header information for the alert message. - + ```XML @@ -32,13 +31,11 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [Digest](digest-element-alerttemplates.md) - - diff --git a/docs/schema/rowlimit-element-deploymentmanifestspview.md b/docs/schema/rowlimit-element-deploymentmanifestspview.md index ed7b21dff..3b192b060 100644 --- a/docs/schema/rowlimit-element-deploymentmanifestspview.md +++ b/docs/schema/rowlimit-element-deploymentmanifestspview.md @@ -1,19 +1,18 @@ --- title: "RowLimit element (DeploymentManifest - SPView)" +description: "RowLimit element (DeploymentManifest - SPView) represents the limit on the number of rows (items) returned by a view query on a given page." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 00e6b2da-870a-4592-87a4-d8b5ad20f7b1 -description: "Last modified: March 09, 2015" --- # RowLimit element (DeploymentManifest - SPView) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Represents the limit on the number of rows (items) returned by a view query on a given page. ## Definition @@ -32,7 +31,7 @@ USAGE ## Type **xs:string** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -40,16 +39,15 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [View element (DeploymentManifest)](view-element-deploymentmanifest.md) - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/rowlimit-element-deploymentmanifestspwebpart.md b/docs/schema/rowlimit-element-deploymentmanifestspwebpart.md index c41b8f0ad..44589dcd6 100644 --- a/docs/schema/rowlimit-element-deploymentmanifestspwebpart.md +++ b/docs/schema/rowlimit-element-deploymentmanifestspwebpart.md @@ -1,20 +1,19 @@ --- title: "RowLimit element (DeploymentManifest - SPWebPart)" +description: "RowLimit element (DeploymentManifest - SPWebPart) represents the limit on the number of rows (items) returned by a query on an instance of a web part object." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4a0bc9f1-5506-4a06-9a45-ce35252a4f62 -description: "Last modified: March 09, 2015" --- # RowLimit element (DeploymentManifest - SPWebPart) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represeents the limit on the number of rows (items) returned by a query on an instance of a web part object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents the limit on the number of rows (items) returned by a query on an instance of a web part object. ## Definition @@ -36,16 +35,15 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [WebPart element (DeploymentManifest)](webpart-element-deploymentmanifest.md) - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/rowlimit-element-list.md b/docs/schema/rowlimit-element-list.md index 4b8c88fc3..7ff532e48 100644 --- a/docs/schema/rowlimit-element-list.md +++ b/docs/schema/rowlimit-element-list.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: @@ -17,9 +16,9 @@ description: Sets the row limit for the number of items to display in a view. # RowLimit element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Sets the row limit for the number of items to display in a view. - + ```XML @@ -35,33 +34,33 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Description**| |:-----|:-----| |**Paged**
    |Optional **Boolean**. **TRUE** to specify that the list supports displaying more items page by page. If **FALSE** or unspecified, the row limit is absolute, and there is no link to see more items.
    | - + ### Child elements None - + ### Parent elements - [View](view-element-list.md) - [ViewStyle](viewstyle-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ### Remarks -When **Paged** is set to **TRUE**, a [PagedRowset](pagedrowset-element-list.md) element must be implemented. Otherwise, the server provides a generic implementation of a paged rowset that is defined in the STDVIEW.XML file. - -If **Paged** is not **TRUE** and the row limit is exceeded, the server renders a [RowLimitExceeded](rowlimitexceeded-element-list.md) element in the view if this element is specified. Otherwise, the default behavior is to give no indication to the user that the row limit has been exceeded. - -If **Paged** is **TRUE**, the number of items per page is displayed, and a **Next** button provides a link to the next set of items. - +When **Paged** is set to **TRUE**, a [PagedRowset](pagedrowset-element-list.md) element must be implemented. Otherwise, the server provides a generic implementation of a paged rowset that is defined in the STDVIEW.XML file. + +If **Paged** is not **TRUE** and the row limit is exceeded, the server renders a [RowLimitExceeded](rowlimitexceeded-element-list.md) element in the view if this element is specified. Otherwise, the default behavior is to give no indication to the user that the row limit has been exceeded. + +If **Paged** is **TRUE**, the number of items per page is displayed, and a **Next** button provides a link to the next set of items. + ## Example The following line sets 100 as the row limit and specifies that a link be provided to see items that exceed the limit. - + ```XML 100 ``` @@ -69,4 +68,3 @@ The following line sets 100 as the row limit and specifies that a link be provid ## See also - [List Views](https://msdn.microsoft.com/library/43e6ba7e-eddb-418a-a570-c0815016fc17%28Office.15%29.aspx) - diff --git a/docs/schema/rowlimitexceeded-element-deploymentmanifestspview.md b/docs/schema/rowlimitexceeded-element-deploymentmanifestspview.md index eb0de07e2..f09e48ff1 100644 --- a/docs/schema/rowlimitexceeded-element-deploymentmanifestspview.md +++ b/docs/schema/rowlimitexceeded-element-deploymentmanifestspview.md @@ -1,20 +1,19 @@ --- title: "RowLimitExceeded element (DeploymentManifest - SPView)" +description: "RowLimitExceeded element (DeploymentManifest - SPView) represents the means for displaying overflow data when a row limit is exceeded." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5b148f83-0a2c-4f00-9f6f-2de20f830ab7 -description: "Last modified: March 09, 2015" --- # RowLimitExceeded element (DeploymentManifest - SPView) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents the means for displaying overflow data when a row limit on a specified instance of a Windows SharePoint Services 3.0 view ([SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx)) object is exceeded. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents the means for displaying overflow data when a row limit on a specified instance of a Windows SharePoint Services 3.0 view ([SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx)) object is exceeded. ## Definition @@ -32,7 +31,7 @@ USAGE ## Type xs:string - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -40,18 +39,17 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [View element (DeploymentManifest)](view-element-deploymentmanifest.md) - + ## See also - [RowLimitExceeded](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.RowLimitExceeded.aspx) - [SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/rowlimitexceeded-element-deploymentmanifestspwebpart.md b/docs/schema/rowlimitexceeded-element-deploymentmanifestspwebpart.md index cd53cc4dd..411eb9ab7 100644 --- a/docs/schema/rowlimitexceeded-element-deploymentmanifestspwebpart.md +++ b/docs/schema/rowlimitexceeded-element-deploymentmanifestspwebpart.md @@ -1,19 +1,18 @@ --- title: "RowLimitExceeded element (DeploymentManifest - SPWebPart)" +description: "RowLimitExceeded element (DeploymentManifest - SPWebPart) represents the means for displaying overflow data when a row limit is exceeded." manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5fe03d39-4800-4333-ab03-377c6fa3871b -description: "Last modified: March 09, 2015" --- # RowLimitExceeded element (DeploymentManifest - SPWebPart) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Represents the means for displaying overflow data when a row limit on a specified instance of a Windows SharePoint Services 3.0 web part object is exceeded. ## Definition @@ -32,7 +31,7 @@ USAGE ## Type xs:string - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -40,16 +39,15 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [WebPart element (DeploymentManifest)](webpart-element-deploymentmanifest.md) - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/rowlimitexceeded-element-list.md b/docs/schema/rowlimitexceeded-element-list.md index abc52f86d..ce9ad4974 100644 --- a/docs/schema/rowlimitexceeded-element-list.md +++ b/docs/schema/rowlimitexceeded-element-list.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - List schema api_type: @@ -17,17 +16,17 @@ description: Specifies alternate rendering when a row limit is exceeded. Execute # RowLimitExceeded element (List) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies alternate rendering when a row limit is exceeded. It executes if the **Paged** attribute of the [Row](row-element-site.md) element is not set to **TRUE**. ```XML ``` - + > [!NOTE] -> Most standard Microsoft SharePoint Foundation 2010 list views ignore this element. For more information, see [XMLDefinition and CAML View Schema](https://msdn.microsoft.com/library/1845d203-4699-4b0e-a182-2d9998439922%28Office.15%29.aspx). - +> Most standard Microsoft SharePoint Foundation 2010 list views ignore this element. For more information, see [XMLDefinition and CAML View Schema](https://msdn.microsoft.com/library/1845d203-4699-4b0e-a182-2d9998439922%28Office.15%29.aspx). + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -35,27 +34,27 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -Numerous - +Numerous + ### Parent elements - [View](view-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ## Example The following example provides a link to more items if the row limit is exceeded. - + ```XML - @@ -70,8 +69,7 @@ The following example provides a link to more items if the row limit is exceeded ## See also -- [List Views](https://msdn.microsoft.com/library/43e6ba7e-eddb-418a-a570-c0815016fc17%28Office.15%29.aspx) -- [XMLDefinition and CAML View Schema](https://msdn.microsoft.com/library/1845d203-4699-4b0e-a182-2d9998439922%28Office.15%29.aspx) -- [RowLimit element (List)](rowlimit-element-list.md) +- [List Views](https://msdn.microsoft.com/library/43e6ba7e-eddb-418a-a570-c0815016fc17%28Office.15%29.aspx) +- [XMLDefinition and CAML View Schema](https://msdn.microsoft.com/library/1845d203-4699-4b0e-a182-2d9998439922%28Office.15%29.aspx) +- [RowLimit element (List)](rowlimit-element-list.md) - [Rows element (Site)](rows-element-site.md) - diff --git a/docs/schema/rows-dsqueryresponse.md b/docs/schema/rows-dsqueryresponse.md index 1c72c202f..8ebcb9a8d 100644 --- a/docs/schema/rows-dsqueryresponse.md +++ b/docs/schema/rows-dsqueryresponse.md @@ -4,20 +4,19 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - dsQueryResponse XML ms.assetid: c4c14d0d-5002-445f-8663-bd38fd21434e -description: Contains a collection of Row elements that specify the data from the list. +description: Contains a collection of Row elements that specify the data from the list. --- # Rows element (dsQueryResponse) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Contains a collection of **Row** elements that specify the data from the list. - + +Contains a collection of **Row** elements that specify the data from the list. + ```XML @@ -33,22 +32,20 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [Row](row-dsqueryresponse.md) - + ### Parent elements - [dsQueryResponse](dsqueryresponse.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ## Example For an example, see [Examples of Input and Result Node Trees in XSLT Transformations](https://msdn.microsoft.com/library/cbe88144-25ac-4cd2-8f2a-50e8c271c6ae%28Office.15%29.aspx). - - diff --git a/docs/schema/rows-element-list-instance.md b/docs/schema/rows-element-list-instance.md index c52cd4ae7..bd1e521ce 100644 --- a/docs/schema/rows-element-list-instance.md +++ b/docs/schema/rows-element-list-instance.md @@ -1,11 +1,11 @@ --- title: Rows Element (List Instance) +description: Describes the definition, element, and attribute information for the Rows Element (List Instance), which contains a collection of Row elements. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 28b2c8b4-5df8-4430-97ef-663a7cc30142 --- @@ -84,11 +84,3 @@ The **Rows** element is used within the [Data](data-element-site.md) element of For an example of how this element is used, see [List Instances](list-instances.md).
    - - - - - - - - diff --git a/docs/schema/rows-element-site.md b/docs/schema/rows-element-site.md index 75b979fcf..b61c985f8 100644 --- a/docs/schema/rows-element-site.md +++ b/docs/schema/rows-element-site.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: - schema ms.assetid: 9b011981-3df6-4e9e-a910-e6aa4bd2de31 -description: Contains a collection of Row elements specifying default data for lists. +description: Contains a collection of Row elements specifying default data for lists. --- # Rows element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Contains a collection of [Row](row-element-site.md) elements specifying default data for lists. - + +Contains a collection of [Row](row-element-site.md) elements specifying default data for lists. + ```XML @@ -35,41 +34,39 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [Row](row-element-site.md) - + ### Parent elements - [Data](data-element-site.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ### Remarks -The **Rows** element is used within the [Data](data-element-site.md) element of a list definition to provide a set of default data when a list is instantiated during site provisioning. - +The **Rows** element is used within the [Data](data-element-site.md) element of a list definition to provide a set of default data when a list is instantiated during site provisioning. + ## Example The following example defines one row of fields for the welcome page. - + ```XML Welcome to your new team website! - You can use this site to share information - with members of the site. To add a new announcement, click - "Add new announcement" below. This is a great way to + You can use this site to share information + with members of the site. To add a new announcement, click + "Add new announcement" below. This is a great way to communicate news with your team. ``` - - diff --git a/docs/schema/ruledesigner-element-action-elementactions-elementworkflowinfo-elementaction4.md b/docs/schema/ruledesigner-element-action-elementactions-elementworkflowinfo-elementaction4.md index d0fb975ab..f9ac56b72 100644 --- a/docs/schema/ruledesigner-element-action-elementactions-elementworkflowinfo-elementaction4.md +++ b/docs/schema/ruledesigner-element-action-elementactions-elementworkflowinfo-elementaction4.md @@ -1,15 +1,15 @@ --- title: RuleDesigner element (Action element) +description: RuleDesigner element (Action element) contains information that allows the rendering of a declarative Action sentence in the visual workflow editor. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8d94069d-51a9-4e1d-0269-5fd9d8a04114 --- -# RuleDesigner element (Action element) +# RuleDesigner element (Action element) (Actions element) (WorkflowInfo element) (Action4) @@ -56,7 +56,7 @@ Contains information that allows the rendering of a declarative **Action** sente ```XML - +     ``` ## Elements and attributes @@ -141,11 +141,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** - - - - - - - - diff --git a/docs/schema/ruledesigner-element-condition-elementconditions-elementworkflowinfo-elementacti.md b/docs/schema/ruledesigner-element-condition-elementconditions-elementworkflowinfo-elementacti.md index 601953fcb..f859263a8 100644 --- a/docs/schema/ruledesigner-element-condition-elementconditions-elementworkflowinfo-elementacti.md +++ b/docs/schema/ruledesigner-element-condition-elementconditions-elementworkflowinfo-elementacti.md @@ -1,15 +1,15 @@ --- title: RuleDesigner element (Condition element) +description: RuleDesigner element (Condition element) contains information that allows the rendering of a declarative Condition sentence in the visual workflow editor. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 0a10e602-92fe-fde5-287b-2b6b060b5bf8 --- -# RuleDesigner element (Condition element) +# RuleDesigner element (Condition element) (Conditions element) (WorkflowInfo element) (Action4) @@ -56,7 +56,7 @@ Contains information that allows the rendering of a declarative **Condition** se ```XML - +     ``` ## Elements and attributes @@ -141,11 +141,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** - - - - - - - - diff --git a/docs/schema/ruledesigner-element-default-elementconditions-elementworkflowinfo-elementaction.md b/docs/schema/ruledesigner-element-default-elementconditions-elementworkflowinfo-elementaction.md index e083ba013..30e566f50 100644 --- a/docs/schema/ruledesigner-element-default-elementconditions-elementworkflowinfo-elementaction.md +++ b/docs/schema/ruledesigner-element-default-elementconditions-elementworkflowinfo-elementaction.md @@ -1,15 +1,15 @@ --- title: RuleDesigner element (Default element) +description: RuleDesigner element (Default element) contains information that allows the rendering of a declarative sentence in the visual workflow editor. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6aaeaec0-9cbd-714b-ad6f-ef5a6afa0917 --- -# RuleDesigner element (Default element) +# RuleDesigner element (Default element) (Conditions element) (WorkflowInfo element) (Action4) @@ -56,7 +56,7 @@ Contains information that allows the rendering of a declarative sentence in the ```XML - +     ``` ## Elements and attributes @@ -141,11 +141,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** - - - - - - - - diff --git a/docs/schema/ruledesigner-element-defaultelementtype-complextypeaction4.md b/docs/schema/ruledesigner-element-defaultelementtype-complextypeaction4.md index 0e78d4d17..604b7f360 100644 --- a/docs/schema/ruledesigner-element-defaultelementtype-complextypeaction4.md +++ b/docs/schema/ruledesigner-element-defaultelementtype-complextypeaction4.md @@ -1,15 +1,15 @@ --- title: RuleDesigner element (defaultElementType complexType) +description: RuleDesigner element (defaultElementType complexType) contains information that allows the rendering of a declarative sentence in the visual workflow editor. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4321a0d0-b3b9-af35-62f5-abaef02504dd --- -# RuleDesigner element (defaultElementType complexType) +# RuleDesigner element (defaultElementType complexType) (Action4) @@ -55,7 +55,7 @@ Contains information that allows the rendering of a declarative sentence in the ```XML - + ``` ## Elements and attributes @@ -140,11 +140,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** - - - - - - - - diff --git a/docs/schema/ruledesigner-element-flow-elementflows-elementworkflowinfo-elementaction4.md b/docs/schema/ruledesigner-element-flow-elementflows-elementworkflowinfo-elementaction4.md index a94c79eb3..802ae3101 100644 --- a/docs/schema/ruledesigner-element-flow-elementflows-elementworkflowinfo-elementaction4.md +++ b/docs/schema/ruledesigner-element-flow-elementflows-elementworkflowinfo-elementaction4.md @@ -1,15 +1,15 @@ --- title: RuleDesigner element (Flow element) +description: RuleDesigner element (Flow element) contains information that allows the rendering of a declarative Flow sentence in the visual workflow editor. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2d4c5287-609c-1f45-c70b-f9ba8e0c2760 --- -# RuleDesigner element (Flow element) +# RuleDesigner element (Flow element) (Flows element) (WorkflowInfo element) (Action4) @@ -56,7 +56,7 @@ Contains information that allows the rendering of a declarative **Flow** sentenc ```XML - + ``` ## Elements and attributes @@ -141,11 +141,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** - - - - - - - - diff --git a/docs/schema/ruledesigner-element-workflowactions.md b/docs/schema/ruledesigner-element-workflowactions.md index bec7a6c14..0e9c353d7 100644 --- a/docs/schema/ruledesigner-element-workflowactions.md +++ b/docs/schema/ruledesigner-element-workflowactions.md @@ -1,13 +1,13 @@ --- title: RuleDesigner Element (WorkflowActions) +description: RuleDesigner Element (WorkflowActions) contains information that is needed to render a workflow sentence in a declarative, code-free workflow editor. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c22128ef-caba-4735-8655-f278430785e8 --- @@ -83,9 +83,3 @@ The following sections describe attributes, child elements, and parent elements. - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - diff --git a/docs/schema/ruledesigner-element-workflowinfo.md b/docs/schema/ruledesigner-element-workflowinfo.md index bb18a2510..d33c5511e 100644 --- a/docs/schema/ruledesigner-element-workflowinfo.md +++ b/docs/schema/ruledesigner-element-workflowinfo.md @@ -1,13 +1,13 @@ --- title: RuleDesigner Element (WorkflowInfo) +description: RuleDesigner Element (WorkflowInfo) contains information that is needed to render a workflow sentence in a declarative, code-free workflow editor. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: dd956283-103a-42e9-b082-58f7f3c3dbfc --- @@ -122,8 +122,3 @@ The following XML demonstrates how to construct a **RuleDesigner** element so th - [Default Workflow Conditions](default-workflow-conditions-workflowinfo.md) - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - diff --git a/docs/schema/ruledesignertype-complextype-action4.md b/docs/schema/ruledesignertype-complextype-action4.md index 4d94cc484..76f80596f 100644 --- a/docs/schema/ruledesignertype-complextype-action4.md +++ b/docs/schema/ruledesignertype-complextype-action4.md @@ -1,11 +1,11 @@ --- title: ruleDesignerType complexType (Action4) +description: ruleDesignerType complexType (Action4) is the base type for creating a RuleDesigner element (defaultElementType complexType) (Action4). manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c6dc3108-1835-12a3-0403-9679247b4ac6 --- @@ -51,10 +51,10 @@ Base type for creating a [RuleDesigner element (defaultElementType complexType) - + - + @@ -67,7 +67,7 @@ Base type for creating a [RuleDesigner element (defaultElementType complexType) - + @@ -130,11 +130,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** - - - - - - - - diff --git a/docs/schema/rulenamelsid-element-propertyrule-complextypesps15xsdsearchset2.md b/docs/schema/rulenamelsid-element-propertyrule-complextypesps15xsdsearchset2.md index e8255a493..8645bb8d8 100644 --- a/docs/schema/rulenamelsid-element-propertyrule-complextypesps15xsdsearchset2.md +++ b/docs/schema/rulenamelsid-element-propertyrule-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "RuleNameLSID element (PropertyRule complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the RuleNameLSID element (PropertyRule complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4aaeb838-497e-eb8c-434b-05f8210c6cd7 -description: "Last modified: March 09, 2015" --- # RuleNameLSID element (PropertyRule complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |q2:LocStringId
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|q2:LocStringId| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/rulepriority-element-resultitemtype-complextypesps15xsdsearchset2.md b/docs/schema/rulepriority-element-resultitemtype-complextypesps15xsdsearchset2.md index c0baba0fd..f65f3086e 100644 --- a/docs/schema/rulepriority-element-resultitemtype-complextypesps15xsdsearchset2.md +++ b/docs/schema/rulepriority-element-resultitemtype-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "RulePriority element (ResultItemType complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the RulePriority element (ResultItemType complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c52cfe51-8a6b-5c37-ef2b-c6ca13bb1566 -description: "Last modified: March 09, 2015" --- # RulePriority element (ResultItemType complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:int| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/rules-element-resultitemtype-complextypesps15xsdsearchset2.md b/docs/schema/rules-element-resultitemtype-complextypesps15xsdsearchset2.md index f38163846..69aa0eded 100644 --- a/docs/schema/rules-element-resultitemtype-complextypesps15xsdsearchset2.md +++ b/docs/schema/rules-element-resultitemtype-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Rules element (ResultItemType complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the Rules element (ResultItemType complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4a1fe8d0-8734-4c20-224a-d4f7a8f8363d -description: "Last modified: March 09, 2015" --- # Rules element (ResultItemType complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |tns:PropertyRuleCollection
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|tns:PropertyRuleCollection| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/safecontrol-element-solution.md b/docs/schema/safecontrol-element-solution.md index 2e4b6c31d..51e330d1e 100644 --- a/docs/schema/safecontrol-element-solution.md +++ b/docs/schema/safecontrol-element-solution.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Solution Schema api_type: @@ -17,9 +16,9 @@ description: Adds or removes a control assembly from the safe controls list for # SafeControl element (Solution) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Adds or removes a control assembly from the safe controls list for a solution. - + +Adds or removes a control assembly from the safe controls list for a solution. + ```XML |Optional **Boolean**. **TRUE** to add the control to the safe controls list; **FALSE** to remove it.
    | |**SafeAgainstScript**
    |Optional **Boolean**. **TRUE** to allow property editing by a Contributor; **FALSE** to disable property editing for Contributors.
    | |**TypeName**
    |Optional **Text**. The control type.
    | - + ### Child elements None - + ### Parent elements - [SafeControls](safecontrols-element-solution.md) - + ## Example For an example of how this element is used, see [Solution schema](solution-schema.md). - - diff --git a/docs/schema/safecontrols-element-solution.md b/docs/schema/safecontrols-element-solution.md index e67556a7d..2238a9188 100644 --- a/docs/schema/safecontrols-element-solution.md +++ b/docs/schema/safecontrols-element-solution.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Solution Schema api_type: @@ -17,9 +16,9 @@ description: Specifies the safe controls of an assembly that are included in a s # SafeControls element (Solution) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies the safe controls of an assembly that are included in a solution. - + ```XML |xs:boolean
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:boolean| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/samples-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/samples-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md index d558b6235..5284809fc 100644 --- a/docs/schema/samples-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/samples-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Samples element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the Samples element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8d79a44a-1c37-9daa-ec5b-19ce042bcc3c -description: "Last modified: March 09, 2015" --- # Samples element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |q12:ArrayOfstring
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|q12:ArrayOfstring| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/scale-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/scale-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index 1d6cc944c..48dbef501 100644 --- a/docs/schema/scale-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/scale-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,24 +1,24 @@ --- title: Scale element (CommandUIDefinitionType complexType) +description: Describes the definition, element, and attribute information for the Scale element (CommandUIDefinitionType complexType). manager: soliver -ms.date: 9/16/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6de35fa3-ba94-99bd-b927-9bfa70ea8ee0 --- -# Scale element (CommandUIDefinitionType complexType) +# Scale element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Information | Location | |---|---| | **Element type** | ScaleType | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | @@ -59,26 +59,18 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements None. -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/scale-element.md b/docs/schema/scale-element.md index 769edb40d..6b36ed726 100644 --- a/docs/schema/scale-element.md +++ b/docs/schema/scale-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines how a group of controls on a tab are sized. # Scale element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines how a group of controls on a tab are sized. - + ```XML |Optional. An integer that specifies the order of placement among sibling XML nodes.
    | |**Size**
    |Required. A string that corresponds to the value of the **Title** attribute of a [Layout](layout-element.md) element that defines the size.
    | |**PopupSize**
    |Optional. A string that corresponds to the value of the **Title** attribute of a [Layout](layout-element.md) element that defines the size.
    | - + ### Child elements None - + ### Parent elements - [Scaling](scaling-element.md) - + ### Occurrences - Minimum: 0 -- Maximum: unbounded - +- Maximum: unbounded + ## See also - [Server Ribbon XML](https://msdn.microsoft.com/library/5eeb45be-4af7-4a38-8ba0-3aafc62aed4b%28Office.15%29.aspx) - diff --git a/docs/schema/scaling-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/scaling-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index c42d09e7a..cb56738aa 100644 --- a/docs/schema/scaling-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/scaling-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,24 +1,24 @@ --- title: Scaling element (CommandUIDefinitionType complexType) +description: Describes the definition, element, and attribute information for the Scaling element (CommandUIDefinitionType complexType). manager: soliver -ms.date: 9/16/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 03907736-1165-d460-72d2-c90e6da1a5bd --- -# Scaling element (CommandUIDefinitionType complexType) +# Scaling element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Information | Location | |---|---| | **Element type** | ScalingType | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | @@ -59,26 +59,18 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements None. -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/scaling-element.md b/docs/schema/scaling-element.md index e8ee951e3..7bc849750 100644 --- a/docs/schema/scaling-element.md +++ b/docs/schema/scaling-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines tab scaling. # Scaling element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines tab scaling. - + ```XML |Required. A string that identifies the element, such as "Ribbon.Documents.Scaling".
    | - + ### Child elements -- [MaxSize](maxsize-element.md) -- [Scale](scale-element.md) - +- [MaxSize](maxsize-element.md) +- [Scale](scale-element.md) + ### Parent elements - [Tab](tab-element.md) - + ### Occurrences - Minimum: 1 -- Maximum: 1 - +- Maximum: 1 + ## See also - [Walkthrough: Adding a Tab to the Server Ribbon](https://msdn.microsoft.com/library/3d1fb8b6-4c9b-4801-9bba-6d2f5caee0d9%28Office.15%29.aspx) - diff --git a/docs/schema/schema-map-apphostwebfeatures.md b/docs/schema/schema-map-apphostwebfeatures.md index b85945aff..cea205bd7 100644 --- a/docs/schema/schema-map-apphostwebfeatures.md +++ b/docs/schema/schema-map-apphostwebfeatures.md @@ -1,11 +1,11 @@ --- title: Schema map (AppHostWebFeatures) +description: This topic shows the schema definition for AppHostWebFeatures. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d64d36be-8a19-6fd8-2798-0cbac949649b --- @@ -13,12 +13,12 @@ ms.assetid: d64d36be-8a19-6fd8-2798-0cbac949649b This topic shows the schema definition for **AppHostWebFeatures**. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ```XML  - + @@ -365,10 +365,3 @@ This topic shows the schema definition for **AppHostWebFeatures**. ``` - - - - - - - diff --git a/docs/schema/schema-map-apppartconfigdefinition.md b/docs/schema/schema-map-apppartconfigdefinition.md index a0b24bcb1..19e725172 100644 --- a/docs/schema/schema-map-apppartconfigdefinition.md +++ b/docs/schema/schema-map-apppartconfigdefinition.md @@ -1,11 +1,11 @@ --- title: Schema map (AppPartConfigDefinition) +description: This topic shows the schema definition for AppPartConfigDefinition. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: aea65d49-3b3f-2bf4-50e2-5967ffd753d2 --- @@ -15,7 +15,7 @@ ms.assetid: aea65d49-3b3f-2bf4-50e2-5967ffd753d2 This topic shows the schema definition for **AppPartConfigDefinition**. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ```XML  @@ -96,10 +96,3 @@ This topic shows the schema definition for **AppPartConfigDefinition**. ``` - - - - - - - diff --git a/docs/schema/schema-map-sharepoint-add-in-manifest.md b/docs/schema/schema-map-sharepoint-add-in-manifest.md index fa41f0138..121a996d7 100644 --- a/docs/schema/schema-map-sharepoint-add-in-manifest.md +++ b/docs/schema/schema-map-sharepoint-add-in-manifest.md @@ -1,11 +1,11 @@ --- title: Schema map (SharePoint Add-in Manifest) +description: This topic shows the schema definition for SharePoint Add-in Manifest. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6793ccee-0f76-f798-eeb8-c1f9309d7685 --- @@ -15,7 +15,7 @@ ms.assetid: 6793ccee-0f76-f798-eeb8-c1f9309d7685 This topic shows the schema definition for **SharePoint Add-in Manifest**. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed.
    @@ -220,10 +220,3 @@ This topic shows the schema definition for **SharePoint Add-in Manifest**.     ``` - - - - - - - diff --git a/docs/schema/schema-map-sps15xsdsearchset1.md b/docs/schema/schema-map-sps15xsdsearchset1.md index e964fb815..b90e83754 100644 --- a/docs/schema/schema-map-sps15xsdsearchset1.md +++ b/docs/schema/schema-map-sps15xsdsearchset1.md @@ -4,8 +4,7 @@ manager: arnek ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 59b3b404-6c3f-a87c-8b07-9660ec4967f5 description: Shows the schema definition for schema_Microsoft.Office.Server.Search.Administration.Query. --- @@ -48,5 +47,3 @@ This topic shows the schema definition for **schema_Microsoft.Office.Server.Sear ``` - - diff --git a/docs/schema/schema-map-sps15xsdsearchset2.md b/docs/schema/schema-map-sps15xsdsearchset2.md index ce239995f..75f84792b 100644 --- a/docs/schema/schema-map-sps15xsdsearchset2.md +++ b/docs/schema/schema-map-sps15xsdsearchset2.md @@ -4,8 +4,7 @@ manager: arnek ms.date: 11/16/2014 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a088c6ef-6e66-04d6-5fa4-232a4e513598 description: Shows the schema definition for schema_Microsoft.Office.Server.Search.Administration. --- @@ -15,7 +14,7 @@ description: Shows the schema definition for schema_Microsoft.Office.Server.Sear **Applies to:** SharePoint Server 2013 This topic shows the schema definition for **schema_Microsoft.Office.Server.Search.Administration**. - + ```XML @@ -390,5 +389,3 @@ This topic shows the schema definition for **schema_Microsoft.Office.Server.Sear ``` - - diff --git a/docs/schema/schema-map-sps15xsdsearchset3.md b/docs/schema/schema-map-sps15xsdsearchset3.md index da484b2d4..154dfe8ec 100644 --- a/docs/schema/schema-map-sps15xsdsearchset3.md +++ b/docs/schema/schema-map-sps15xsdsearchset3.md @@ -4,8 +4,7 @@ manager: arnek ms.date: 11/16/2014 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 0b1ecfc3-a648-be87-6198-148a3946ebdd description: Shows the schema definition for schema_Microsoft.Office.Server.Search.Portability. --- @@ -15,7 +14,7 @@ description: Shows the schema definition for schema_Microsoft.Office.Server.Sear **Applies to:** SharePoint Server 2013 This topic shows the schema definition for **schema_Microsoft.Office.Server.Search.Portability**. - + ```XML @@ -67,5 +66,3 @@ This topic shows the schema definition for **schema_Microsoft.Office.Server.Sear ``` - - diff --git a/docs/schema/schema-map-sps15xsdsearchset4.md b/docs/schema/schema-map-sps15xsdsearchset4.md index ae1be717c..4c033a821 100644 --- a/docs/schema/schema-map-sps15xsdsearchset4.md +++ b/docs/schema/schema-map-sps15xsdsearchset4.md @@ -4,8 +4,7 @@ manager: arnek ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a992fb73-66c2-44d4-9df8-45fcb0cc5970 description: Shows the schema definition for schema_Microsoft.Office.Server.Search.Query.Rules. --- @@ -15,7 +14,7 @@ description: Shows the schema definition for schema_Microsoft.Office.Server.Sear **Applies to:** SharePoint Server 2013 This topic shows the schema definition for **schema_Microsoft.Office.Server.Search.Query.Rules**. - + ```XML @@ -51,5 +50,3 @@ This topic shows the schema definition for **schema_Microsoft.Office.Server.Sear ``` - - diff --git a/docs/schema/schema-map-sps15xsdsearchset5.md b/docs/schema/schema-map-sps15xsdsearchset5.md index 46db908f8..eb8d99a60 100644 --- a/docs/schema/schema-map-sps15xsdsearchset5.md +++ b/docs/schema/schema-map-sps15xsdsearchset5.md @@ -4,8 +4,7 @@ manager: arnek ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 0e7abdce-c9fd-ab9a-e629-7e024994db1b description: Shows the schema definition for schema_Microsoft.Office.Server.Search.Query. --- @@ -15,7 +14,7 @@ description: Shows the schema definition for schema_Microsoft.Office.Server.Sear **Applies to:** SharePoint Server 2013 This topic shows the schema definition for **schema_Microsoft.Office.Server.Search.Query**. - + ```XML @@ -110,5 +109,3 @@ This topic shows the schema definition for **schema_Microsoft.Office.Server.Sear ``` - - diff --git a/docs/schema/schema-map-sps15xsdsearchset6.md b/docs/schema/schema-map-sps15xsdsearchset6.md index 788802e1a..2324e1c92 100644 --- a/docs/schema/schema-map-sps15xsdsearchset6.md +++ b/docs/schema/schema-map-sps15xsdsearchset6.md @@ -4,8 +4,7 @@ manager: arnek ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8969fd16-5505-5e36-07ab-c94d2b693093 description: Shows the schema definition for schema_Microsoft.Office.Server.Search. --- @@ -61,5 +60,3 @@ This topic shows the schema definition for **schema_Microsoft.Office.Server.Sear ``` - - diff --git a/docs/schema/schema-map-workflow-actions.md b/docs/schema/schema-map-workflow-actions.md index 48d1a826b..195caa3c1 100644 --- a/docs/schema/schema-map-workflow-actions.md +++ b/docs/schema/schema-map-workflow-actions.md @@ -1,11 +1,11 @@ --- title: Schema map (Workflow actions) +description: This topic shows the schema definition for Schema file name. manager: laurawi -ms.date: 11/16/2014 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d7e60875-b06d-9475-d823-08079b376ef3 --- @@ -20,10 +20,10 @@ This topic shows the schema definition for **Schema file name**. @@ -46,14 +46,14 @@ This topic shows the schema definition for **Schema file name**. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -689,7 +689,7 @@ This topic shows the schema definition for **Schema file name**. type="s:string" /> - + @@ -715,7 +715,7 @@ This topic shows the schema definition for **Schema file name**. type="s:string" /> - + - + @@ -762,11 +762,11 @@ This topic shows the schema definition for **Schema file name**. type="s:string" /> - + - + - + - + - + - + @@ -802,18 +802,18 @@ This topic shows the schema definition for **Schema file name**. - + - + - + - + - + - + -``` - - - - - - - - +``` diff --git a/docs/schema/schema-reference-for-manifests-of-sharepoint-add-ins.md b/docs/schema/schema-reference-for-manifests-of-sharepoint-add-ins.md index 72aaa7106..b503f0413 100644 --- a/docs/schema/schema-reference-for-manifests-of-sharepoint-add-ins.md +++ b/docs/schema/schema-reference-for-manifests-of-sharepoint-add-ins.md @@ -5,8 +5,7 @@ manager: soliver ms.date: 9/16/2015 ms.audience: Developer ms.topic: overview -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1f8c5d44-3b60-0bfe-9069-1df821220691 --- diff --git a/docs/schema/schema-reference-for-sharepoint.md b/docs/schema/schema-reference-for-sharepoint.md index 13545ad9b..9c06273cb 100644 --- a/docs/schema/schema-reference-for-sharepoint.md +++ b/docs/schema/schema-reference-for-sharepoint.md @@ -1,11 +1,11 @@ --- title: Schema reference for SharePoint +description: This section collects all SharePoint schemas into eight sections. manager: soliver -ms.date: 9/14/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: overview -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: e9c97a17-51ad-43ba-a94a-5078bcb83c74 --- @@ -34,9 +34,4 @@ This section collects all SharePoint schemas into eight sections, providing easy ## See also -- [SharePoint glossary](../general-development/sharepoint-glossary.md) - - - - - +- [SharePoint glossary](../general-development/sharepoint-glossary.md) diff --git a/docs/schema/schemaid-element-aliasinfo-complextypesps15xsdsearchset2.md b/docs/schema/schemaid-element-aliasinfo-complextypesps15xsdsearchset2.md index b54b39cda..dbd1e23c4 100644 --- a/docs/schema/schemaid-element-aliasinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/schemaid-element-aliasinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SchemaID element (AliasInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the SchemaID element (AliasInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 321f714b-600b-9936-8d6c-bc3c618912ee -description: "Last modified: March 09, 2015" --- # SchemaID element (AliasInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:int| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/schemaid-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/schemaid-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md index 1659745a3..d4c343ae4 100644 --- a/docs/schema/schemaid-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/schemaid-element-crawledpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SchemaID element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the SchemaID element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: e422e306-b36a-00f5-1424-8e3b9452ec93 -description: "Last modified: March 09, 2015" --- # SchemaID element (CrawledPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:int| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/schemaid-element-mappinginfo-complextypesps15xsdsearchset2.md b/docs/schema/schemaid-element-mappinginfo-complextypesps15xsdsearchset2.md index 94a140ca1..9ba0d5360 100644 --- a/docs/schema/schemaid-element-mappinginfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/schemaid-element-mappinginfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SchemaID element (MappingInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the SchemaID element (MappingInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: e8470c77-8fb1-67bd-7e21-7f1d64a13e93 -description: "Last modified: March 09, 2015" --- # SchemaID element (MappingInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:int| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/schemaid-element-overrideinfo-complextypesps15xsdsearchset2.md b/docs/schema/schemaid-element-overrideinfo-complextypesps15xsdsearchset2.md index af697ba43..8fb47eecf 100644 --- a/docs/schema/schemaid-element-overrideinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/schemaid-element-overrideinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SchemaID element (OverrideInfo complexType) (SPS15XSDSearchSet2)" +description: "Describes the definition, element, and attribute information for the SchemaID element (OverrideInfo complexType) (SPS15XSDSearchSet2)." manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 0b40f067-c7f5-626e-4673-5c55d776942a -description: "Last modified: March 09, 2015" --- # SchemaID element (OverrideInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +| Information | Location | |:-----|:-----| -|**Element type**
    |xs:int
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type**|xs:int| +|**Namespace**|http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration| +|**Schema file**|schema_Microsoft.Office.Server.Search.Administration.xsd| + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/schemasecurity-element.md b/docs/schema/schemasecurity-element.md index 1c7246b72..eddc7db7e 100644 --- a/docs/schema/schemasecurity-element.md +++ b/docs/schema/schemasecurity-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 879efff7-9ac3-4653-b9e8-cf5b4e31e2b2 description: Contains the Schema security setting for a list. --- @@ -13,9 +12,9 @@ description: Contains the Schema security setting for a list. # SchemaSecurity element **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Contains the Schema security setting for a list. - + ```XML @@ -28,32 +27,31 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [Security](security-element.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ### Remarks -The **SchemaSecurity** element can contain the following values: - +The **SchemaSecurity** element can contain the following values: + - **1** — Anyone can modify the schema (add and delete columns, etc.). - + - **2** — Only the list owner can modify the schema. For an example that shows how to use the **SchemaSecurity** element, see [Security element](security-element.md). - + ## See also -- [ReadSecurity element](readsecurity-element.md) +- [ReadSecurity element](readsecurity-element.md) - [WriteSecurity element](writesecurity-element.md) - diff --git a/docs/schema/schemasource-element-datasourcetype-complextypeaction4.md b/docs/schema/schemasource-element-datasourcetype-complextypeaction4.md index 16d9085c5..248640693 100644 --- a/docs/schema/schemasource-element-datasourcetype-complextypeaction4.md +++ b/docs/schema/schemasource-element-datasourcetype-complextypeaction4.md @@ -1,15 +1,15 @@ --- title: SchemaSource element +description: SchemaSource element specifies how data source fields are displayed. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: aeeb657e-126d-7783-bf73-93b98c52b60b --- -# SchemaSource element +# SchemaSource element (dataSourceType complexType) (Action4) @@ -64,21 +64,21 @@ Specifies how data source fields are displayed. - + - + - + - + - + - + ``` ## Elements and attributes @@ -151,11 +151,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** ### Attributes None. - - - - - - - - diff --git a/docs/schema/schemasource-element-workflowactions.md b/docs/schema/schemasource-element-workflowactions.md index 9c5f822e7..152134d07 100644 --- a/docs/schema/schemasource-element-workflowactions.md +++ b/docs/schema/schemasource-element-workflowactions.md @@ -1,13 +1,13 @@ --- title: SchemaSource Element (WorkflowActions) +description: SchemaSource Element (WorkflowActions) specifies how data source fields are displayed. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5d79e03c-e556-4fbe-a830-c50fc9515da7 --- @@ -74,10 +74,3 @@ None - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - - diff --git a/docs/schema/schemasource-element-workflowinfo.md b/docs/schema/schemasource-element-workflowinfo.md index ab66af0ed..93f9e2bc6 100644 --- a/docs/schema/schemasource-element-workflowinfo.md +++ b/docs/schema/schemasource-element-workflowinfo.md @@ -1,13 +1,13 @@ --- title: SchemaSource Element (WorkflowInfo) +description: SchemaSource Element (WorkflowInfo) specifies how data source fields are displayed. manager: laurawi -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference f1_keywords: - SharePoint workflows -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1f005c23-44a7-4c64-abf0-40caf813d977 --- @@ -77,11 +77,3 @@ None - [Default Workflow Conditions](default-workflow-conditions-workflowinfo.md) - [Creating Declarative, No-Code Workflow Editors](https://msdn.microsoft.com/library/office/bb417436.aspx) - [Workflow Actions Schema Overview](https://msdn.microsoft.com/library/office/bb897626.aspx) - - - - - - - - diff --git a/docs/schema/schemaversion-element-deploymentsystemdata.md b/docs/schema/schemaversion-element-deploymentsystemdata.md index 4d0a2e435..8945a8fc5 100644 --- a/docs/schema/schemaversion-element-deploymentsystemdata.md +++ b/docs/schema/schemaversion-element-deploymentsystemdata.md @@ -1,29 +1,28 @@ --- title: "SchemaVersion Element (DeploymentSystemData)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 354c96b8-115a-4960-bfb6-46d3a40f1c61 -description: "Last modified: March 09, 2015" +description: Represents an object (SPSchemaVersion) that lists versioning data for the content migration manifest schema. --- # SchemaVersion Element (DeploymentSystemData) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents an object (**SPSchemaVersion**) that lists versioning data for the content migration manifest schema. ## Definition ```XML DECLARATION - USAGE @@ -40,7 +39,7 @@ USAGE ## Type **SPSchemaVersion** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -53,16 +52,15 @@ The following sections describe attributes, child elements, and parent elements. |**Build**
    |xs:string
    |Build number.
    | |**DatabaseVersion**
    |xs:string
    |Version of the database exporting content.
    | |**SiteVersion**
    |xs:string
    |Verison of the parent website.
    | - + ### Child elements None - + ### Parent elements [SystemData Element (DeploymentSystemData)](systemdata-element-deploymentsystemdata.md) - + ## See also - [DeploymentSystemData Schema](deploymentsystemdata-schema.md) - diff --git a/docs/schema/script-element-deploymentmanifestspview.md b/docs/schema/script-element-deploymentmanifestspview.md index c4a9515c6..916f01240 100644 --- a/docs/schema/script-element-deploymentmanifestspview.md +++ b/docs/schema/script-element-deploymentmanifestspview.md @@ -1,20 +1,19 @@ --- title: "Script element (DeploymentManifest - SPView)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f20d0d2f-c7aa-415a-8f89-79df17ae0840 -description: "Last modified: March 09, 2015" +description: Script element (DeploymentManifest - SPView) represents script to execute on deployment of an instance of a Windows SharePoint Services 3.0 view object. --- # Script element (DeploymentManifest - SPView) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents script to execute on deployment of an instance of a Windows SharePoint Services 3.0 view ([SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents script to execute on deployment of an instance of a Windows SharePoint Services 3.0 view ([SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx)) object. ## Definition @@ -31,8 +30,8 @@ USAGE ## Type -xs:string - +xs:string + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -40,17 +39,16 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [View element (DeploymentManifest)](view-element-deploymentmanifest.md) - + ## See also - [SPView](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPView.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/script-element-deploymentmanifestspwebpart.md b/docs/schema/script-element-deploymentmanifestspwebpart.md index 753daa133..0d0d49cca 100644 --- a/docs/schema/script-element-deploymentmanifestspwebpart.md +++ b/docs/schema/script-element-deploymentmanifestspwebpart.md @@ -1,20 +1,19 @@ --- title: "Script element (DeploymentManifest - SPWebPart)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 15350a26-d4bd-444e-a707-b2fc5cb3fcf7 -description: "Last modified: March 09, 2015" +description: Script element (DeploymentManifest - SPWebPart) represents script to execute on deployment of an instance of a web part object. --- # Script element (DeploymentManifest - SPWebPart) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents script to execute on deployment of an instance of a web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents script to execute on deployment of an instance of a web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)) object. ## Definition @@ -31,8 +30,8 @@ USAGE ## Type -xs:string - +xs:string + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -40,21 +39,20 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [WebPart element (DeploymentManifest)](webpart-element-deploymentmanifest.md) - + ### Remarks -Web parts can derive from either of two base classes - an ASP.NET web part ([WebPart](https://msdn.microsoft.com/library/System.Web.UI.WebControls.WebParts.WebPart.aspx)), or a SharePoint Foundation web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)). - +Web parts can derive from either of two base classes - an ASP.NET web part ([WebPart](https://msdn.microsoft.com/library/System.Web.UI.WebControls.WebParts.WebPart.aspx)), or a SharePoint Foundation web part ([WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx)). + ## See also - [WebPart](https://msdn.microsoft.com/library/Microsoft.SharePoint.WebPartPages.WebPart.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/script-element.md b/docs/schema/script-element.md index 0dfdcd31c..32e9e16de 100644 --- a/docs/schema/script-element.md +++ b/docs/schema/script-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9bd3c468-7211-4a3f-a304-2228f2997854 description: Contains a script fragment. --- @@ -13,9 +12,9 @@ description: Contains a script fragment. # Script element **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Contains a script fragment. - + ```XML @@ -28,24 +27,24 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -None - +None + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ## Example -The following example uses the **Script** element to contain a script fragment that executes within a view of a list. - +The following example uses the **Script** element to contain a script fragment that executes within a view of a list. + ```XML @@ -60,5 +59,3 @@ The following example uses the **Script** element to contain a script fragment t g_RequiredFields[6]["RequiredField"] = true; ``` - - diff --git a/docs/schema/scriptquote-element-view.md b/docs/schema/scriptquote-element-view.md index 19482bc7d..17460f52a 100644 --- a/docs/schema/scriptquote-element-view.md +++ b/docs/schema/scriptquote-element-view.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: @@ -17,9 +16,9 @@ description: Encodes a string to fit within JavaScript code. This element is use # ScriptQuote element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Encodes a string to fit within JavaScript code. This element is used to render text from the server that must be interpreted as a quoted string. - + ```XML @@ -35,30 +34,28 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Description**| |:-----|:-----| |**NotAddingQuote**
    |Optional **Boolean**. **TRUE** to eliminate quotation marks for enclosing a string. The default value is **FALSE**.
    | - + ### Child elements -None - +None + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ### Remarks -The **ScriptQuote** element performs the following conversions on its body text: - -- Converts `"` to `\"` -- Converts `\` to `\\` +The **ScriptQuote** element performs the following conversions on its body text: + +- Converts `"` to `\"` +- Converts `\` to `\\` - Converts `CR` to `\r\CR` (where CR is character code 13) - -For example, the code `This is a test` returns "This is a test" because **NotAddingQuote** is not set to **TRUE**. -However, the code `This is a test` returns This is a test, without quotation marks, because **NotAddingQuote** is set to **TRUE**. Note that in the second case, the string is not surrounded by quotation marks. - +For example, the code `This is a test` returns "This is a test" because **NotAddingQuote** is not set to **TRUE**. +However, the code `This is a test` returns This is a test, without quotation marks, because **NotAddingQuote** is set to **TRUE**. Note that in the second case, the string is not surrounded by quotation marks. diff --git a/docs/schema/searchable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/searchable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md index e3e8601e4..7bc552848 100644 --- a/docs/schema/searchable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/searchable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Searchable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c165fcd5-0b6e-bbae-799f-00305aaa7472 -description: "Last modified: March 09, 2015" +description: Learn more about Searchable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2). --- # Searchable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |xs:boolean
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |xs:boolean | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd s | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/searchconfigurationsettings-complextype-sps15xsdsearchset3.md b/docs/schema/searchconfigurationsettings-complextype-sps15xsdsearchset3.md index c8dbb2a31..5f2c6837c 100644 --- a/docs/schema/searchconfigurationsettings-complextype-sps15xsdsearchset3.md +++ b/docs/schema/searchconfigurationsettings-complextype-sps15xsdsearchset3.md @@ -1,27 +1,26 @@ --- title: "SearchConfigurationSettings complexType (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7d59b1f0-7b6a-e9fe-ba69-b4d3cc55469b -description: "Last modified: March 09, 2015" +description: Learn about SearchConfigurationSettings complexType (SPS15XSDSearchSet3). --- # SearchConfigurationSettings complexType (SPS15XSDSearchSet3) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | -|**Extension base**
    |None
    | - +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | +|**Extension base** |None | + ## Definition ```XML @@ -37,8 +36,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -46,9 +45,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[SearchQueryConfigurationSettings](searchqueryconfigurationsettings-element-searchconfigurationsettings-complextype.md)
    |tns:ArrayOfSearchQueryConfigurationSettings
    || |[SearchRankingModelConfigurationSettings](searchrankingmodelconfigurationsettings-element-searchconfigurationsettings-comp.md)
    |tns:SearchRankingModelConfigurationSettings
    || |[SearchSchemaConfigurationSettings](searchschemaconfigurationsettings-element-searchconfigurationsettings-complextyp.md)
    |tns:SearchSchemaConfigurationSettings
    || - + ### Attributes None. - - diff --git a/docs/schema/searchconfigurationsettings-element-sps15xsdsearchset3.md b/docs/schema/searchconfigurationsettings-element-sps15xsdsearchset3.md index 6ae8957de..31aee0be4 100644 --- a/docs/schema/searchconfigurationsettings-element-sps15xsdsearchset3.md +++ b/docs/schema/searchconfigurationsettings-element-sps15xsdsearchset3.md @@ -1,27 +1,26 @@ --- title: "SearchConfigurationSettings element (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 518ad808-ccb6-4eef-0360-97810e94d5ed -description: "Last modified: March 09, 2015" +description: Learn more about SearchConfigurationSettings element (SPS15XSDSearchSet3). --- # SearchConfigurationSettings element (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SearchConfigurationSettings
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type** |tns:SearchConfigurationSettings | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/searchobjectowner-complextype-sps15xsdsearchset2.md b/docs/schema/searchobjectowner-complextype-sps15xsdsearchset2.md index 1d034f59d..65b5d32d4 100644 --- a/docs/schema/searchobjectowner-complextype-sps15xsdsearchset2.md +++ b/docs/schema/searchobjectowner-complextype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SearchObjectOwner complexType (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a071bfbc-d23d-d37f-b2b3-92878bbe11ec -description: "Last modified: March 09, 2015" +description: Learn more about SearchObjectOwner complexType (SPS15XSDSearchSet2). --- # SearchObjectOwner complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |None
    | - +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | +|**Extension base** |None | + ## Definition ```XML @@ -40,8 +39,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -52,9 +51,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[SPSiteId](spsiteid-element-searchobjectowner-complextypesps15xsdsearchset2.md)
    |ser:guid
    || |[SPSiteSubscriptionId](spsitesubscriptionid-element-searchobjectowner-complextypesps15xsdsearchset2.md)
    |ser:guid
    || |[SPWebId](spwebid-element-searchobjectowner-complextypesps15xsdsearchset2.md)
    |ser:guid
    || - + ### Attributes None. - - diff --git a/docs/schema/searchobjectowner-element-sps15xsdsearchset2.md b/docs/schema/searchobjectowner-element-sps15xsdsearchset2.md index 02a3d1c6d..90e9b0074 100644 --- a/docs/schema/searchobjectowner-element-sps15xsdsearchset2.md +++ b/docs/schema/searchobjectowner-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SearchObjectOwner element (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1e5e536f-2ac7-4d96-6025-f76659244d35 -description: "Last modified: March 09, 2015" +description: Learn more about SearchObjectOwner element (SPS15XSDSearchSet2). --- # SearchObjectOwner element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SearchObjectOwner
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |tns:SearchObjectOwner | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/searchprovider-element-sps15xsdsearchset5.md b/docs/schema/searchprovider-element-sps15xsdsearchset5.md index 3a43b4757..6970cc16d 100644 --- a/docs/schema/searchprovider-element-sps15xsdsearchset5.md +++ b/docs/schema/searchprovider-element-sps15xsdsearchset5.md @@ -1,27 +1,26 @@ --- title: "SearchProvider element (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1bb702da-4abb-8e78-a187-068b0e32b8c5 -description: "Last modified: March 09, 2015" +description: Learn more about SearchProvider element (SPS15XSDSearchSet5). --- # SearchProvider element (SPS15XSDSearchSet5) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SearchProvider
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Element type** |tns:SearchProvider | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query | +|**Schema file** |schema_Microsoft.Office.Server.Search.Query.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/searchprovider-simpletype-sps15xsdsearchset5.md b/docs/schema/searchprovider-simpletype-sps15xsdsearchset5.md index 62741820a..529adc1de 100644 --- a/docs/schema/searchprovider-simpletype-sps15xsdsearchset5.md +++ b/docs/schema/searchprovider-simpletype-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "SearchProvider simpleType (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9394f987-331f-6817-560e-6cb6118dd564 -description: "Last modified: March 09, 2015" +description: Learn more about SearchProvider simpleType (SPS15XSDSearchSet5). --- # SearchProvider simpleType (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Base type**
    |xs:string
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Base type** |xs:string | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query | +|**Schema file** |schema_Microsoft.Office.Server.Search.Query.xsd | + ## Definition ```XML @@ -44,5 +43,3 @@ description: "Last modified: March 09, 2015" |Default
    || |SharepointSearch
    || |FASTSearch
    || - - diff --git a/docs/schema/searchqueryconfigurationsettings-complextype-sps15xsdsearchset3.md b/docs/schema/searchqueryconfigurationsettings-complextype-sps15xsdsearchset3.md index d113e27ae..e4b28d1af 100644 --- a/docs/schema/searchqueryconfigurationsettings-complextype-sps15xsdsearchset3.md +++ b/docs/schema/searchqueryconfigurationsettings-complextype-sps15xsdsearchset3.md @@ -1,27 +1,26 @@ --- title: "SearchQueryConfigurationSettings complexType (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 66da239e-98dd-a812-4041-ffc248561236 -description: "Last modified: March 09, 2015" +description: Learn more about SearchQueryConfigurationSettings complexType (SPS15XSDSearchSet3). --- # SearchQueryConfigurationSettings complexType (SPS15XSDSearchSet3) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | -|**Extension base**
    |None
    | - +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | +|**Extension base** |None | + ## Definition ```XML @@ -44,8 +43,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -60,9 +59,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[ResultTypes](resulttypes-element-searchqueryconfigurationsettings-complextypesps15xsdsearchse.md)
    |q4:ArrayOfResultItemType
    || |[Sources](sources-element-searchqueryconfigurationsettings-complextypesps15xsdsearchset3.md)
    |q5:ArrayOfSource
    || |[UserSegments](usersegments-element-searchqueryconfigurationsettings-complextypesps15xsdsearchs.md)
    |q6:ArrayOfUserSegment
    || - + ### Attributes None. - - diff --git a/docs/schema/searchqueryconfigurationsettings-element-arrayofsearchqueryconfigurationsettings.md b/docs/schema/searchqueryconfigurationsettings-element-arrayofsearchqueryconfigurationsettings.md index 0fc6cbec6..a681e00c0 100644 --- a/docs/schema/searchqueryconfigurationsettings-element-arrayofsearchqueryconfigurationsettings.md +++ b/docs/schema/searchqueryconfigurationsettings-element-arrayofsearchqueryconfigurationsettings.md @@ -1,27 +1,26 @@ --- title: "SearchQueryConfigurationSettings element (ArrayOfSearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 425da2d0-7bcd-5308-27a4-ca4a88955d00 -description: "Last modified: March 09, 2015" +description: Learn about SearchQueryConfigurationSettings element (ArrayOfSearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3). --- # SearchQueryConfigurationSettings element (ArrayOfSearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SearchQueryConfigurationSettings
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type** |tns:SearchQueryConfigurationSettings | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/searchqueryconfigurationsettings-element-searchconfigurationsettings-complextype.md b/docs/schema/searchqueryconfigurationsettings-element-searchconfigurationsettings-complextype.md index b0939722a..2b0506a82 100644 --- a/docs/schema/searchqueryconfigurationsettings-element-searchconfigurationsettings-complextype.md +++ b/docs/schema/searchqueryconfigurationsettings-element-searchconfigurationsettings-complextype.md @@ -1,27 +1,26 @@ --- title: "SearchQueryConfigurationSettings element (SearchConfigurationSettings complexType) (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f495b15a-3dba-beab-b691-0bf17e68f443 -description: "Last modified: March 09, 2015" +description: Learn about SearchQueryConfigurationSettings element (SearchConfigurationSettings complexType) (SPS15XSDSearchSet3). --- # SearchQueryConfigurationSettings element (SearchConfigurationSettings complexType) (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:ArrayOfSearchQueryConfigurationSettings
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type** |tns:ArrayOfSearchQueryConfigurationSettings | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/searchqueryconfigurationsettings-element-sps15xsdsearchset3.md b/docs/schema/searchqueryconfigurationsettings-element-sps15xsdsearchset3.md index db3b942bc..eac9c4567 100644 --- a/docs/schema/searchqueryconfigurationsettings-element-sps15xsdsearchset3.md +++ b/docs/schema/searchqueryconfigurationsettings-element-sps15xsdsearchset3.md @@ -1,27 +1,26 @@ --- title: "SearchQueryConfigurationSettings element (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 0d43d57f-356e-02eb-bf23-92a8bcdbd4ed -description: "Last modified: March 09, 2015" +description: Learn more about SearchQueryConfigurationSettings element (SPS15XSDSearchSet3). --- # SearchQueryConfigurationSettings element (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SearchQueryConfigurationSettings
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type**|tns:SearchQueryConfigurationSettings | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/searchrankingmodelconfigurationsettings-complextype-sps15xsdsearchset3.md b/docs/schema/searchrankingmodelconfigurationsettings-complextype-sps15xsdsearchset3.md index 7f603224c..31d15da03 100644 --- a/docs/schema/searchrankingmodelconfigurationsettings-complextype-sps15xsdsearchset3.md +++ b/docs/schema/searchrankingmodelconfigurationsettings-complextype-sps15xsdsearchset3.md @@ -1,27 +1,26 @@ --- title: "SearchRankingModelConfigurationSettings complexType (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2630cc13-d07c-dfc9-d848-4872715a9f09 -description: "Last modified: March 09, 2015" +description: Learn about SearchRankingModelConfigurationSettings complexType (SPS15XSDSearchSet3). --- # SearchRankingModelConfigurationSettings complexType (SPS15XSDSearchSet3) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | -|**Extension base**
    |None
    | - +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | +|**Extension base** |None | + ## Definition ```XML @@ -35,16 +34,14 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| |:-----|:-----|:-----| |[RankingModels](rankingmodels-element-searchrankingmodelconfigurationsettings-complextypesps15xs.md)
    |q7:ArrayOfstring
    || - + ### Attributes None. - - diff --git a/docs/schema/searchrankingmodelconfigurationsettings-element-searchconfigurationsettings-comp.md b/docs/schema/searchrankingmodelconfigurationsettings-element-searchconfigurationsettings-comp.md index f77e39a1b..28af74782 100644 --- a/docs/schema/searchrankingmodelconfigurationsettings-element-searchconfigurationsettings-comp.md +++ b/docs/schema/searchrankingmodelconfigurationsettings-element-searchconfigurationsettings-comp.md @@ -1,27 +1,26 @@ --- title: "SearchRankingModelConfigurationSettings element (SearchConfigurationSettings complexType) (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a638a73f-5d50-67cb-47f7-292697538b3a -description: "Last modified: March 09, 2015" +description: Learn about SearchRankingModelConfigurationSettings element (SearchConfigurationSettings complexType) (SPS15XSDSearchSet3). --- # SearchRankingModelConfigurationSettings element (SearchConfigurationSettings complexType) (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SearchRankingModelConfigurationSettings
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type** |tns:SearchRankingModelConfigurationSettings | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/searchrankingmodelconfigurationsettings-element-sps15xsdsearchset3.md b/docs/schema/searchrankingmodelconfigurationsettings-element-sps15xsdsearchset3.md index cef00a060..19e35f241 100644 --- a/docs/schema/searchrankingmodelconfigurationsettings-element-sps15xsdsearchset3.md +++ b/docs/schema/searchrankingmodelconfigurationsettings-element-sps15xsdsearchset3.md @@ -1,27 +1,26 @@ --- title: "SearchRankingModelConfigurationSettings element (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 910293a7-8d77-d41e-4e38-d7da74a081eb -description: "Last modified: March 09, 2015" +description: Learn about SearchRankingModelConfigurationSettings element (SPS15XSDSearchSet3). --- # SearchRankingModelConfigurationSettings element (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SearchRankingModelConfigurationSettings
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type**|tns:SearchRankingModelConfigurationSettings | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/searchschemaconfigurationsettings-complextype-sps15xsdsearchset3.md b/docs/schema/searchschemaconfigurationsettings-complextype-sps15xsdsearchset3.md index 3a8fb6316..62e196da1 100644 --- a/docs/schema/searchschemaconfigurationsettings-complextype-sps15xsdsearchset3.md +++ b/docs/schema/searchschemaconfigurationsettings-complextype-sps15xsdsearchset3.md @@ -1,27 +1,26 @@ --- title: "SearchSchemaConfigurationSettings complexType (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: fc48b8f7-68e5-ff8c-dc0b-9a584248a54b -description: "Last modified: March 09, 2015" +description: Learn about SearchSchemaConfigurationSettings complexType (SPS15XSDSearchSet3). --- # SearchSchemaConfigurationSettings complexType (SPS15XSDSearchSet3) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | -|**Extension base**
    |None
    | - +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | +|**Extension base** |None | + ## Definition ```XML @@ -40,8 +39,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -52,9 +51,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[ManagedProperties](managedproperties-element-searchschemaconfigurationsettings-complextypesps15xsds.md)
    |q11:ManagedPropertyInfoCollection
    || |[Mappings](mappings-element-searchschemaconfigurationsettings-complextypesps15xsdsearchset3.md)
    |q12:MappingInfoCollection
    || |[Overrides](overrides-element-searchschemaconfigurationsettings-complextypesps15xsdsearchset.md)
    |q13:OverrideInfoCollection
    || - + ### Attributes None. - - diff --git a/docs/schema/searchschemaconfigurationsettings-element-searchconfigurationsettings-complextyp.md b/docs/schema/searchschemaconfigurationsettings-element-searchconfigurationsettings-complextyp.md index bef4a40b2..cd4f4748c 100644 --- a/docs/schema/searchschemaconfigurationsettings-element-searchconfigurationsettings-complextyp.md +++ b/docs/schema/searchschemaconfigurationsettings-element-searchconfigurationsettings-complextyp.md @@ -1,27 +1,26 @@ --- title: "SearchSchemaConfigurationSettings element (SearchConfigurationSettings complexType) (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 942af75f-17f6-5bf1-1dc8-31b45a1b9378 -description: "Last modified: March 09, 2015" +description: Learn about SearchSchemaConfigurationSettings element (SearchConfigurationSettings complexType) (SPS15XSDSearchSet3). --- # SearchSchemaConfigurationSettings element (SearchConfigurationSettings complexType) (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SearchSchemaConfigurationSettings
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type** |tns:SearchSchemaConfigurationSettings | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/searchschemaconfigurationsettings-element-sps15xsdsearchset3.md b/docs/schema/searchschemaconfigurationsettings-element-sps15xsdsearchset3.md index f46304e8a..aed1a82e6 100644 --- a/docs/schema/searchschemaconfigurationsettings-element-sps15xsdsearchset3.md +++ b/docs/schema/searchschemaconfigurationsettings-element-sps15xsdsearchset3.md @@ -1,27 +1,26 @@ --- title: "SearchSchemaConfigurationSettings element (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6fda26fa-e925-3cff-00d4-b17f919165bd -description: "Last modified: March 09, 2015" +description: Learn about SearchSchemaConfigurationSettings element (SPS15XSDSearchSet3). --- # SearchSchemaConfigurationSettings element (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SearchSchemaConfigurationSettings
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - +|**Element type** |tns:SearchSchemaConfigurationSettings| +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability | +|**Schema file** |schema_Microsoft.Office.Server.Search.Portability.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/section-element.md b/docs/schema/section-element.md index b73fa62ff..4ade3e2c7 100644 --- a/docs/schema/section-element.md +++ b/docs/schema/section-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines a section of a layout. # Section element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a section of a layout. - + ```XML
    | Optional. An enumeration value that specifies the type of section.

    **Divider**. The section cannot contain child [Row](row-element.md) elements.
    **OneRow**. The section can contain one child **Row** element.
    **TwoRow**. The section can contain two child **Row** elements.
    **ThreeRow**. The section can contain three child **Row** elements.
    | |**Alignment**
    | Optional. An enumeration value that specifies the vertical alignment of controls within the section.

    **Top**. Control icons are aligned to the top edge of their row.
    **Middle**. Control icons are aligned in the middle of their row.

    The default alignment is **Top**.
    | - + ### Child elements - [Row](row-element.md) - + ### Parent elements - [Layout](layout-element.md) - + ### Occurrences - Minimum: 0 -- Maximum: unbounded - +- Maximum: unbounded + ## Example The following example defines a layout with two sections of different types. - + ```XML
    @@ -79,5 +78,3 @@ The following example defines a layout with two sections of different types.
    ``` - - diff --git a/docs/schema/securableauthdata-complextype-sps15xsdsearchset2.md b/docs/schema/securableauthdata-complextype-sps15xsdsearchset2.md index 89bca0567..4fb7176be 100644 --- a/docs/schema/securableauthdata-complextype-sps15xsdsearchset2.md +++ b/docs/schema/securableauthdata-complextype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SecurableAuthData complexType (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1bfe838d-25de-6977-64d2-75c3b7dffd08 -description: "Last modified: March 09, 2015" +description: Learn more about SecurableAuthData complexType (SPS15XSDSearchSet2). --- # SecurableAuthData complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | -|**Extension base**
    |tns:AuthenticationData
    | - +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | +|**Extension base** |tns:AuthenticationData | + ## Definition ```XML @@ -41,8 +40,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -50,9 +49,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[_NameValuePairs](_namevaluepairs-element-securableauthdata-complextypesps15xsdsearchset2.md)
    |q7:ArrayOfKeyValueOfstringstring
    || |[_SecurableNameValuePairs](_securablenamevaluepairs-element-securableauthdata-complextypesps15xsdsearchset2.md)
    |q8:ArrayOfKeyValueOfstringSecureStringX9wx7DhE
    || |[SerializableSecurableNameValuePairs](serializablesecurablenamevaluepairs-element-securableauthdata-complextypesps15xs.md)
    |q9:ArrayOfKeyValueOfstringstring
    || - + ### Attributes None. - - diff --git a/docs/schema/securableauthdata-element-sps15xsdsearchset2.md b/docs/schema/securableauthdata-element-sps15xsdsearchset2.md index 8239add2b..b218a4d27 100644 --- a/docs/schema/securableauthdata-element-sps15xsdsearchset2.md +++ b/docs/schema/securableauthdata-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SecurableAuthData element (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 181a7af8-be39-4eea-30bd-4b2192e8395a -description: "Last modified: March 09, 2015" +description: Learn more about SecurableAuthData element (SPS15XSDSearchSet2). --- # SecurableAuthData element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SecurableAuthData
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |tns:SecurableAuthData | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/security-element.md b/docs/schema/security-element.md index 3b76133df..869161634 100644 --- a/docs/schema/security-element.md +++ b/docs/schema/security-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 20e21cab-8353-449a-a5a9-da18e16c1a0c description: Contains the Read, Schema, and Write security settings that specify how the security for a list is configured. --- @@ -13,9 +12,9 @@ description: Contains the Read, Schema, and Write security settings that specify # Security element **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Contains the Read, Schema, and Write security settings that specify how the security for a list is configured. - + ```XML 1 | 2 @@ -31,36 +30,36 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [ReadSecurity](readsecurity-element.md) - [SchemaSecurity](schemasecurity-element.md) - [WriteSecurity](writesecurity-element.md) - + ### Parent elements - [List](list-element-list.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ### Remarks -The following table summarizes possible values that subelements of the **Security** element can contain. - +The following table summarizes possible values that subelements of the **Security** element can contain. + |**Value**|**ReadSecurity**|**SchemaSecurity**|**WriteSecurity**| |:-----|:-----|:-----|:-----| |**1**
    |Read all items.
    |Anyone can modify the schema (add and delete columns, etc.).
    |Write all items.
    | |**2**
    |Read only my items.
    |Only the list owner can modify the schema.
    |Write only my items.
    | |**4**
    |N/A
    |N/A
    |Write no items (read-only list).
    | - + ## Example -The following example outlines how to use the **Security** element. - +The following example outlines how to use the **Security** element. + ```XML ... @@ -72,5 +71,3 @@ The following example outlines how to use the **Security** element. ... ``` - - diff --git a/docs/schema/securitymodificationtype-simple-type-deploymentmanifest.md b/docs/schema/securitymodificationtype-simple-type-deploymentmanifest.md index e2be73c95..35d11a45e 100644 --- a/docs/schema/securitymodificationtype-simple-type-deploymentmanifest.md +++ b/docs/schema/securitymodificationtype-simple-type-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "SecurityModificationType Simple Type (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/15/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6ecf42b2-0c38-4ecf-b819-fa931965ab49 -description: "Last modified: March 09, 2015" +description: SecurityModificationType Simple Type (DeploymentManifest) specifies the allowable security modifications for a specified user, user group, role, or role assignment. --- # SecurityModificationType Simple Type (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Specifies the allowable security modifications for a specified user, user group, role, or role assignment. ## Definition @@ -50,9 +49,8 @@ Specifies the allowable security modifications for a specified user, user group, |**RoleUpdate**
    |Updates a SharePoint role.
    | |**RoleAssignmentAdd**
    |Adds an assignment to a SharePoint role.
    | |**RoleAssignmentDelete**
    |Deletes an assignment from a SharePoint role.
    | - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - [GroupX Element (DeploymentManifest)](groupx-element-deploymentmanifest.md) - diff --git a/docs/schema/selected-type-definitions.md b/docs/schema/selected-type-definitions.md index db981df38..e92946e72 100644 --- a/docs/schema/selected-type-definitions.md +++ b/docs/schema/selected-type-definitions.md @@ -1,11 +1,11 @@ --- title: Selected Type Definitions +description: Learn more about Selected Type Definitions. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 69ed315f-2fe5-4a7e-8cdd-2d0c3703fd68 --- @@ -87,11 +87,3 @@ Following is a table that lists the selected simple types. ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - - - - - - - - diff --git a/docs/schema/selectionoptions-element-view.md b/docs/schema/selectionoptions-element-view.md index 3781e58ef..f2bddba5e 100644 --- a/docs/schema/selectionoptions-element-view.md +++ b/docs/schema/selectionoptions-element-view.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: @@ -17,9 +16,9 @@ description: Specifies options for a drop-down list. # SelectionOptions element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies options for a drop-down list. - + ```XML |Required **Text**. The **BlankPattern** attribute is used to generate a localized text pattern for displaying text values for lookup fields that are blank (empty string). In the United States, this is localized as `(Item ^1)`. `^1` is replaced with the item ID of the item being referenced.
    | |**Len**
    |Required **Integer**. The **Len** attribute causes the members of the drop-down list to be truncated to the specified number of Unicode characters if they exceed the value of _Len_. This prevents the drop-down menu from being excessively wide.
    | |**MoreText**
    |Required **Text**. The **MoreText** attribute specifies what is displayed in order to indicate that the string has been truncated (typically an ellipsis, `...`).
    | - + ### Child elements -None - +None + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ### Remarks -Conditional rendering is based on the display mode. New items use the default value of the field, while items in Edit mode use the current value of the field to set the value of the HTML **Selected** attribute, with **Selected=True** added for the default or current value of the item. - +Conditional rendering is based on the display mode. New items use the default value of the field, while items in Edit mode use the current value of the field to set the value of the HTML **Selected** attribute, with **Selected=True** added for the default or current value of the item. + For **Lookup** field types, this element produces the sequence ``. - + ## Example -The following example constructs a drop-down list box and uses the **SelectOptions** element to delineate the options. - +The following example constructs a drop-down list box and uses the **SelectOptions** element to delineate the options. + ```XML @@ -86,4 +85,3 @@ The following example constructs a drop-down list box and uses the **SelectOptio ```
    - diff --git a/docs/schema/sequencenumber-element-event.md b/docs/schema/sequencenumber-element-event.md index ee6b6708c..ea72f0dd4 100644 --- a/docs/schema/sequencenumber-element-event.md +++ b/docs/schema/sequencenumber-element-event.md @@ -1,11 +1,11 @@ --- title: SequenceNumber Element (Event) +description: SequenceNumber Element (Event) specifies the order to use for the event registration when more than one handler is associated with the feature. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d95bccc3-7b73-4059-a5bd-fe345f461ef1 --- @@ -70,11 +70,3 @@ For an example of how this element is used, see [Event Registrations](event-regi - [Event Fundamentals](https://msdn.microsoft.com/library/4a20751f-877a-48ca-9d37-c3d4e6df9f30(Office.15).aspx) - [Registering an Event Handler](https://msdn.microsoft.com/library/c86de04e-6f5b-4082-9ed4-203b6303007b(Office.15).aspx) - [How to: Create an Event Handler Feature](https://msdn.microsoft.com/library/4f70b1ea-dafe-4068-a6b0-55402b7618dc(Office.15).aspx) - - - - - - - - diff --git a/docs/schema/serializablesecurablenamevaluepairs-element-securableauthdata-complextypesps15xs.md b/docs/schema/serializablesecurablenamevaluepairs-element-securableauthdata-complextypesps15xs.md index 7e6a704bb..43920a773 100644 --- a/docs/schema/serializablesecurablenamevaluepairs-element-securableauthdata-complextypesps15xs.md +++ b/docs/schema/serializablesecurablenamevaluepairs-element-securableauthdata-complextypesps15xs.md @@ -1,27 +1,26 @@ --- title: "SerializableSecurableNameValuePairs element (SecurableAuthData complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5284bb99-44c0-2ea1-5c9e-2812df7919c4 -description: "Last modified: March 09, 2015" +description: Learn about SerializableSecurableNameValuePairs element (SecurableAuthData complexType) (SPS15XSDSearchSet2). --- # SerializableSecurableNameValuePairs element (SecurableAuthData complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |q9:ArrayOfKeyValueOfstringstring
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |q9:ArrayOfKeyValueOfstringstring | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/server-ribbon-schema.md b/docs/schema/server-ribbon-schema.md index eb16b5599..5ea454a6b 100644 --- a/docs/schema/server-ribbon-schema.md +++ b/docs/schema/server-ribbon-schema.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,15 +16,15 @@ description: The Server Ribbon schema defines the structure of XML documents tha # Server Ribbon schema **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + The Server Ribbon schema defines the structure of XML documents that customize the server ribbon. - + ## XML schema definition -An XML document that customizes the server ribbon must validate with the schema that is defined in the cui.xsd file. This file is located in the following directory: %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML. - +An XML document that customizes the server ribbon must validate with the schema that is defined in the cui.xsd file. This file is located in the following directory: %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\XML. + ## Elements - + - [Button](button-element.md) - [CheckBox](checkbox-element.md) - [Color](color-element.md) @@ -74,9 +73,8 @@ An XML document that customizes the server ribbon must validate with the schema - [UnitAbbreviation](unitabbreviation-element.md) - + ## See also - [CommandUIDefinition Element](commanduidefinition-element.md) - [Building Block: Server Ribbon](https://msdn.microsoft.com/library/035cdaf8-29f3-45ca-b5de-461bb65797e8%28Office.15%29.aspx) - diff --git a/docs/schema/serveremailfooter-element-site.md b/docs/schema/serveremailfooter-element-site.md index bbe4fb972..b04d18a98 100644 --- a/docs/schema/serveremailfooter-element-site.md +++ b/docs/schema/serveremailfooter-element-site.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: - schema ms.assetid: d9df4fb9-7e0a-4699-94d7-4b420f5066f6 -description: Defines the footer section for server email, which includes both HTML and the text that is displayed. +description: Defines the footer section for server email, which includes both HTML and the text that is displayed. --- # ServerEmailFooter element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Defines the footer section for server email, which includes both HTML and the text that is displayed. - + +Defines the footer section for server email, which includes both HTML and the text that is displayed. + ```XML @@ -35,20 +34,18 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Description**| |:-----|:-----| |**Name**
    |Required **Text**.
    | - + ### Child elements None - + ### Parent elements - [Project](project-element-site.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - -
    - +- Maximum: 1 +
    diff --git a/docs/schema/serverproperty-element-view.md b/docs/schema/serverproperty-element-view.md index ff4d83619..ca6616ca7 100644 --- a/docs/schema/serverproperty-element-view.md +++ b/docs/schema/serverproperty-element-view.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: @@ -17,9 +16,9 @@ description: Represents a property that applies to a Web application. # ServerProperty element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a property that applies to a Web application. - + ```XML |Optional **Boolean**. **TRUE** to remove white space from the beginning and end of the value returned by the element.
    | |**URLEncode**
    |Optional **Boolean**. **TRUE** to convert special characters, such as spaces, to quoted UTF-8 format (for example, `%c3%ab` for character `ë`).
    | |**URLEncodeAsURL**
    |Optional **Boolean**. Like **URLEncode**, but **TRUE** to specify that the string to encode is a path component of a URL so that forward slashes (`/`) are not encoded.
    | - + ### Child elements - [Column](column-element-view.md) - + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - -
    - +- Maximum: Unbounded +
    diff --git a/docs/schema/setlist-element-view.md b/docs/schema/setlist-element-view.md index 143c7c22e..c4d1a86ba 100644 --- a/docs/schema/setlist-element-view.md +++ b/docs/schema/setlist-element-view.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: @@ -17,9 +16,9 @@ description: Designates which list is current. # SetList element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Designates which list is current. - + ```XML |Required **Text**. Specifies the name of the list.
    | |**PreserveContext**
    |Optional **Boolean**. If **FALSE**, implementing the **SetList** element reruns the database query that is necessary to fetch the data for a form that displays a single list item. This functionality is useful when a view and a form are on the same page. The default value is **TRUE**.
    | |**Scope**
    |When set to **Request**, this attribute makes the list globally available to the page.
    | - + ### Child elements None - + ### Parent elements - [Method](method-element-view.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ### Remarks -When you use the **SetList** element, you need to use the internal name, which has no spaces and is invariant. - +When you use the **SetList** element, you need to use the internal name, which has no spaces and is invariant. + The **SetList** element has both a spanning and a nonspanning form, so that `Announcements` would be the same as ``. - -The **SetList** element is often a child to a [Method](method-element-view.md) element used in batch processing of requests. - + +The **SetList** element is often a child to a [Method](method-element-view.md) element used in batch processing of requests. + ## Example The following example returns the value of the **Title** field from the Lists table in the database if the current list equals the list that is looked up. Initially, the current list is temporarily assigned to a variable `Old` and then reinstated as the current list. - + ```XML @@ -89,4 +88,3 @@ The following example returns the value of the **Title** field from the Lists ta ## See also - [List element (List)](list-element-list.md) - diff --git a/docs/schema/settingspage-element-propertiesdefinition-complextypesharepoint-add-in-manifest.md b/docs/schema/settingspage-element-propertiesdefinition-complextypesharepoint-add-in-manifest.md index d5f9c9e28..82a8210ed 100644 --- a/docs/schema/settingspage-element-propertiesdefinition-complextypesharepoint-add-in-manifest.md +++ b/docs/schema/settingspage-element-propertiesdefinition-complextypesharepoint-add-in-manifest.md @@ -1,15 +1,15 @@ --- title: SettingsPage element (PropertiesDefinition complexType) +description: Learn about SettingsPage element (PropertiesDefinition complexType). manager: soliver -ms.date: 9/17/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d6ae1710-208e-abc8-e029-21662990ad24 --- -# SettingsPage element (PropertiesDefinition complexType) +# SettingsPage element (PropertiesDefinition complexType) (SharePoint Add-in Manifest) @@ -17,12 +17,12 @@ ms.assetid: d6ae1710-208e-abc8-e029-21662990ad24 For future use. This element currently has no function. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Information | Location | |---|---| | **Element type** | UrlElementDefinition | | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | @@ -32,7 +32,7 @@ For future use. This element currently has no function. ```XML  - + ``` ## Elements and attributes @@ -78,9 +78,3 @@ None.

    - - - - - - diff --git a/docs/schema/setvar-element-view.md b/docs/schema/setvar-element-view.md index 35362b484..dad8e0cce 100644 --- a/docs/schema/setvar-element-view.md +++ b/docs/schema/setvar-element-view.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: @@ -17,9 +16,9 @@ description: Allows variables to be set in the context of rendering the page—e # SetVar element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Allows variables to be set in the context of rendering the page—either locally to the current level of XML or globally to the page. - + ```XML |Required **Text**. Specifies a name for the variable.
    | |**Scope**
    |If set to **Request**, the variable is global.
    | |**Value**
    |Optional **Text**. Can be used to assign a value to the variable when this is an empty element.
    | - + ### Child elements None - + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 - Maximum: Unbounded - + ### Remarks The **SetVar** element has both a spanning and a non-spanning form, so that `Announcements` would be the same as ` - + |**Value**|**Description**| |:-----|:-----| |**DISPLAY**
    |Used when rendering the **ViewBody** section of a view.
    | @@ -76,11 +75,11 @@ The **SetVar** element is frequently used to change the display mode by setting |**PREVIEWDISPLAY**
    |Used when editing a display form with Microsoft FrontPage.
    | |**PREVIEWNEW**
    |Used when editing a new item form with FrontPage.
    | |**PREVIEWEDIT**
    |Used when editing an edit item form with FrontPage.
    | - + ## Examples -The following example illustrates using the **SetVar** element to set global scope for a variable. The second line returns the value set in the first line. - +The following example illustrates using the **SetVar** element to set global scope for a variable. The second line returns the value set in the first line. + ```XML Value ... @@ -89,8 +88,8 @@ The following example illustrates using the **SetVar** element to set global sco
    -In the following example, the first [GetVar](https://msdn.microsoft.com/library/abf483e3-c6e7-4d72-97c6-76300e1b483e%28Office.15%29.aspx) element returns `Value_2` and the second **GetVar** element returns `Value_1` because the **SetVar** element that contains `Value_2` applies only to children of the **Sample** element. `Value_2` goes out of scope after the closing Sample tag. - +In the following example, the first [GetVar](https://msdn.microsoft.com/library/abf483e3-c6e7-4d72-97c6-76300e1b483e%28Office.15%29.aspx) element returns `Value_2` and the second **GetVar** element returns `Value_1` because the **SetVar** element that contains `Value_2` applies only to children of the **Sample** element. `Value_2` goes out of scope after the closing Sample tag. + ```XML Value_1 @@ -103,7 +102,7 @@ In the following example, the first [GetVar](https://msdn.microsoft.com/library/
    The following example evaluates whether a field is required and, if it is required, creates the red asterisk (`*`) that is displayed beside required fields in New or Edit forms and sets the **HasRequired** variable to **TRUE**. - + ```XML @@ -119,4 +118,3 @@ The following example evaluates whether a field is required and, if it is requir ## See also - [GetVar element (View)](getvar-element-view.md) - diff --git a/docs/schema/sharepoint-add-in-schemas.md b/docs/schema/sharepoint-add-in-schemas.md index 921897046..e5f0af2ac 100644 --- a/docs/schema/sharepoint-add-in-schemas.md +++ b/docs/schema/sharepoint-add-in-schemas.md @@ -1,11 +1,11 @@ --- title: SharePoint Add-in schemas +description: Learn about SharePoint Add-in schemas, document schemas that support SharePoint Add-ins, including the App Manifest schema. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: overview -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 68be63fc-cc31-4003-be2e-58303d74dda0 --- @@ -21,12 +21,5 @@ Document schemas that support SharePoint Add-ins, including the App Manifest sch - [AppPartConfigDefinition schema reference](apppartconfigdefinition-schema-reference.md) -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. - - - - - - - diff --git a/docs/schema/sharepoint-features-schemas.md b/docs/schema/sharepoint-features-schemas.md index b4922fb59..ade9527b3 100644 --- a/docs/schema/sharepoint-features-schemas.md +++ b/docs/schema/sharepoint-features-schemas.md @@ -1,13 +1,13 @@ --- title: SharePoint Features schemas +description: Learn more about SharePoint Features schemas. manager: soliver -ms.date: 11/16/2014 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference keywords: - features [sharepoint 2010], schemas,schemas [SharePoint 2010], Features,Features [SharePoint 2010] -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a9f6f15e-3489-4677-b579-db330638a853 --- @@ -55,10 +55,3 @@ In addition to describing the file format of [Feature.xml Files](feature-xml-fil - [Web Template XML](web-template-xml.md) - [Workflow Definitions](workflow-definitions.md) - - - - - - - diff --git a/docs/schema/sharepoint-search-settings-portability-schemas.md b/docs/schema/sharepoint-search-settings-portability-schemas.md index f79d84894..23529564d 100644 --- a/docs/schema/sharepoint-search-settings-portability-schemas.md +++ b/docs/schema/sharepoint-search-settings-portability-schemas.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 9/18/2015 ms.audience: Developer ms.topic: overview -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f06f101e-b2e6-4e3e-9194-f750ab28d966 description: The search settings portability schemas describe the XML files you need when you port SharePoint 2013 Search settings from one installation to another. --- @@ -30,12 +29,5 @@ The search settings portability schemas describe the XML files you need when you
    -> [!NOTE] +> [!NOTE] > You can [download the schemas](https://download.microsoft.com/download/1/2/2/12204CDE-56A6-4B2F-9719-4EA25FDA7743/SP15_search_settings_portability_schema.zip). - - - - - - - diff --git a/docs/schema/shortname-element-alerttemplates.md b/docs/schema/shortname-element-alerttemplates.md index d44daca46..fafe4fb8f 100644 --- a/docs/schema/shortname-element-alerttemplates.md +++ b/docs/schema/shortname-element-alerttemplates.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - AlertTemplates schema api_type: @@ -17,9 +16,9 @@ description: Specifies a short name for the alert template filter. # ShortName element (AlertTemplates) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies a short name for the alert template filter. The name can be specified as a string that contains a Resource variable. Resource variables that are listed in AlertTemplates.xml, such as `$Resources:Alerts_anything_filter_shortname`, can be found in core.resx, which is located in _local_drive_ `\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\Resources`. - + ```XML @@ -32,17 +31,15 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - + ### Parent elements - [FilterDefinition](filterdefinition-element-alerttemplates.md) - + ## Example For an example of how this element is used, see [FilterDefinition element (AlertTemplates)](filterdefinition-element-alerttemplates.md). - - diff --git a/docs/schema/similartype-element-sps15xsdsearchset5.md b/docs/schema/similartype-element-sps15xsdsearchset5.md index b4919be50..660cf3411 100644 --- a/docs/schema/similartype-element-sps15xsdsearchset5.md +++ b/docs/schema/similartype-element-sps15xsdsearchset5.md @@ -1,27 +1,26 @@ --- title: "SimilarType element (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9454ff12-42cf-55c7-7b18-eb38db8cab10 -description: "Last modified: March 09, 2015" +description: Learn more about SimilarType element (SPS15XSDSearchSet5). --- # SimilarType element (SPS15XSDSearchSet5) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SimilarType
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Element type** |tns:SimilarType | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query | +|**Schema file**|schema_Microsoft.Office.Server.Search.Query.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/similartype-simpletype-sps15xsdsearchset5.md b/docs/schema/similartype-simpletype-sps15xsdsearchset5.md index f0ba09de3..35ad5f827 100644 --- a/docs/schema/similartype-simpletype-sps15xsdsearchset5.md +++ b/docs/schema/similartype-simpletype-sps15xsdsearchset5.md @@ -1,27 +1,26 @@ --- title: "SimilarType simpleType (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2ca0d24e-1c22-3115-a8a8-4bb3cde0f2a1 -description: "Last modified: March 09, 2015" +description: Learn more about SimilarType simpleType (SPS15XSDSearchSet5). --- # SimilarType simpleType (SPS15XSDSearchSet5) **Applies to:** SharePoint Server 2013 - + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Base type**
    |xs:string
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Base type** |xs:string | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query | +|**Schema file** |schema_Microsoft.Office.Server.Search.Query.xsd | + ## Definition ```XML @@ -44,5 +43,3 @@ description: "Last modified: March 09, 2015" |Find
    || |Refine
    || |Exclude
    || - - diff --git a/docs/schema/simplepropertydefinition-complextype-apphostwebfeatures.md b/docs/schema/simplepropertydefinition-complextype-apphostwebfeatures.md index 0fb6ba14d..2ef0077b7 100644 --- a/docs/schema/simplepropertydefinition-complextype-apphostwebfeatures.md +++ b/docs/schema/simplepropertydefinition-complextype-apphostwebfeatures.md @@ -1,24 +1,24 @@ --- title: SimplePropertyDefinition complexType +description: Learn more about SimplePropertyDefinition complexType. manager: soliver -ms.date: 9/16/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4d199cbb-d3d1-7d49-b0f2-eb67ecd7c3d2 --- -# SimplePropertyDefinition complexType +# SimplePropertyDefinition complexType (AppHostWebFeatures) -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +| Information | Location | |---|---| | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | | **Schema file** | apphostwebfeatures.xsd | @@ -77,10 +77,3 @@ None.

    - - - - - - - diff --git a/docs/schema/site-definition-onet-xml-files.md b/docs/schema/site-definition-onet-xml-files.md index aa18dcb74..ae0cb8ef2 100644 --- a/docs/schema/site-definition-onet-xml-files.md +++ b/docs/schema/site-definition-onet-xml-files.md @@ -1,11 +1,11 @@ --- title: Site Definition (Onet.xml) files +description: Learn more about Site Definition (Onet.xml) files. manager: soliver -ms.date: 11/16/2014 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 170d526a-49c7-41c6-9295-47bd21b1ba7d --- @@ -23,9 +23,9 @@ SharePoint Foundation activates Features specified within the [Onet.xml](https:/ The following example shows the [Feature](feature-element-site.md) element used to specify Features and Feature properties in a site definition configuration. ```XML - + - @@ -44,7 +44,7 @@ The following example shows the [Feature](feature-element-site.md) element used - + ``` @@ -54,11 +54,3 @@ The following example shows the [Feature](feature-element-site.md) element used - [Site schema](site-schema.md) - [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1(Office.15).aspx) - [WebTemp.xml](https://msdn.microsoft.com/library/199bbb65-d12f-475d-b157-31a1bffe84c8(Office.15).aspx) - - - - - - - - diff --git a/docs/schema/site-deletion-confirmation-schema.md b/docs/schema/site-deletion-confirmation-schema.md index bfa41139f..f4e01cef4 100644 --- a/docs/schema/site-deletion-confirmation-schema.md +++ b/docs/schema/site-deletion-confirmation-schema.md @@ -1,39 +1,36 @@ --- title: "Site Deletion Confirmation schema" manager: soliver -ms.date: 11/16/2014 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site Deletion Confirmation schema api_type: - schema ms.assetid: eddf35a6-8b40-4d6f-8ef1-4c3684a2f93f -description: "Last modified: July 15, 2011" +description: The Site Deletion Confirmation schema specifies the text that is sent in email messages to site owners to confirm site usage or to warn that the site will be automatically deleted. --- # Site Deletion Confirmation schema **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + The Site Deletion Confirmation schema specifies the text that is sent in email messages to site owners to confirm site usage or to warn that the site will be automatically deleted. This schema is defined in DEADWEB.XML (%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE\1033\XML)). - + ## Site Deletion Confirmation elements [Email](email-element-site-deletion.md) - + [Confirmation](confirmation-element-site-deletion.md) - + [ConfirmationSubject](confirmationsubject-element-site-deletion.md) - + [ConfirmationBody](confirmationbody-element-site-deletion.md) - + [AutoDeleteWarning](autodeletewarning-element-site-deletion.md) - + [AutoDeleteSubject](autodeletesubject-element-site-deletion.md) - -[AutoDeleteBody](autodeletebody-element-site-deletion.md) - +[AutoDeleteBody](autodeletebody-element-site-deletion.md) diff --git a/docs/schema/site-element-deploymentmanifest.md b/docs/schema/site-element-deploymentmanifest.md index 7033b5229..34e203995 100644 --- a/docs/schema/site-element-deploymentmanifest.md +++ b/docs/schema/site-element-deploymentmanifest.md @@ -1,20 +1,19 @@ --- title: "Site Element (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 6/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: cc6c37c3-c1b4-414b-a3b4-8bf5bcffe607 -description: "Last modified: March 09, 2015" +description: Site Element (DeploymentManifest) represents an instance of a Windows SharePoint Services 3.0 site object. --- # Site Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents an instance of a Windows SharePoint Services 3.0 site ([SPSite](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPSite.aspx)) object. +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + +Represents an instance of a Windows SharePoint Services 3.0 site ([SPSite](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPSite.aspx)) object. ## Definition @@ -34,7 +33,7 @@ USAGE ## Type **SPSite** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -44,17 +43,16 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Type**|**Description**| |:-----|:-----|:-----| |**Id**
    |[Guid Simple Type (DeploymentManifest)](guid-simple-type-deploymentmanifest.md)
    |Global unique identifier of the Windows SharePoint Services 3.0 site object.
    | - + ### Child elements None - + ### Parent elements [SPObject Element (DeploymentManifest)](spobject-element-deploymentmanifest.md) - + ## See also - [SPSite](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPSite.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/site-element.md b/docs/schema/site-element.md index 1425dbbe3..12185031c 100644 --- a/docs/schema/site-element.md +++ b/docs/schema/site-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 33c9ee16-a90e-44f5-9e9c-8818e7a9468e description: Top-level element used in the BASE.XML file to contain the schema definitions for tables in the content database. --- @@ -13,9 +12,9 @@ description: Top-level element used in the BASE.XML file to contain the schema d # Site element **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Top-level element used in the BASE.XML file (`\Program Files\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\XML`) to contain the schema definitions for tables in the content database. - + ```XML @@ -28,20 +27,18 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [GlobalLists](globallists-element.md) - + ### Parent elements None - + ### Occurrences - Minimum: 0 -- Maximum: 1 - -
    - +- Maximum: 1 +
    diff --git a/docs/schema/site-schema-elements-a-l.md b/docs/schema/site-schema-elements-a-l.md index 4b00ffb18..318bda518 100644 --- a/docs/schema/site-schema-elements-a-l.md +++ b/docs/schema/site-schema-elements-a-l.md @@ -1,72 +1,71 @@ --- title: "Site schema elements A-L" manager: soliver -ms.date: 11/16/2014 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: - schema ms.assetid: 30797149-c2bc-4941-9443-80c60d8c5634 -description: "Last modified: July 15, 2011" +description: Learn about Site schema elements A-L. --- # Site schema elements A-L **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + [AllUsersWebPart](alluserswebpart-element-site.md) - + [BaseType](basetype-element-site.md) - + [BaseTypes](basetypes-element-site.md) - + [BinarySerializedWebPart](binaryserializedwebpart-element-site.md) - + [Components](components-element-site.md) - + [Configuration](configuration-element-site.md) - + [Configurations](configurations-element-site.md) - + [Data](data-element-site.md) - + [DocumentTemplate](documenttemplate-element-site.md) - + [DocumentTemplateFile](documenttemplatefile-element-site.md) - + [DocumentTemplateFiles](documenttemplatefiles-element-site.md) - + [DocumentTemplates](documenttemplates-element-site.md) - + [ExecuteUrl](executeurl-element-site.md) - + [ExternalSecurityProvider](externalsecurityprovider-element-site.md) - + [Feature](feature-element-site.md) - + [Field](field-element-site.md) - + [File](file-element.md) - + [FileDialogPostProcessor](filedialogpostprocessor-element-site.md) - + [GUID](guid-element-site.md) - + [GUIDMap](guidmap-element-site.md) - + [List](list-element-site.md) - + [Lists](lists-element-site.md) - + [ListTemplate](listtemplate-element-site.md) - + [ListTemplates](listtemplates-element-site.md) - + ## See also -- [Site schema elements M-Z](site-schema-elements-m-z.md) \ No newline at end of file +- [Site schema elements M-Z](site-schema-elements-m-z.md) diff --git a/docs/schema/site-schema-elements-m-z.md b/docs/schema/site-schema-elements-m-z.md index f4b696807..022232c01 100644 --- a/docs/schema/site-schema-elements-m-z.md +++ b/docs/schema/site-schema-elements-m-z.md @@ -1,70 +1,68 @@ --- title: "Site schema elements M-Z" manager: soliver -ms.date: 11/16/2014 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: - schema ms.assetid: 782a6cd8-5b08-44f6-a6da-68337cafc596 -description: "Last modified: July 15, 2011" +description: Learn about Site schema elements M-Z. --- # Site schema elements M-Z **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + [MetaData](metadata-element-site.md) - + [Module](module-element-site.md) - + [Modules](modules-element-site.md) - + [NavBar](navbar-element-site.md) - + [NavBarLink](navbarlink-element-site.md) - + [NavBarPage (Site - Module)](navbarpage-element-sitemodule.md) - + [NavBarPage (Site - NavBar)](navbarpage-element-sitenavbar.md) - + [NavBars](navbars-element-site.md) - + [Project](project-element-site.md) - + [Properties](properties-element-site.md) - + [Property (Site - Feature)](property-element-sitefeature.md) - + [Property (Site - Module)](property-element-sitemodule.md) - + [Row](row-element-site.md) - + [Rows](rows-element-site.md) - + [ServerEmailFooter](serveremailfooter-element-site.md) - + [SiteFeatures](sitefeatures-element-site.md) - + [Template](template-element-site.md) - + [Templates](templates-element-site.md) - + [View](view-element-site.md) - + [WebFeatures](webfeatures-element-site.md) - + [WebPart](webpart-element-site.md) - + [WebPartConnection](webpartconnection-element-site.md) - + [WebPartTransformer](webparttransformer-element-site.md) - + ## See also - [Site schema elements A-L](site-schema-elements-a-l.md) - diff --git a/docs/schema/site-schema.md b/docs/schema/site-schema.md index f131e4cee..cb3bbf69f 100644 --- a/docs/schema/site-schema.md +++ b/docs/schema/site-schema.md @@ -1,16 +1,16 @@ --- title: "Site schema" manager: soliver -ms.date: 11/16/2014 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: - schema ms.assetid: e711f6b0-2787-4a13-b0e9-140c3435c1e2 -description: "Last modified: July 15, 2011" +description: The Site schema of Collaborative Application Markup Language is used to define metadata for creating websites, including the root site of site collections. --- # Site schema diff --git a/docs/schema/sitedefinitionmanifest-element-solution.md b/docs/schema/sitedefinitionmanifest-element-solution.md index 9a5bdb090..73481eccf 100644 --- a/docs/schema/sitedefinitionmanifest-element-solution.md +++ b/docs/schema/sitedefinitionmanifest-element-solution.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Solution Schema api_type: @@ -17,9 +16,9 @@ description: Specifies a site definition manifest to include in the solution. # SiteDefinitionManifest element (Solution) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies a site definition manifest to include in the solution. - + ```XML @@ -37,17 +36,15 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Description**| |:-----|:-----| |**Location**
    |Required **Text**. The relative path of the root folder for a site definition.
    | - + ### Child elements - [WebTempFile](webtempfile-element-solution.md) - + ### Parent elements - [SiteDefinitionManifests](sitedefinitionmanifests-element-solution.md) - + ## Example For an example of how this element is used, see [Solution schema](solution-schema.md). - - diff --git a/docs/schema/sitedefinitionmanifests-element-solution.md b/docs/schema/sitedefinitionmanifests-element-solution.md index 75bdfea01..473c87814 100644 --- a/docs/schema/sitedefinitionmanifests-element-solution.md +++ b/docs/schema/sitedefinitionmanifests-element-solution.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Solution Schema api_type: @@ -17,9 +16,9 @@ description: Specifies the site definitions to include in the solution. # SiteDefinitionManifests element (Solution) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies the site definitions to include in the solution. - + ```XML @@ -32,22 +31,20 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [Feature](feature-element-site.md) - + ### Parent elements - [Configuration](configuration-element-site.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - -### Remarks +- Maximum: 1 -Microsoft SharePoint Foundation activates features specified within the [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx) file in the order that they are listed. Consequently, you must specify Features that are depended upon before Features that depend upon them. - +### Remarks +Microsoft SharePoint Foundation activates features specified within the [Onet.xml](https://msdn.microsoft.com/library/b99d6657-d9ae-4135-a43c-c58cdfcdc6c1%28Office.15%29.aspx) file in the order that they are listed. Consequently, you must specify Features that are depended upon before Features that depend upon them. diff --git a/docs/schema/solution-element-solution.md b/docs/schema/solution-element-solution.md index a22c7900b..497a406e4 100644 --- a/docs/schema/solution-element-solution.md +++ b/docs/schema/solution-element-solution.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Solution Schema api_type: @@ -17,17 +16,17 @@ description: Top-level element for a solution manifest file. # Solution element (Solution) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Top-level element for a solution manifest file. - + ```XML - ``` @@ -47,7 +46,7 @@ The following sections describe attributes, child elements, and parent elements. |**SharePointProductVersion**
    |Optional **string**. Specifies the version of Microsoft SharePoint Foundation.
    | |**SolutionId**
    |Optional **string**. Contains the GUID for the solution.
    | |**Title**
    |Optional **string**. Specifies the title of the solution.
    | - + ### Child elements - [ActivationDependencies](activationdependencies-element-solution.md) @@ -60,13 +59,11 @@ The following sections describe attributes, child elements, and parent elements. - [SiteDefinitionManifests](sitedefinitionmanifests-element-solution.md) - [RootFiles](rootfiles-element-solution.md) - [TemplateFiles](templatefiles-element-solution.md) - + ### Parent elements None - + ## Example For an example of how this element is used, see [Solution schema](solution-schema.md). - - diff --git a/docs/schema/solution-schema.md b/docs/schema/solution-schema.md index fc7192102..c25078fa7 100644 --- a/docs/schema/solution-schema.md +++ b/docs/schema/solution-schema.md @@ -6,8 +6,7 @@ ms.audience: Developer ms.topic: reference keywords: - solution schema - [sharepoint 2010],XML schema - [SharePoint 2010] -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_type: - schema ms.assetid: 48efc045-5b54-4332-abed-6813d011c803 @@ -17,75 +16,75 @@ description: A solution manifest file defines the constituent parts of a solutio # Solution schema **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + A solution manifest file defines the constituent parts of a solution, including its files, assemblies, code access security, web parts, Features, site definitions, and other resources. - -[Solution](solution-element-solution.md) - + +[Solution](solution-element-solution.md) + - [ActivationDependencies Element (Solution)](activationdependencies-element-solution.md) - + - [ActivationDependency Element (Solution)](activationdependency-element-solution.md) - + - [ApplicationResourceFiles](applicationresourcefiles-element-solution.md) - + - [ApplicationResourceFile](applicationresourcefile-element-solution.md) - + - [Assemblies](assemblies-element-solutionassemblies.md) - + - [Assembly](assembly-element-solutionassemblies.md) - + - [SafeControls](safecontrols-element-solution.md) - + - [SafeControl](safecontrol-element-solution.md) - + - [ClassResources](classresources-element-solution.md) - + - [ClassResource](classresource-element-solution.md) - + - [CodeAccessSecurity](codeaccesssecurity-element-solution.md) - + - [PolicyItem](policyitem-element-solution.md) - + - [PermissionSet](permissionset-element-solution.md) - + - [IPermission](ipermission-element-solution.md) - + - [Assemblies](assemblies-element-solutioncodeaccesssecurity.md) - + - [Assembly](assembly-element-solutioncodeaccesssecurity.md) - + - [DwpFiles](dwpfiles-element-solution.md) - + - [DwpFile](dwpfile-element-solution.md) - + - [FeatureManifests](featuremanifests-element-solution.md) - + - [FeatureManifest](featuremanifest-element-solution.md) - + - [Resources](resources-element-solution.md) - + - [Resource](resource-element-solution.md) - + - [RootFiles](rootfiles-element-solution.md) - + - [RootFile](rootfile-element-solution.md) - + - [SiteDefinitionManifests](sitedefinitionmanifests-element-solution.md) - + - [SiteDefinitionManifest](sitedefinitionmanifest-element-solution.md) - + - [WebTempFile](webtempfile-element-solution.md) - + - [TemplateFiles](templatefiles-element-solution.md) - + - [TemplateFile](templatefile-element-solution.md) - + ## Examples The following example shows a solution manifest file that includes declarations for Features, site definition files, and assemblies. - + ```XML - @@ -111,7 +110,7 @@ The following example shows a solution manifest file that includes declarations
    The following example shows a manifest for a solution that includes two Features and three global language resource files. - + ```XML @@ -129,5 +128,3 @@ The following example shows a manifest for a solution that includes two Features     ``` - - diff --git a/docs/schema/solutiondefinition-element-solutionmanifestdefinitions-schema.md b/docs/schema/solutiondefinition-element-solutionmanifestdefinitions-schema.md index 1a5046bbc..bab242f44 100644 --- a/docs/schema/solutiondefinition-element-solutionmanifestdefinitions-schema.md +++ b/docs/schema/solutiondefinition-element-solutionmanifestdefinitions-schema.md @@ -1,21 +1,21 @@ --- title: SolutionDefinition Element +description: SolutionDefinition Element specifies the root element of a Microsoft Business Connectivity Services (BCS) solution manifest file. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1e7a8225-6a52-ba74-e109-2ec7eddaca3d --- -# SolutionDefinition Element +# SolutionDefinition Element (SolutionManifestDefinitions Schema) **Applies to**: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 -Specifies the root element of a Microsoft Business Connectivity Services (BCS) solution manifest file. A solution manifest file enables a solution developer to describe the user interface (UI), behavior, and business logic associated with a Microsoft Outlook Item Type such as Outlook Contact, Task, Post, or Calendar. +Specifies the root element of a Microsoft Business Connectivity Services (BCS) solution manifest file. A solution manifest file enables a solution developer to describe the user interface (UI), behavior, and business logic associated with a Microsoft Outlook Item Type such as Outlook Contact, Task, Post, or Calendar. For example, in the manifest file, a solution developer would be able to indicate that for an Outlook Item Type of Contact, a certain UI should be used (example, an Office External Part) and a specific method from the external system (for example, **UpdateCustomerInstance(ID, NewInstanceValues)** should be called when the data in the item changes. There will always be at least one namespace declaration on the **SolutionDefinition** element, typically: @@ -43,28 +43,10 @@ None. ### Child elements - ---- - - - - - - - - - - - - - - - - -

    Element

    Description

    SolutionSettings Element in SolutionDefinition (SolutionManifestDefinitions Schema)

    Defines the settings for this Business Connectivity Services solution such as the ID, display name, and description.

    ContextDefinitionGroups Element in SolutionDefinition (SolutionManifestDefinitions Schema)

    Defines the context definitions that are part of this solution, grouped by the Outlook Item Type to which they refer. The manifest file can contain a context definition group containing a list of context definitions for each one of the Outlook Item Types such as Contact, Task, Post, or Calendar, or EntityView if showing related external data in a task pane.

    +| Element | Description | +| --- | --- | +| [SolutionSettings Element in SolutionDefinition (SolutionManifestDefinitions Schema)](solutionsettings-element-in-solutiondefinition-solutionmanifestdefinitions-schem.md) | Defines the settings for this Business Connectivity Services solution such as the ID, display name, and description. | +| [ContextDefinitionGroups Element in SolutionDefinition (SolutionManifestDefinitions Schema)](contextdefinitiongroups-element-in-solutiondefinition-solutionmanifestdefinition.md) | Defines the context definitions that are part of this solution, grouped by the Outlook Item Type to which they refer. The manifest file can contain a context definition group containing a list of context definitions for each one of the Outlook Item Types such as Contact, Task, Post, or Calendar, or EntityView if showing related external data in a task pane. | ### Parent elements @@ -73,11 +55,3 @@ None.

    - - - - - - - - diff --git a/docs/schema/solutionid-element-event.md b/docs/schema/solutionid-element-event.md index d8b5ef031..136ae0929 100644 --- a/docs/schema/solutionid-element-event.md +++ b/docs/schema/solutionid-element-event.md @@ -1,11 +1,11 @@ --- title: SolutionId Element (Event) +description: SolutionId Element (Event) specifies the unique ID of the solution for the event receiver. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 44b66b3e-09b2-4e31-b51a-2e2c263e2b5a --- @@ -63,11 +63,3 @@ None ## Example For an example of how this element is used, see [Event Registrations](event-registrations.md). - - - - - - - - diff --git a/docs/schema/solutionmanifestdeclarativeextensions-schema.md b/docs/schema/solutionmanifestdeclarativeextensions-schema.md index d24e442e3..ee07ba6a0 100644 --- a/docs/schema/solutionmanifestdeclarativeextensions-schema.md +++ b/docs/schema/solutionmanifestdeclarativeextensions-schema.md @@ -1,11 +1,11 @@ --- title: SolutionManifestDeclarativeExtensions schema +description: This section contains documentation for the SolutionManifestDeclarativeExtensions schema (SolutionManifestDeclarativeExtensions.xsd). manager: soliver -ms.date: 11/16/2014 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 17fb7996-eca8-721e-aeea-17fedf29b16b --- @@ -50,11 +50,3 @@ This section contains documentation for the **SolutionManifestDeclarativeExtensi - [Picture element in DeclarativeFormRegion (SolutionManifestDeclarativeExtensions schema)](picture-element-in-declarativeformregion-solutionmanifestdeclarativeextensions-s.md) - [UrlAction element in Actions (SolutionManifestDeclarativeExtensions schema)](urlaction-element-in-actions-solutionmanifestdeclarativeextensions-schema.md) - - - - - - - - diff --git a/docs/schema/solutionmanifestdefinitions-schema.md b/docs/schema/solutionmanifestdefinitions-schema.md index cd4eed2e8..99cb48480 100644 --- a/docs/schema/solutionmanifestdefinitions-schema.md +++ b/docs/schema/solutionmanifestdefinitions-schema.md @@ -1,11 +1,11 @@ --- title: SolutionManifestDefinitions schema +description: This section contains documentation for the Solution Manifest Definition schema (SolutionManifestDefinitions.xsd). manager: soliver -ms.date: 11/16/2014 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f7fb29db-d6e2-8ec8-243f-93ff39a2d506 --- @@ -56,11 +56,3 @@ This section contains documentation for the **Solution Manifest Definition schem - [Views element](views-element.md) - [FolderViewDefinition element](folderviewdefinition-element.md) - - - - - - - - diff --git a/docs/schema/solutionsettings-element-in-solutiondefinition-solutionmanifestdefinitions-schem.md b/docs/schema/solutionsettings-element-in-solutiondefinition-solutionmanifestdefinitions-schem.md index 948b19ce0..a1f8e6e2b 100644 --- a/docs/schema/solutionsettings-element-in-solutiondefinition-solutionmanifestdefinitions-schem.md +++ b/docs/schema/solutionsettings-element-in-solutiondefinition-solutionmanifestdefinitions-schem.md @@ -1,15 +1,15 @@ --- title: SolutionSettings Element in SolutionDefinition +description: SolutionSettings Element in SolutionDefinition defines the settings for this Microsoft Business Connectivity Services (BCS) solution. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d8930948-e804-18ee-7c4b-b0bd39ccf62a --- -# SolutionSettings Element in SolutionDefinition +# SolutionSettings Element in SolutionDefinition (SolutionManifestDefinitions Schema) @@ -90,33 +90,6 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    SolutionDefinition Element (SolutionManifestDefinitions Schema)

    The solution definition these settings belong to.

    - -
    - -
    - - - - - - - - +| Element | Description | +| --- | --- | +| [SolutionDefinition Element (SolutionManifestDefinitions Schema)](solutiondefinition-element-solutionmanifestdefinitions-schema.md) | The solution definition these settings belong to. | diff --git a/docs/schema/sortable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/sortable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md index 9bce532d2..80eca5460 100644 --- a/docs/schema/sortable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/sortable-element-managedpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "Sortable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 650811a2-4578-d706-f62b-74e4afe85be8 -description: "Last modified: March 09, 2015" +description: Learn more about Sortable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2). --- # Sortable element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |xs:boolean
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |xs:boolean | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/sortabletype-element-managedpropertyinfo-complextypesps15xsdsearchset2.md b/docs/schema/sortabletype-element-managedpropertyinfo-complextypesps15xsdsearchset2.md index 8fbf0a2d8..3c15e019c 100644 --- a/docs/schema/sortabletype-element-managedpropertyinfo-complextypesps15xsdsearchset2.md +++ b/docs/schema/sortabletype-element-managedpropertyinfo-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SortableType element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 33368f36-17b6-04bf-bf0f-cf74e214e9d4 -description: "Last modified: March 09, 2015" +description: Learn more about SortableType element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2). --- # SortableType element (ManagedPropertyInfo complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SortableType
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |tns:SortableType | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/sortabletype-element-sps15xsdsearchset2.md b/docs/schema/sortabletype-element-sps15xsdsearchset2.md index a4a9b628c..05b9cfada 100644 --- a/docs/schema/sortabletype-element-sps15xsdsearchset2.md +++ b/docs/schema/sortabletype-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SortableType element (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1cbc7b05-0195-13f4-70f5-eeb452fb75bd -description: "Last modified: March 09, 2015" +description: Learn more about SortableType element (SPS15XSDSearchSet2). --- # SortableType element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SortableType
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |tns:SortableType | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/sortabletype-simpletype-sps15xsdsearchset2.md b/docs/schema/sortabletype-simpletype-sps15xsdsearchset2.md index b1f2c9dae..50a97bd82 100644 --- a/docs/schema/sortabletype-simpletype-sps15xsdsearchset2.md +++ b/docs/schema/sortabletype-simpletype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SortableType simpleType (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8bc6e087-8530-8a5e-144c-a7790e8d716a -description: "Last modified: March 09, 2015" +description: Learn more about SortableType simpleType (SPS15XSDSearchSet2). --- # SortableType simpleType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Base type**
    |xs:string
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Base type** |xs:string | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -40,5 +39,3 @@ description: "Last modified: March 09, 2015" |:-----|:-----| |Enabled
    || |Latent
    || - - diff --git a/docs/schema/sortdirection-element-sps15xsdsearchset5.md b/docs/schema/sortdirection-element-sps15xsdsearchset5.md index dce923408..feb027e5b 100644 --- a/docs/schema/sortdirection-element-sps15xsdsearchset5.md +++ b/docs/schema/sortdirection-element-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "SortDirection element (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 05a1d58c-45b8-9d5b-5844-f2c792607c8c -description: "Last modified: March 09, 2015" +description: Learn more about SortDirection element (SPS15XSDSearchSet5). --- # SortDirection element (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:SortDirection
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Element type** |tns:SortDirection | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query | +|**Schema file** |schema_Microsoft.Office.Server.Search.Query.xsd | + ## Definition ```XML @@ -33,18 +32,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/sortdirection-simpletype-sps15xsdsearchset5.md b/docs/schema/sortdirection-simpletype-sps15xsdsearchset5.md index 3fb51eb1e..6f07a008b 100644 --- a/docs/schema/sortdirection-simpletype-sps15xsdsearchset5.md +++ b/docs/schema/sortdirection-simpletype-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "SortDirection simpleType (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f2af8113-f7b9-9705-7434-285c87ccf072 -description: "Last modified: March 09, 2015" +description: Learn more about SortDirection simpleType (SPS15XSDSearchSet5). --- # SortDirection simpleType (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Base type**
    |xs:string
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Base type** |xs:string | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query | +|**Schema file** |schema_Microsoft.Office.Server.Search.Query.xsd | + ## Definition ```XML @@ -44,5 +43,3 @@ description: "Last modified: March 09, 2015" |Ascending
    || |Descending
    || |FQLFormula
    || - - diff --git a/docs/schema/source-complextype-sps15xsdsearchset1.md b/docs/schema/source-complextype-sps15xsdsearchset1.md index cb2c03135..ed1f64acf 100644 --- a/docs/schema/source-complextype-sps15xsdsearchset1.md +++ b/docs/schema/source-complextype-sps15xsdsearchset1.md @@ -1,27 +1,26 @@ --- title: "Source complexType (SPS15XSDSearchSet1)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: fce44c4e-eaab-e94b-bff7-c08795fb5cc1 -description: "Last modified: March 09, 2015" +description: Learn more about Source complexType (SPS15XSDSearchSet1). --- # Source complexType (SPS15XSDSearchSet1) **Applies to:** SharePoint Server 2013 - + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.Query.xsd
    | -|**Extension base**
    |None
    | - +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.Query.xsd | +|**Extension base** |None | + ## Definition ```XML @@ -50,8 +49,8 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| @@ -72,9 +71,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** |[Owner](owner-element-source-complextypesps15xsdsearchset1.md)
    |q2:SearchObjectOwner
    || |[ProviderId](providerid-element-source-complextypesps15xsdsearchset1.md)
    |ser:guid
    || |[QueryTransform](querytransform-element-source-complextypesps15xsdsearchset1.md)
    |q3:QueryTransform
    || - + ### Attributes None. - - diff --git a/docs/schema/source-element-arrayofsource-complextypesps15xsdsearchset1.md b/docs/schema/source-element-arrayofsource-complextypesps15xsdsearchset1.md index 6776c5904..522d8cd79 100644 --- a/docs/schema/source-element-arrayofsource-complextypesps15xsdsearchset1.md +++ b/docs/schema/source-element-arrayofsource-complextypesps15xsdsearchset1.md @@ -1,27 +1,26 @@ --- title: "Source element (ArrayOfSource complexType) (SPS15XSDSearchSet1)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4d9e36f1-9104-5129-350f-08e2476de6b8 -description: "Last modified: March 09, 2015" +description: Learn more about Source element (ArrayOfSource complexType) (SPS15XSDSearchSet1). --- # Source element (ArrayOfSource complexType) (SPS15XSDSearchSet1) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:Source
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.Query.xsd
    | - +|**Element type** |tns:Source | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.Query.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/source-element-sps15xsdsearchset1.md b/docs/schema/source-element-sps15xsdsearchset1.md index 522eb17ba..417aa2910 100644 --- a/docs/schema/source-element-sps15xsdsearchset1.md +++ b/docs/schema/source-element-sps15xsdsearchset1.md @@ -1,27 +1,26 @@ --- title: "Source element (SPS15XSDSearchSet1)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 5a96f03b-674f-b27e-a375-6199311bc086 -description: "Last modified: March 09, 2015" +description: Learn more about Source element (SPS15XSDSearchSet1). --- # Source element (SPS15XSDSearchSet1) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |tns:Source
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.Query.xsd
    | - +|**Element type** |tns:Source | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration.Query | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.Query.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/sourceentity-element-in-association-bdcmetadata-schema.md b/docs/schema/sourceentity-element-in-association-bdcmetadata-schema.md index ae90341bb..bcb4a1d3e 100644 --- a/docs/schema/sourceentity-element-in-association-bdcmetadata-schema.md +++ b/docs/schema/sourceentity-element-in-association-bdcmetadata-schema.md @@ -1,17 +1,17 @@ --- title: SourceEntity Element in Association +description: SourceEntity Element in Association specifies a source external content type of an Association. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference f1_keywords: - VS.SharePointTools.BDC.SourceEntity -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 19fb5f38-4e85-7fb0-2562-281b9a9ffbef --- -# SourceEntity Element in Association +# SourceEntity Element in Association (BDCMetadata Schema) @@ -66,29 +66,6 @@ None. ### Parent elements - ---- - - - - - - - - - - - - -

    Element

    Description

    Association Element in MethodInstances (BDCMetadata Schema)

    The **Association** that contains this element.

    - - - - - - - - +| Element | Description | +| --- | --- | +| [Association Element in MethodInstances (BDCMetadata Schema)](association-element-in-methodinstances-bdcmetadata-schema.md) | The **Association** that contains this element. | diff --git a/docs/schema/sourceid-element-events.md b/docs/schema/sourceid-element-events.md index 4f209a518..c2e135403 100644 --- a/docs/schema/sourceid-element-events.md +++ b/docs/schema/sourceid-element-events.md @@ -1,11 +1,11 @@ --- title: SourceId Element (Events) +description: SourceId Element (Events) specifies the unique identifier of the source for the event receiver. manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 6bc9861e-3dbc-4c7f-b691-26ae54d0f106 --- @@ -59,11 +59,3 @@ None - - - - - - - - diff --git a/docs/schema/sourceid-element-resultitemtype-complextypesps15xsdsearchset2.md b/docs/schema/sourceid-element-resultitemtype-complextypesps15xsdsearchset2.md index 0b73a0333..1e6a1ba60 100644 --- a/docs/schema/sourceid-element-resultitemtype-complextypesps15xsdsearchset2.md +++ b/docs/schema/sourceid-element-resultitemtype-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SourceID element (ResultItemType complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8c1cb11e-8985-be15-7ef7-e298aa61e6c2 -description: "Last modified: March 09, 2015" +description: Learn more about SourceID element (ResultItemType complexType) (SPS15XSDSearchSet2). --- # SourceID element (ResultItemType complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |ser:guid
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |ser:guid | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/sources-element-searchqueryconfigurationsettings-complextypesps15xsdsearchset3.md b/docs/schema/sources-element-searchqueryconfigurationsettings-complextypesps15xsdsearchset3.md index 9e52a533e..d961c00f4 100644 --- a/docs/schema/sources-element-searchqueryconfigurationsettings-complextypesps15xsdsearchset3.md +++ b/docs/schema/sources-element-searchqueryconfigurationsettings-complextypesps15xsdsearchset3.md @@ -1,27 +1,26 @@ --- title: "Sources element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes Sources element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3) and includes information on elements and attributes. ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b7e68d91-64dc-7ae8-7efc-4a8ef2cf085b -description: "Last modified: March 09, 2015" --- # Sources element (SearchQueryConfigurationSettings complexType) (SPS15XSDSearchSet3) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |q5:ArrayOfSource
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Portability
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Portability.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/sourcetype-element-events.md b/docs/schema/sourcetype-element-events.md index e21618298..ee321509a 100644 --- a/docs/schema/sourcetype-element-events.md +++ b/docs/schema/sourcetype-element-events.md @@ -1,11 +1,11 @@ --- title: SourceType Element (Events) manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SSourceType Element (Events) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: cc686ae9-1865-4ece-aa9f-cbab6c810a3a --- @@ -59,11 +59,3 @@ None - - - - - - - - diff --git a/docs/schema/spbasetype-simple-type-deploymentmanifest.md b/docs/schema/spbasetype-simple-type-deploymentmanifest.md index 22377ee1a..b614e8642 100644 --- a/docs/schema/spbasetype-simple-type-deploymentmanifest.md +++ b/docs/schema/spbasetype-simple-type-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "SPBaseType Simple Type (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPBaseType Simple Type (DeploymentManifest) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a8fbc636-ac36-4046-b3ab-d604d38ccaaf -description: "Last modified: March 09, 2015" --- # SPBaseType Simple Type (DeploymentManifest) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies the base type for a SharePoint list item. ## Definition @@ -44,8 +43,7 @@ Specifies the base type for a SharePoint list item. |**DiscussionBoard**
    |Indicates the type is provided for backward compatibility with lists derived from the **DiscussionBoard** base type, but is no longer supported. The current version of SharePoint Foundation uses the **GenericList** base type to support a discussion board template.
    | |**Survey**
    |Indicates the type is a survey list.
    | |**Issue**
    |Indicates the type is an issue-tracking list.
    | - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/spdeploymentobjecttype-simple-type-deploymentexportsettings.md b/docs/schema/spdeploymentobjecttype-simple-type-deploymentexportsettings.md index c19e5ddd9..3907f3404 100644 --- a/docs/schema/spdeploymentobjecttype-simple-type-deploymentexportsettings.md +++ b/docs/schema/spdeploymentobjecttype-simple-type-deploymentexportsettings.md @@ -1,20 +1,19 @@ --- title: "SPDeploymentObjectType Simple Type (DeploymentExportSettings)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPDeploymentObjectType Simple Type (DeploymentExportSettings) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1e83dd6b-2946-45d7-8bd3-29c8e6ad6ddd -description: "Last modified: March 09, 2015" --- # SPDeploymentObjectType Simple Type (DeploymentExportSettings) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Provides values for the **Type** attribute on the [DeploymentObject Element (DeploymentExportSettings)](deploymentobject-element-deploymentexportsettings.md). + +Provides values for the **Type** attribute on the [DeploymentObject Element (DeploymentExportSettings)](deploymentobject-element-deploymentexportsettings.md). ## Definition @@ -22,9 +21,9 @@ Provides values for the **Type** attribute on the [DeploymentObject Element (Dep - + - + @@ -42,13 +41,12 @@ Provides values for the **Type** attribute on the [DeploymentObject Element (Dep |**List**
    |Specifies a list or document library (**SPList**) object type.
    | |**ListItem**
    |Specifies a list item (**SPListItem**) object type.
    | |**File**
    |Specifies a file (**SPFile**) object type.
    | - + ### Remarks -The **SPDeploymentObjectType** simple type values specify the object type for Windows SharePoint Services 3.0 top-level objects marked for export to the content migration package. - +The **SPDeploymentObjectType** simple type values specify the object type for Windows SharePoint Services 3.0 top-level objects marked for export to the content migration package. + ## See also - [DeploymentExportSettings Schema](deploymentexportsettings-schema.md) - [DeploymentObject Element (DeploymentExportSettings)](deploymentobject-element-deploymentexportsettings.md) - diff --git a/docs/schema/spdeploymentobjecttype-simple-type-deploymentrootobjectmap.md b/docs/schema/spdeploymentobjecttype-simple-type-deploymentrootobjectmap.md index 73acd70ce..077f0a442 100644 --- a/docs/schema/spdeploymentobjecttype-simple-type-deploymentrootobjectmap.md +++ b/docs/schema/spdeploymentobjecttype-simple-type-deploymentrootobjectmap.md @@ -1,20 +1,19 @@ --- title: "SPDeploymentObjectType Simple Type (DeploymentRootObjectMap)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPDeploymentObjectType Simple Type (DeploymentRootObjectMap) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 484f7cea-b9f7-4545-9257-99509f87d1cc -description: "Last modified: March 09, 2015" --- # SPDeploymentObjectType Simple Type (DeploymentRootObjectMap) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Provides values for the **Type** attribute on the [RootObject Element (DeploymentRootObjectMap)](rootobject-element-deploymentrootobjectmap.md). + +Provides values for the **Type** attribute on the [RootObject Element (DeploymentRootObjectMap)](rootobject-element-deploymentrootobjectmap.md). ## Definition @@ -24,7 +23,7 @@ Provides values for the **Type** attribute on the [RootObject Element (Deploymen - + @@ -42,13 +41,12 @@ Provides values for the **Type** attribute on the [RootObject Element (Deploymen |**List**
    |Specifies that the root object type is a SharePoint Foundation list or document library (**SPList**).
    | |**ListItem**
    |Specifies that the root object type is a SharePoint Foundation list item (**SPListItem**).
    | |**File**
    |Specifies that the root object type is a SharePoint Foundation file (**SPFile**).
    | - + ### Remarks -The **SPDeploymentObjectType** simple type value specifies the object type of the root object specified in the root object map. - +The **SPDeploymentObjectType** simple type value specifies the object type of the root object specified in the root object map. + ## See also - [DeploymentRootObjectMap Schema](deploymentrootobjectmap-schema.md) - [RootObject Element (DeploymentRootObjectMap)](rootobject-element-deploymentrootobjectmap.md) - diff --git a/docs/schema/spdeploymentobjecttype-simple-type-deploymentsystemdata.md b/docs/schema/spdeploymentobjecttype-simple-type-deploymentsystemdata.md index 0b0e903aa..f8d8bf4cd 100644 --- a/docs/schema/spdeploymentobjecttype-simple-type-deploymentsystemdata.md +++ b/docs/schema/spdeploymentobjecttype-simple-type-deploymentsystemdata.md @@ -1,19 +1,18 @@ --- title: "SPDeploymentObjectType Simple Type (DeploymentSystemData)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPDeploymentObjectType Simple Type (DeploymentSystemData) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 065907dd-ebca-4332-9bc1-65bace98eba3 -description: "Last modified: March 09, 2015" --- # SPDeploymentObjectType Simple Type (DeploymentSystemData) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Provides values for the **Type** attribute on the [SystemObject element](systemobject-element-deploymentsystemdata.md). The value specifies the system object type. ## Definition @@ -24,7 +23,7 @@ Provides values for the **Type** attribute on the [SystemObject element](systemo - + @@ -42,9 +41,8 @@ Provides values for the **Type** attribute on the [SystemObject element](systemo |**List**
    |Specifies that the system object type is a SharePoint Foundation list (**SPList**).
    | |**ListItem**
    |Specifies that the system object type is a SharePoint Foundation list item (**SPListItem**).
    | |**File**
    |Specifies that the system object type is a SharePoint Foundation file (**SPFile**).
    | - + ## See also - [DeploymentSystemData Schema](deploymentsystemdata-schema.md) - [SystemObject Element (DeploymentSystemData)](systemobject-element-deploymentsystemdata.md) - diff --git a/docs/schema/spdictionaryentryaccess-simple-type-deploymentmanifest.md b/docs/schema/spdictionaryentryaccess-simple-type-deploymentmanifest.md index 2eac3f577..6188ddbf2 100644 --- a/docs/schema/spdictionaryentryaccess-simple-type-deploymentmanifest.md +++ b/docs/schema/spdictionaryentryaccess-simple-type-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "SPDictionaryEntryAccess Simple Type (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPDictionaryEntryAccess Simple Type (DeploymentManifest) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ce710a54-2e61-419c-81c4-66fde5557cf7 -description: "Last modified: March 09, 2015" --- # SPDictionaryEntryAccess Simple Type (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Indicates the type of access granted to the specified field value. ## Definition @@ -34,12 +33,11 @@ Indicates the type of access granted to the specified field value. |:-----|:-----| |**ReadOnly**
    |Specifies a read-only field value.
    | |**ReadWrite**
    |Specifies a writeable field value.
    | - + ### Remarks This enumeration functions as a system-level flag to specify whether the field value is rendered in the Web UI. - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/spdictionaryentryvaluetype-simple-type-deploymentmanifest.md b/docs/schema/spdictionaryentryvaluetype-simple-type-deploymentmanifest.md index 622086a34..7ac331fed 100644 --- a/docs/schema/spdictionaryentryvaluetype-simple-type-deploymentmanifest.md +++ b/docs/schema/spdictionaryentryvaluetype-simple-type-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "SPDictionaryEntryValueType Simple Type (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPDictionaryEntryValueType Simple Type (DeploymentManifest) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: e0d2ac1f-b516-48f3-b291-ad32d1f2ab39 -description: "Last modified: March 09, 2015" --- # SPDictionaryEntryValueType Simple Type (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Indicates the data type of the specified field value. ## Definition @@ -50,8 +49,7 @@ Indicates the data type of the specified field value. |**Double**
    |Treats as a **Double** data type.
    | |**LongText**
    |Treats as a **String** data type.
    | |**Empty**
    |No value.
    | - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/spellcheckmode-element-sps15xsdsearchset5.md b/docs/schema/spellcheckmode-element-sps15xsdsearchset5.md index 71228d2eb..2a48ee48d 100644 --- a/docs/schema/spellcheckmode-element-sps15xsdsearchset5.md +++ b/docs/schema/spellcheckmode-element-sps15xsdsearchset5.md @@ -1,27 +1,26 @@ --- title: "SpellcheckMode element (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SpellcheckMode element (SPS15XSDSearchSet5) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ab677c35-51c4-f378-f372-2210f8107d2e -description: "Last modified: March 09, 2015" --- # SpellcheckMode element (SPS15XSDSearchSet5) **Applies to:** SharePoint Server 2013 - + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |tns:SpellcheckMode
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/spellcheckmode-simpletype-sps15xsdsearchset5.md b/docs/schema/spellcheckmode-simpletype-sps15xsdsearchset5.md index c184b637b..fc24251cd 100644 --- a/docs/schema/spellcheckmode-simpletype-sps15xsdsearchset5.md +++ b/docs/schema/spellcheckmode-simpletype-sps15xsdsearchset5.md @@ -1,29 +1,28 @@ --- title: "SpellcheckMode simpleType (SPS15XSDSearchSet5)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SpellcheckMode simpleType (SPS15XSDSearchSet5) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9184db70-e548-9918-03af-30e47585dc1e -description: "Last modified: March 09, 2015" --- # SpellcheckMode simpleType (SPS15XSDSearchSet5) - - + + **Applies to:** SharePoint Server 2013 - + ## Type information -||| +|Information|Location| |:-----|:-----| -|**Base type**
    |xs:string
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Query.xsd
    | - +|**Base type** |xs:string | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Query | +|**Schema file** |schema_Microsoft.Office.Server.Search.Query.xsd | + ## Definition ```XML @@ -41,8 +40,6 @@ description: "Last modified: March 09, 2015" |**Value**|**Description**| |:-----|:-----| -|Off
    |1
    | -|Suggest
    |2
    | -|On
    |4
    | - - +|Off |1 | +|Suggest |2 | +|On |4 | diff --git a/docs/schema/speventhosttype-simple-type-deploymentmanifest.md b/docs/schema/speventhosttype-simple-type-deploymentmanifest.md index 2eb297300..6af8ac905 100644 --- a/docs/schema/speventhosttype-simple-type-deploymentmanifest.md +++ b/docs/schema/speventhosttype-simple-type-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "SPEventHostType Simple Type (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPEventHostType Simple Type (DeploymentManifest) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 77928f8c-f509-40b9-8820-ac663487dd6f -description: "Last modified: March 09, 2015" --- # SPEventHostType Simple Type (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Specifies the object type for event hosts. ## Definition @@ -42,8 +41,7 @@ Specifies the object type for event hosts. |**ListItem**
    |SharePoint ListItem object (**SPListItem**).
    | |**ContentType**
    |SharePoint ContentType object (**SPContentType**).
    | |**Feature**
    |SharePoint Feature object (**SPFeature**).
    | - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/speventreceivertype-simple-type-deploymentmanifest.md b/docs/schema/speventreceivertype-simple-type-deploymentmanifest.md index 452df7f37..082f562a9 100644 --- a/docs/schema/speventreceivertype-simple-type-deploymentmanifest.md +++ b/docs/schema/speventreceivertype-simple-type-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "SPEventReceiverType Simple Type (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPEventReceiverType Simple Type (DeploymentManifest) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7a666a1a-62fb-4371-aa88-a89018982fee -description: "Last modified: March 09, 2015" --- # SPEventReceiverType Simple Type (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Specifies the available event receivers. ## Definition @@ -98,8 +97,7 @@ Specifies the available event receivers. |WebDeleting
    |Indicates a site is being deleted.
    | |WebMoved
    |Indicates a site was moved.
    | |WebMoving
    |Indicates a site is being moved.
    | - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/spexportmethodtype-simple-type-deploymentexportsettings.md b/docs/schema/spexportmethodtype-simple-type-deploymentexportsettings.md index c401e7551..ccb995dc9 100644 --- a/docs/schema/spexportmethodtype-simple-type-deploymentexportsettings.md +++ b/docs/schema/spexportmethodtype-simple-type-deploymentexportsettings.md @@ -1,20 +1,19 @@ --- title: "SPExportMethodType Simple Type (DeploymentExportSettings)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPExportMethodType Simple Type (DeploymentExportSettings) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: cf806690-29b1-4aea-b1ef-b4cc3550ad8f -description: "Last modified: March 09, 2015" --- # SPExportMethodType Simple Type (DeploymentExportSettings) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Provides values for the **ExportMethod** attribute on the [ExportSettings Element (DeploymentExportSettings)](exportsettings-element-deploymentexportsettings.md). + +Provides values for the **ExportMethod** attribute on the [ExportSettings Element (DeploymentExportSettings)](exportsettings-element-deploymentexportsettings.md). ## Definition @@ -34,13 +33,12 @@ Provides values for the **ExportMethod** attribute on the [ExportSettings Elemen |:-----|:-----| |**ExportAll**
    |Specifies that all export objects should be exported to the content migration package.
    | |**ExportChanges**
    |Specifies that only export objects that have changed since the last version of the content migration package should be exported.
    | - + ### Remarks -The **SPExportMethodType** simple type value specifies whether the export operation is full (all objects) or incremental (only those that have changed since the last version of the migration package). - +The **SPExportMethodType** simple type value specifies whether the export operation is full (all objects) or incremental (only those that have changed since the last version of the migration package). + ## See also - [DeploymentExportSettings Schema](deploymentexportsettings-schema.md) - [ExportSettings Element (DeploymentExportSettings)](exportsettings-element-deploymentexportsettings.md) - diff --git a/docs/schema/spfarmid-element-searchobjectowner-complextypesps15xsdsearchset2.md b/docs/schema/spfarmid-element-searchobjectowner-complextypesps15xsdsearchset2.md index bba1adf8c..f96c66d0e 100644 --- a/docs/schema/spfarmid-element-searchobjectowner-complextypesps15xsdsearchset2.md +++ b/docs/schema/spfarmid-element-searchobjectowner-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SPFarmId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPFarmId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2) and includes information on elements and attributes. ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 8bffa58b-bf76-4075-da69-8c3a55786ee9 -description: "Last modified: March 09, 2015" --- # SPFarmId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |ser:guid
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/spincludedescendents-simple-type-deploymentexportsettings.md b/docs/schema/spincludedescendents-simple-type-deploymentexportsettings.md index e9f2abc8a..6197824f6 100644 --- a/docs/schema/spincludedescendents-simple-type-deploymentexportsettings.md +++ b/docs/schema/spincludedescendents-simple-type-deploymentexportsettings.md @@ -1,20 +1,19 @@ --- title: "SPIncludeDescendents Simple Type (DeploymentExportSettings)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPIncludeDescendents Simple Type (DeploymentExportSettings) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 0b56c258-c512-419a-ac7b-4593ba543b30 -description: "Last modified: March 09, 2015" --- # SPIncludeDescendents Simple Type (DeploymentExportSettings) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Provides values for the **IncludeDescendants** attribute on the [DeploymentObject Element (DeploymentExportSettings)](deploymentobject-element-deploymentexportsettings.md). + +Provides values for the **IncludeDescendants** attribute on the [DeploymentObject Element (DeploymentExportSettings)](deploymentobject-element-deploymentexportsettings.md). ## Definition @@ -36,13 +35,12 @@ Provides values for the **IncludeDescendants** attribute on the [DeploymentObjec |**None**
    |Specifies that no descendants are included in the content migration package.
    | |**Content**
    |Specifies that only content-type descendants are included in the content migration package.
    | |**All**
    |Specifies that both content and content-type descendants are included in the content migration package.
    | - + ### Remarks The SPIncludeDescendents simple type values specify whether to include export object descendants (and if so, which ones) in the content migration package. - + ## See also - [DeploymentExportSettings Schema](deploymentexportsettings-schema.md) - [DeploymentObject Element (DeploymentExportSettings)](deploymentobject-element-deploymentexportsettings.md) - diff --git a/docs/schema/spincludesecurity-simple-type-deploymentexportsettings.md b/docs/schema/spincludesecurity-simple-type-deploymentexportsettings.md index c180b4dcf..409fe3f05 100644 --- a/docs/schema/spincludesecurity-simple-type-deploymentexportsettings.md +++ b/docs/schema/spincludesecurity-simple-type-deploymentexportsettings.md @@ -1,20 +1,19 @@ --- title: "SPIncludeSecurity Simple Type (DeploymentExportSettings)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPIncludeSecurity Simple Type (DeploymentExportSettings) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: e5fe8d3f-5010-41ad-a75e-dc40240dc870 -description: "Last modified: March 09, 2015" --- # SPIncludeSecurity Simple Type (DeploymentExportSettings) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Provides values for the **IncludeSecurity** attribute on the [ExportSettings Element (DeploymentExportSettings)](exportsettings-element-deploymentexportsettings.md). + +Provides values for the **IncludeSecurity** attribute on the [ExportSettings Element (DeploymentExportSettings)](exportsettings-element-deploymentexportsettings.md). ## Definition @@ -36,13 +35,12 @@ Provides values for the **IncludeSecurity** attribute on the [ExportSettings Ele |**None**
    |Specifies that no user or group information is migrated. (Default)
    | |**WssOnly**
    |Applies only Windows SharePoint Services 3.0 security settings. Includes user memberships and role assignments such as default roles, for example, Web Designer or any custom roles that extend from the default roles. The access control list (ACL) for each object is migrated. No user information defined in the DAP or LDAP servers is included.
    | |**All**
    |Applies all available Windows SharePoint Services 3.0 security settings. Includes user memberships and role assignments such as default roles, for example, Web Designer or any custom roles that extend from the default roles. The ACL for each object is migrated. In addition, user information defined in the DAP or LDAP servers is included.
    | - + ### Remarks The values specify the user and group information that is included during an export operation. - + ## See also - [DeploymentExportSettings Schema](deploymentexportsettings-schema.md) - [ExportSettings Element (DeploymentExportSettings)](exportsettings-element-deploymentexportsettings.md) - diff --git a/docs/schema/spincludeversions-simple-type-deploymentexportsettings.md b/docs/schema/spincludeversions-simple-type-deploymentexportsettings.md index 1e851b5f8..881f4ca33 100644 --- a/docs/schema/spincludeversions-simple-type-deploymentexportsettings.md +++ b/docs/schema/spincludeversions-simple-type-deploymentexportsettings.md @@ -1,20 +1,19 @@ --- title: "SPIncludeVersions Simple Type (DeploymentExportSettings)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPIncludeVersions Simple Type (DeploymentExportSettings) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ee0fc690-0494-4f2b-8f52-b34457e07a7e -description: "Last modified: March 09, 2015" --- # SPIncludeVersions Simple Type (DeploymentExportSettings) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Provides values for the **IncludeVersions** attribute on the [ExportSettings Element (DeploymentExportSettings)](exportsettings-element-deploymentexportsettings.md). + +Provides values for the **IncludeVersions** attribute on the [ExportSettings Element (DeploymentExportSettings)](exportsettings-element-deploymentexportsettings.md). ## Definition @@ -38,13 +37,12 @@ Provides values for the **IncludeVersions** attribute on the [ExportSettings Ele |**CurrentVersion**
    |Specifies the current version of the export object.
    | |**LastMajorAndMinor**
    |Specifies the version of the export object using both major and minor version numbers.
    | |**All**
    |Specifies that all available versions of the export object will be included.
    | - + ### Remarks The value of the SPIncludeVersions simple type specifies which export object version to include in the content migration package. - + ## See also - [DeploymentExportSettings Schema](deploymentexportsettings-schema.md) - [ExportSettings Element (DeploymentExportSettings)](exportsettings-element-deploymentexportsettings.md) - diff --git a/docs/schema/spinner-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/spinner-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index b9881e450..8f3a9a83b 100644 --- a/docs/schema/spinner-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/spinner-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,36 +1,36 @@ --- title: Spinner element (CommandUIDefinitionType complexType) manager: soliver -ms.date: 9/16/2015 +ms.date: 06/13/2022 +description: Describes Spinner element (CommandUIDefinitionType complexType)) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2db6c755-3082-82a7-f12a-608342829a10 --- -# Spinner element (CommandUIDefinitionType complexType) +# Spinner element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Information | Location | |---|---| | **Element type** | SpinnerType | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | | **Schema file** | apphostwebfeatures.xsd | -## Definition +## Definition ```XML ``` -## Elements and attributes +## Elements and attributes If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. @@ -67,14 +67,6 @@ None. None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/spinner-element.md b/docs/schema/spinner-element.md index ec910650d..bd8a0477a 100644 --- a/docs/schema/spinner-element.md +++ b/docs/schema/spinner-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines a spinner control. # Spinner element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a spinner control. - + ```XML |Optional. The name or abbreviation for the default [Unit](unit-element-spinner.md).
    | |**DefaultValue**
    |Optional. Specifies the initial numeric value that is displayed in the control.
    | |**Id**
    |Required. A string that identifies the control.
    | -|**ImeEnabled**
    |Optional. **TRUE** to set the [Input Method Editor (IME)](https://docs.microsoft.com/windows/desktop/dxtecharts/installing-and-using-input-method-editors) to the **active** state. The default is **FALSE**.
    | +|**ImeEnabled**
    |Optional. **TRUE** to set the [Input Method Editor (IME)](/windows/desktop/dxtecharts/installing-and-using-input-method-editors) to the **active** state. The default is **FALSE**.
    | |**MultiplierInterval**
    |Optional. Specifies a factor by which to increase the speed of incrementing or decrementing the value when focus is maintained on the up or down arrow.
    | |**QueryCommand**
    |Optional. The name of the command to execute when polling for state information.
    | |**Sequence**
    |Optional. An integer that specifies the order of placement among sibling XML nodes.
    | @@ -73,19 +72,17 @@ The following sections describe attributes, child elements, and parent elements. |**ToolTipDescription**
    |Optional. The text that appears in the body of the tooltip.
    | |**ToolTipHelpKeyWord**
    |Optional. The keyword that is used by context-sensitive Help.
    | |**ToolTipShortcutKey**
    |Optional. The text to display for the shortcut key in the tooltip. For example, if the shortcut key for the control is Alt+J, the value for this attribute is "Alt+J". The tooltip displays the text for the shortcut key in parentheses after the tooltip title: "(Alt+J)".
    | - + ### Child elements - [Unit](unit-element-spinner.md) - + ### Parent elements -- [CommandUIDefinition](commanduidefinition-element.md) -- [Controls](controls-element-group.md) - +- [CommandUIDefinition](commanduidefinition-element.md) +- [Controls](controls-element-group.md) + ### Occurrences - Minimum: 0 -- Maximum: unbounded - - +- Maximum: unbounded diff --git a/docs/schema/splisttemplatetype-simple-type-deploymentmanifest.md b/docs/schema/splisttemplatetype-simple-type-deploymentmanifest.md index 90fb87fb1..33c057519 100644 --- a/docs/schema/splisttemplatetype-simple-type-deploymentmanifest.md +++ b/docs/schema/splisttemplatetype-simple-type-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "SPListTemplateType Simple Type (DeploymentManifest)" manager: soliver -ms.date: 11/16/2014 +ms.date: 06/13/2022 +description: Describes SPListTemplateType Simple Type (DeploymentManifest) and includes information on type and additional remarks. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 089ff2a0-b7ff-4893-b243-43f76ceb5a74 -description: "Last modified: July 15, 2011" --- # SPListTemplateType Simple Type (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Establishes a base for instantiating list templates. ## Definition @@ -28,13 +27,12 @@ Establishes a base for instantiating list templates. ## Type xs:string - + ### Remarks This type represents the [SPListTemplateType](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPListTemplateType.aspx). However, it is not structured in the schema as an enumeration because it is an extensible type and can accommodate list types other than those enumerated in **SPListTemplateType**. - + ## See also - [SPListTemplateType](https://msdn.microsoft.com/library/Microsoft.SharePoint.SPListTemplateType.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/splitbutton-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/splitbutton-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index 03a891193..ea6539e4b 100644 --- a/docs/schema/splitbutton-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/splitbutton-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,30 +1,30 @@ --- title: SplitButton element (CommandUIDefinitionType complexType) manager: soliver -ms.date: 9/16/2015 +ms.date: 06/13/2022 +description: Describes SplitButton element (CommandUIDefinitionType complexType) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: bd9faa8b-96e0-6f8d-db8c-cf833dde228f --- -# SplitButton element (CommandUIDefinitionType complexType) +# SplitButton element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Information | Location | |---|---| | **Element type** | SplitButtonTypes | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | | **Schema file** | apphostwebfeatures.xsd | -## Definition +## Definition ```XML @@ -67,14 +67,6 @@ None. None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/splitbutton-element.md b/docs/schema/splitbutton-element.md index 2f2082553..a6430ed14 100644 --- a/docs/schema/splitbutton-element.md +++ b/docs/schema/splitbutton-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines a control that combines a button and a drop-down menu. # SplitButton element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a control that combines a button and a drop-down menu. - + ```XML |Optional. The keyword that is used by context-sensitive Help.
    | |**ToolTipSelectedItemTitle**
    |Optional. The title of the tooltip that appears for the selected item.
    | |**ToolTipShortcutKey**
    |Optional. The text to display for the shortcut key in the tooltip. For example, if the shortcut key for the control is Alt+J, the value for this attribute is "Alt+J". The tooltip displays the text for the shortcut key in parentheses after the tooltip title: "(Alt+J)".
    | - + ### Child elements - [Menu](menu-element.md) - + ### Parent elements -- [CommandUIDefinition](commanduidefinition-element.md) -- [Controls](controls-element-group.md) - +- [CommandUIDefinition](commanduidefinition-element.md) +- [Controls](controls-element-group.md) + ### Occurrences - Minimum: 0 -- Maximum: unbounded - - +- Maximum: unbounded diff --git a/docs/schema/spmetal-parameters-schema.md b/docs/schema/spmetal-parameters-schema.md index f83ded39c..7efac81af 100644 --- a/docs/schema/spmetal-parameters-schema.md +++ b/docs/schema/spmetal-parameters-schema.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_type: - schema ms.assetid: 221ba799-9d7b-4e3a-8859-41d86176e1c8 @@ -15,8 +14,8 @@ description: The SPMetal Parameters XML is used to override certain aspects of t # SPMetal Parameters schema **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -The SPMetal Parameters XML is used to override certain aspects of the default behavior of SPMetal, especially with regard to what content database entities are included in the entity classes that the tool generates. + +The SPMetal Parameters XML is used to override certain aspects of the default behavior of SPMetal, especially with regard to what content database entities are included in the entity classes that the tool generates. For more information about how the elements are used, see: @@ -24,38 +23,35 @@ For more information about how the elements are used, see: - [How to: Use SPMetal](https://msdn.microsoft.com/library/bfeb17f4-9cee-4008-bfb4-8e22e3acae1c%28Office.15%29.aspx) - [SPMetal Default Code Generation Rules](https://msdn.microsoft.com/library/873ac65e-425e-40f3-9ef6-753d3cda1436%28Office.15%29.aspx) - [SPMetal](https://msdn.microsoft.com/library/bbb79c7c-a994-4ef9-9d43-8fc046dc508b%28Office.15%29.aspx) - + ## Elements [Web](web-spmetal.md) - + - [ContentType](contenttype-spmetal.md) - + - [Column](column-spmetal.md) - + - [ExcludeColumn](excludecolumn-spmetal.md) - + - [ExcludeOtherColumns](excludeothercolumns-spmetal.md) - + - [IncludeHiddenColumns](includehiddencolumns-spmetal.md) - + - [ExcludeContentType](excludecontenttype-spmetal.md) - + - [ExcludeOtherContentTypes](excludeothercontenttypes-spmetal.md) - + - [IncludeHiddenContentTypes](includehiddencontenttypes-spmetal.md) - + - [List](list-spmetal.md) - + - [ContentType](contenttype-spmetal.md) - + - [ExcludeContentType](excludecontenttype-spmetal.md) - + - [ExcludeList](excludelist-spmetal.md) - -- [ExcludeOtherLists](excludeotherlists-spmetal.md) - -- [IncludeHiddenLists](includehiddenlists-spmetal.md) - +- [ExcludeOtherLists](excludeotherlists-spmetal.md) +- [IncludeHiddenLists](includehiddenlists-spmetal.md) diff --git a/docs/schema/spmoderationstatustype-simple-type-deploymentmanifest.md b/docs/schema/spmoderationstatustype-simple-type-deploymentmanifest.md index 4ebb19ef4..d9097ff9e 100644 --- a/docs/schema/spmoderationstatustype-simple-type-deploymentmanifest.md +++ b/docs/schema/spmoderationstatustype-simple-type-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "SPModerationStatusType Simple Type (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPModerationStatusType Simple Type (DeploymentManifest) and includes information on enumeration values and additional remarks. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 4f48e808-aa9d-4ea5-8c3e-94024f9f1590 -description: "Last modified: March 09, 2015" --- # SPModerationStatusType Simple Type (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Specifies the document status for a list item in a Windows SharePoint Services 3.0 list or document library version collection. ## Definition @@ -40,13 +39,12 @@ Specifies the document status for a list item in a Windows SharePoint Services 3 |**Pending**
    |Indicates that a specified list item is pending. The decision about displaying the item in public views of the list or document library is pending.
    | |**Draft**
    |Indicates that a specified list item is a draft. The item minor version is being edited and is not ready for approval.
    | |**Scheduled**
    |Indicates that a specified list item is scheduled. The decision about displaying the item in public views of list or document library is pending and will be processed by a timer service.
    | - + ### Remarks -This type is relevant only if the list has the **Moderation** property enabled. - +This type is relevant only if the list has the **Moderation** property enabled. + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - [ListItem Element (DeploymentManifest - SPGenericObject)](listitem-element-deploymentmanifestspgenericobject.md) - diff --git a/docs/schema/spobject-element-deploymentmanifest.md b/docs/schema/spobject-element-deploymentmanifest.md index 9f728151e..cc314802b 100644 --- a/docs/schema/spobject-element-deploymentmanifest.md +++ b/docs/schema/spobject-element-deploymentmanifest.md @@ -1,28 +1,27 @@ --- title: "SPObject Element (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPObject Element (DeploymentManifest) and includes information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1bdc823e-d556-4273-a091-92d41d9d9ace -description: "Last modified: March 09, 2015" --- # SPObject Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Represents an instance of a top-level Windows SharePoint Services 3.0 object (**SPGenericObject**). ## Definition ```XML DECLARATION - USAGE @@ -43,8 +42,8 @@ USAGE ## Type -**SPGenericObject** ([Object](https://msdn.microsoft.com/library/System.Object.aspx)) - +**SPGenericObject** ([Object](https://msdn.microsoft.com/library/System.Object.aspx)) + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -62,7 +61,7 @@ The following sections describe attributes, child elements, and parent elements. |**ParentWebUrl**
    |xs:string
    |Optional. URL to the parent website.
    | |**ContenTypeId**
    |xs:string
    |Optional. Specifies the object content type.
    | |**Url**
    |xs:string
    |Optional. URL to the object.
    | - + ### Child elements - [Site Element (DeploymentManifest)](site-element-deploymentmanifest.md) @@ -86,14 +85,13 @@ The following sections describe attributes, child elements, and parent elements. - [RoleX Element (DeploymentManifest)](rolex-element-deploymentmanifest.md) - [RoleAssignments Element (DeploymentManifest)](roleassignments-element-deploymentmanifest.md) - [Feature Element (DeploymentManifest)](feature-element-deploymentmanifest.md) - + ### Parent elements - [SPObjects Element (DeploymentManifest)](spobjects-element-deploymentmanifest.md) - + ## See also - [SPDeploymentObject](https://msdn.microsoft.com/library/Microsoft.SharePoint.Deployment.SPDeploymentObject.aspx) - [Object](https://msdn.microsoft.com/library/System.Object.aspx) - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/spobjects-element-deploymentmanifest.md b/docs/schema/spobjects-element-deploymentmanifest.md index 1db76765a..eb4b537f1 100644 --- a/docs/schema/spobjects-element-deploymentmanifest.md +++ b/docs/schema/spobjects-element-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "SPObjects Element (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPObjects Element (DeploymentManifest) and includes information on type, elements, and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: af7fcfa9-22c1-4600-942f-b9a0419d0b65 -description: "Last modified: March 09, 2015" --- # SPObjects Element (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Represents a collection of top-level Windows SharePoint Services 3.0 objects. ## Definition @@ -33,7 +32,7 @@ USAGE ## Type **SPGenericObjectCollection** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -41,20 +40,19 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [SPObject Element (DeploymentManifest)](spobject-element-deploymentmanifest.md) - + ### Parent elements None - + ### Remarks -The **SPObjects** element is the root element of the DeploymentManifest.xsd schema and therefore has no parent element. - +The **SPObjects** element is the root element of the DeploymentManifest.xsd schema and therefore has no parent element. + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/spobjecttype-simple-type-deploymentmanifest.md b/docs/schema/spobjecttype-simple-type-deploymentmanifest.md index bfe88c5d7..614826073 100644 --- a/docs/schema/spobjecttype-simple-type-deploymentmanifest.md +++ b/docs/schema/spobjecttype-simple-type-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "SPObjectType Simple Type (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPObjectType Simple Type (DeploymentManifest) and provides values for all top-level serialized SharePoint object types. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 68fee905-0ee5-41c6-ad8a-f7193baf5dbb -description: "Last modified: March 09, 2015" --- # SPObjectType Simple Type (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Provides values for all top-level serialized SharePoint object types. ## Definition @@ -74,8 +73,7 @@ Provides values for all top-level serialized SharePoint object types. |**DeploymentRoleAssignmentX**
    |Specifies that a SharePoint object is of type **DeploymentRoleAssignmentX**.
    | |**DeploymentFieldTemplate**
    |Specifies that a SharePoint object is of type **DeploymentFieldTemplate**.
    | |**SPFeature**
    |Specifies that a SharePoint object is of type **SPFeature**.
    | - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/sprequirementobjecttype-simple-type-deploymentrequirements.md b/docs/schema/sprequirementobjecttype-simple-type-deploymentrequirements.md index a176729af..36d5f6711 100644 --- a/docs/schema/sprequirementobjecttype-simple-type-deploymentrequirements.md +++ b/docs/schema/sprequirementobjecttype-simple-type-deploymentrequirements.md @@ -1,19 +1,18 @@ --- title: "SPRequirementObjectType Simple Type (DeploymentRequirements)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPRequirementObjectType Simple Type (DeploymentRequirements) and provides values for the Type attribute on the Requirement Element. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 978bd557-f853-42ea-b1c0-55d5a59983af -description: "Last modified: March 09, 2015" --- # SPRequirementObjectType Simple Type (DeploymentRequirements) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Provides values for the **Type** attribute on the [Requirement Element](requirement-element-deploymentrequirements.md). The value specifies the object type of the specified deployment requirement. ## Definition @@ -38,9 +37,8 @@ Provides values for the **Type** attribute on the [Requirement Element](requirem |**WebTemplate**
    |Specifies that the requirement object type is a Web template (**SPWebTemplate**).
    | |**WebPart**
    |Specifies that the requirement object type is a web part (**SPWebPart**).
    | |**Language**
    |Specifies that the requirement object type is a language pack.
    | - + ## See also - [DeploymentRequirements Schema](deploymentrequirements-schema.md) - [Requirement Element (DeploymentRequirements)](requirement-element-deploymentrequirements.md) - diff --git a/docs/schema/sps15xsdsearchset1.md b/docs/schema/sps15xsdsearchset1.md index 62db819dd..6e1f1c27c 100644 --- a/docs/schema/sps15xsdsearchset1.md +++ b/docs/schema/sps15xsdsearchset1.md @@ -4,22 +4,19 @@ manager: arnek ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: c265497c-bb29-8191-f9bf-1452de82e513 description: Specifies XML that represents result sources. --- # SPS15XSDSearchSet1 - + **Applies to:** SharePoint Server 2013 - -The **SPS15XSDSearchSet1** schema specifies XML that represents result sources. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. + +The **SPS15XSDSearchSet1** schema specifies XML that represents result sources. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. - [Schema map (SPS15XSDSearchSet1)](schema-map-sps15xsdsearchset1.md) - + - [Elements (SPS15XSDSearchSet1)](elements-sps15xsdsearchset1.md) - -- [Types (SPS15XSDSearchSet1)](types-sps15xsdsearchset1.md) - +- [Types (SPS15XSDSearchSet1)](types-sps15xsdsearchset1.md) diff --git a/docs/schema/sps15xsdsearchset2.md b/docs/schema/sps15xsdsearchset2.md index b710eced2..a67fe0ca4 100644 --- a/docs/schema/sps15xsdsearchset2.md +++ b/docs/schema/sps15xsdsearchset2.md @@ -4,8 +4,7 @@ manager: arnek ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 32745c56-f2cf-a263-4873-cf0dd2a3c5c2 description: Specifies XML that represents administrative types and members for managing a Shared Service Provider's instance of SharePoint Enterprise Search. --- @@ -13,13 +12,11 @@ description: Specifies XML that represents administrative types and members for # SPS15XSDSearchSet2 **Applies to:** SharePoint Server 2013 - -The **SPS15XSDSearchSet2** schema specifies XML that represents administrative types and members for managing a Shared Service Provider's instance of SharePoint Enterprise Search; this includes settings such as result item types and property rules. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. + +The **SPS15XSDSearchSet2** schema specifies XML that represents administrative types and members for managing a Shared Service Provider's instance of SharePoint Enterprise Search; this includes settings such as result item types and property rules. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. - [Schema map (SPS15XSDSearchSet2)](schema-map-sps15xsdsearchset2.md) - + - [Elements (SPS15XSDSearchSet2)](elements-sps15xsdsearchset2.md) - -- [Types (SPS15XSDSearchSet2)](types-sps15xsdsearchset2.md) - +- [Types (SPS15XSDSearchSet2)](types-sps15xsdsearchset2.md) diff --git a/docs/schema/sps15xsdsearchset3.md b/docs/schema/sps15xsdsearchset3.md index 81336a82a..a649af486 100644 --- a/docs/schema/sps15xsdsearchset3.md +++ b/docs/schema/sps15xsdsearchset3.md @@ -4,8 +4,7 @@ manager: arnek ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 9b323c99-8bf6-783a-f73e-4b97bcf63732 description: Specifies XML that represents settings which include query rules, result sources, managed properties, crawled properties, and ranking models. --- @@ -13,13 +12,11 @@ description: Specifies XML that represents settings which include query rules, r # SPS15XSDSearchSet3 **Applies to:** SharePoint Server 2013 - -The **SPS15XSDSearchSet3** schema specifies XML that represents settings which include query rules, result sources, managed properties, crawled properties, and ranking models. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. + +The **SPS15XSDSearchSet3** schema specifies XML that represents settings which include query rules, result sources, managed properties, crawled properties, and ranking models. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. - [Schema map (SPS15XSDSearchSet3)](schema-map-sps15xsdsearchset3.md) - + - [Elements (SPS15XSDSearchSet3)](elements-sps15xsdsearchset3.md) - -- [Types (SPS15XSDSearchSet3)](types-sps15xsdsearchset3.md) - +- [Types (SPS15XSDSearchSet3)](types-sps15xsdsearchset3.md) diff --git a/docs/schema/sps15xsdsearchset4.md b/docs/schema/sps15xsdsearchset4.md index b065f6d76..1d1c82dcc 100644 --- a/docs/schema/sps15xsdsearchset4.md +++ b/docs/schema/sps15xsdsearchset4.md @@ -4,22 +4,19 @@ manager: arnek ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 29bdd666-77e4-7420-7f4b-542650f156e6 description: Specifies XML that represents enumerations used in other schemas. --- # SPS15XSDSearchSet4 -**Applies to:** SharePoint Server 2013 - -The **SPS15XSDSearchSet4** schema specifies XML that represents enumerations used in other schemas. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. +**Applies to:** SharePoint Server 2013 + +The **SPS15XSDSearchSet4** schema specifies XML that represents enumerations used in other schemas. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. - [Schema map (SPS15XSDSearchSet4)](schema-map-sps15xsdsearchset4.md) - + - [Elements (SPS15XSDSearchSet4)](elements-sps15xsdsearchset4.md) - -- [Types (SPS15XSDSearchSet4)](types-sps15xsdsearchset4.md) - +- [Types (SPS15XSDSearchSet4)](types-sps15xsdsearchset4.md) diff --git a/docs/schema/sps15xsdsearchset5.md b/docs/schema/sps15xsdsearchset5.md index 48bba2a9e..f9245299b 100644 --- a/docs/schema/sps15xsdsearchset5.md +++ b/docs/schema/sps15xsdsearchset5.md @@ -4,8 +4,7 @@ manager: arnek ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7fa9d436-3c1a-a6a2-8067-932ca5cb71be description: Specifies XML that represents enumerations such as ResultType, which are used in other schemas. --- @@ -13,13 +12,11 @@ description: Specifies XML that represents enumerations such as ResultType, whic # SPS15XSDSearchSet5 **Applies to:** SharePoint Server 2013 - -The **SPS15XSDSearchSet5** schema specifies XML that represents enumerations such as ResultType, which are used in other schemas. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. + +The **SPS15XSDSearchSet5** schema specifies XML that represents enumerations such as ResultType, which are used in other schemas. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. - [Schema map (SPS15XSDSearchSet5)](schema-map-sps15xsdsearchset5.md) - + - [Elements (SPS15XSDSearchSet5)](elements-sps15xsdsearchset5.md) - -- [Types (SPS15XSDSearchSet5)](types-sps15xsdsearchset5.md) - +- [Types (SPS15XSDSearchSet5)](types-sps15xsdsearchset5.md) diff --git a/docs/schema/sps15xsdsearchset6.md b/docs/schema/sps15xsdsearchset6.md index 570c4906f..0baee9ec3 100644 --- a/docs/schema/sps15xsdsearchset6.md +++ b/docs/schema/sps15xsdsearchset6.md @@ -4,8 +4,7 @@ manager: arnek ms.date: 11/16/2014 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: fdb6eb6a-0f87-8e96-ae04-ce71b4ab55f4 description: Specifies XML that represents enumerations used in the Microsoft.Office.Server.Search.Administration schema. --- @@ -13,13 +12,11 @@ description: Specifies XML that represents enumerations used in the Microsoft.Of # SPS15XSDSearchSet6 **Applies to:** SharePoint Server 2013 - -The **SPS15XSDSearchSet6** schema specifies XML that represents enumerations used in the **Microsoft.Office.Server.Search.Administration** schema. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. + +The **SPS15XSDSearchSet6** schema specifies XML that represents enumerations used in the **Microsoft.Office.Server.Search.Administration** schema. You can include the schema in your Visual Studio solution if you are working on custom solutions to create or validate search configurations. - [Schema map (SPS15XSDSearchSet6)](schema-map-sps15xsdsearchset6.md) - + - [Elements (SPS15XSDSearchSet6)](elements-sps15xsdsearchset6.md) - -- [Types (SPS15XSDSearchSet6)](types-sps15xsdsearchset6.md) - +- [Types (SPS15XSDSearchSet6)](types-sps15xsdsearchset6.md) diff --git a/docs/schema/spsiteid-element-searchobjectowner-complextypesps15xsdsearchset2.md b/docs/schema/spsiteid-element-searchobjectowner-complextypesps15xsdsearchset2.md index 4fb313d9f..fc286eb1c 100644 --- a/docs/schema/spsiteid-element-searchobjectowner-complextypesps15xsdsearchset2.md +++ b/docs/schema/spsiteid-element-searchobjectowner-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SPSiteId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPSiteId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2) and provides information on elements and attributes. ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: a0e50693-85bd-63b9-8d69-7e7a6a593f37 -description: "Last modified: March 09, 2015" --- # SPSiteId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |ser:guid
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/spsitesubscriptionid-element-searchobjectowner-complextypesps15xsdsearchset2.md b/docs/schema/spsitesubscriptionid-element-searchobjectowner-complextypesps15xsdsearchset2.md index 376d8a61c..49742bcd3 100644 --- a/docs/schema/spsitesubscriptionid-element-searchobjectowner-complextypesps15xsdsearchset2.md +++ b/docs/schema/spsitesubscriptionid-element-searchobjectowner-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SPSiteSubscriptionId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPSiteSubscriptionId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2) and provides information on elements and attributes. ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 853db6eb-fc40-fae5-577f-cc96da365f06 -description: "Last modified: March 09, 2015" --- # SPSiteSubscriptionId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| -|**Element type**
    |ser:guid
    | -|**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | -|**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - +|**Element type** |ser:guid | +|**Namespace** |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration | +|**Schema file** |schema_Microsoft.Office.Server.Search.Administration.xsd | + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/spviewscope-simple-type-deploymentmanifest.md b/docs/schema/spviewscope-simple-type-deploymentmanifest.md index 8631d367e..e355a37b8 100644 --- a/docs/schema/spviewscope-simple-type-deploymentmanifest.md +++ b/docs/schema/spviewscope-simple-type-deploymentmanifest.md @@ -1,19 +1,18 @@ --- title: "SPViewScope Simple Type (DeploymentManifest)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPSiteSubscriptionId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2) and provides values for specifying the recursive scope of a specified view into a document library. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: e636451e-751c-4783-96c5-043cd1e53c04 -description: "Last modified: March 09, 2015" --- # SPViewScope Simple Type (DeploymentManifest) -**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - +**Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 + Provides values for specifying the recursive scope of a specified view into a document library. ## Definition @@ -38,8 +37,7 @@ Provides values for specifying the recursive scope of a specified view into a do |**Recursive**
    |Shows all files of all folders.
    | |**RecursiveAll**
    |Shows all files and all subfolders of all folders.
    | |**FilesOnly**
    |Shows only the files of a specific folder.
    | - + ## See also - [DeploymentManifest Schema](deploymentmanifest-schema.md) - diff --git a/docs/schema/spwebid-element-searchobjectowner-complextypesps15xsdsearchset2.md b/docs/schema/spwebid-element-searchobjectowner-complextypesps15xsdsearchset2.md index c435a6c29..9e92e81d3 100644 --- a/docs/schema/spwebid-element-searchobjectowner-complextypesps15xsdsearchset2.md +++ b/docs/schema/spwebid-element-searchobjectowner-complextypesps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SPWebId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SPWebId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2) and provides information on elements and attributes. ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: b8371f8a-7117-0490-5236-f2294d97f3da -description: "Last modified: March 09, 2015" --- # SPWebId element (SearchObjectOwner complexType) (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |ser:guid
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/ssoauthdata-complextype-sps15xsdsearchset2.md b/docs/schema/ssoauthdata-complextype-sps15xsdsearchset2.md index a7200e806..b4e7a03fa 100644 --- a/docs/schema/ssoauthdata-complextype-sps15xsdsearchset2.md +++ b/docs/schema/ssoauthdata-complextype-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SsoAuthData complexType (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/13/2022 +description: Describes SsoAuthData complexType (SPS15XSDSearchSet2) and provides information on elements and attributes. ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: ebef7127-0d1a-1fcd-c95b-362390c259e9 -description: "Last modified: March 09, 2015" --- # SsoAuthData complexType (SPS15XSDSearchSet2) - - + + ## Type information -||| +|Information|Location| |:-----|:-----| |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | |**Extension base**
    |tns:AuthenticationData
    | - + ## Definition ```XML @@ -40,17 +39,15 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Child elements |**Element**|**Type**|**Description**| |:-----|:-----|:-----| |[_nameValuePairs](_namevaluepairs-element-ssoauthdata-complextypesps15xsdsearchset2.md)
    |q5:ArrayOfKeyValueOfstringstring
    || |[_SsoAppId](_ssoappid-element-ssoauthdata-complextypesps15xsdsearchset2.md)
    |xs:string
    || - + ### Attributes None. - - diff --git a/docs/schema/ssoauthdata-element-sps15xsdsearchset2.md b/docs/schema/ssoauthdata-element-sps15xsdsearchset2.md index 6bf3f6026..3e097eafc 100644 --- a/docs/schema/ssoauthdata-element-sps15xsdsearchset2.md +++ b/docs/schema/ssoauthdata-element-sps15xsdsearchset2.md @@ -1,27 +1,26 @@ --- title: "SsoAuthData element (SPS15XSDSearchSet2)" manager: arnek -ms.date: 3/9/2015 +ms.date: 06/14/2022 +description: Describes SsoAuthData element (SPS15XSDSearchSet2) and provides information on elements and attributes. ms.audience: ITPro ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 05859e7e-776e-c687-97c1-729e49aef94e -description: "Last modified: March 09, 2015" --- # SsoAuthData element (SPS15XSDSearchSet2) - - + + ## Element information -||| +|Information|Location| |:-----|:-----| |**Element type**
    |tns:SsoAuthData
    | |**Namespace**
    |http://schemas.datacontract.org/2004/07/Microsoft.Office.Server.Search.Administration
    | |**Schema file**
    |schema_Microsoft.Office.Server.Search.Administration.xsd
    | - + ## Definition ```XML @@ -31,18 +30,16 @@ description: "Last modified: March 09, 2015" ## Elements and attributes -If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. - +If the schema defines specific requirements, such as **sequence**, **minOccurs**, **maxOccurs**, and **choice**, see the definition section. + ### Parent elements None. - + ### Child elements None. - + ### Attributes None. - - diff --git a/docs/schema/standardtime-element-regional-settings.md b/docs/schema/standardtime-element-regional-settings.md index ea84373e3..113b954e2 100644 --- a/docs/schema/standardtime-element-regional-settings.md +++ b/docs/schema/standardtime-element-regional-settings.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Regional Settings schema api_type: @@ -17,9 +16,9 @@ description: Used in TIMEZONE.XML to contain both the bias in minutes that stand # StandardTime element (Regional Settings) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Used in TIMEZONE.XML (%ProgramFiles%\Common Files\Microsoft Shared\web server extensions\15\CONFIG) to contain both the bias in minutes that standard time for a time zone differs from Coordinated Universal Time (UTC), and the date on which standard time begins. - + ```XML @@ -37,26 +36,26 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements - [Bias](bias-element-regional-settings.md) - [Date](date-element-regional-settings.md) - + ### Parent elements - [History](history-element-regional-settings.md) - [TimeZone](timezone-element-regional-settings.md) - + ### Occurrences - Minimum: 0 -- Maximum: 1 - +- Maximum: 1 + ## Example -The following example from the file TIMEZONE.XML uses the **StandardTime** element to specify the date and time on which standard time begins for a time zone. - +The following example from the file TIMEZONE.XML uses the **StandardTime** element to specify the date and time on which standard time begins for a time zone. + ```XML 0 @@ -68,5 +67,3 @@ The following example from the file TIMEZONE.XML uses the **StandardTime** eleme ``` - - diff --git a/docs/schema/startpage-element-propertiesdefinition-complextypesharepoint-add-in-manifest.md b/docs/schema/startpage-element-propertiesdefinition-complextypesharepoint-add-in-manifest.md index aac540ad7..899ae91be 100644 --- a/docs/schema/startpage-element-propertiesdefinition-complextypesharepoint-add-in-manifest.md +++ b/docs/schema/startpage-element-propertiesdefinition-complextypesharepoint-add-in-manifest.md @@ -1,15 +1,15 @@ --- title: StartPage element (PropertiesDefinition complexType) manager: soliver -ms.date: 5/01/2020 +ms.date: 06/14/2022 +description: Describes StartPage element (PropertiesDefinition complexType) and provides information on elements and attributes. ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 3092674c-a6c3-9021-3d7e-e716562a4a4f --- -# StartPage element (PropertiesDefinition complexType) +# StartPage element (PropertiesDefinition complexType) (SharePoint Add-in Manifest) @@ -17,12 +17,12 @@ ms.assetid: 3092674c-a6c3-9021-3d7e-e716562a4a4f Typically, the URL of the page visited when the SharePoint Add-in is launched. However, it can also be the URL of a controller method or a web service method that is invoked when the add-in is launched. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. When the child element of the [AppPrincipal](appprincipal-element-appdefinition-complextypesharepoint-add-in-manifest.md) element is not [Internal](internal-element-appprincipaldefinition-complextypesharepoint-add-in-manifest.md), the page specified -in the **StartPage** element must be of a file type that supports the POST verb (in addition to GET) so that the OAuth context token can be sent on the body of the request. +in the **StartPage** element must be of a file type that supports the POST verb (in addition to GET) so that the OAuth context token can be sent on the body of the request. Common file types that are typically configured in web servers to support POST are aspx, php, and other types that support server-side code. Add-ins that have an Internal add-in principal do not use OAuth, and consequently, the start page of such add-ins can be a type that is not configured in the target web server to support POST. HTML files, for example, frequently do not support POST. @@ -40,7 +40,7 @@ If the remote web server binds the remote component to a port other than 80 when
    -The value of this element can contain certain tokens to represent information that is not known at development time. The "{StandardTokens}" above is an example. For more information, see [URL strings and tokens in SharePoint Add-ins](../sp-add-ins/url-strings-and-tokens-in-sharepoint-add-ins.md). +The value of this element can contain certain tokens to represent information that is not known at development time. The "{StandardTokens}" above is an example. For more information, see [URL strings and tokens in SharePoint Add-ins](../sp-add-ins/url-strings-and-tokens-in-sharepoint-add-ins.md). When you are debugging in Visual Studio, the Microsoft Office Developer Tools for Visual Studio use the token `~remoteWebUrl`` in place of the protocol and domain, as in the following example. @@ -59,7 +59,7 @@ If the add-in uses OAuth, the domain part of the StartPage value must exactly ma ## Element information -| | | +|Information|Location| |---|---| | **Element type** | UrlElementDefinition | | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | @@ -69,7 +69,7 @@ If the add-in uses OAuth, the domain part of the StartPage value must exactly ma ```XML  - +     ``` ## Elements and attributes diff --git a/docs/schema/statuscolumnvalue-element-workflow.md b/docs/schema/statuscolumnvalue-element-workflow.md index af2c80920..084f57d79 100644 --- a/docs/schema/statuscolumnvalue-element-workflow.md +++ b/docs/schema/statuscolumnvalue-element-workflow.md @@ -6,8 +6,7 @@ ms.audience: Developer ms.topic: reference keywords: - workflow definition schema, statuscolumnvalue element (workflow) -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d5335216-5214-4b3d-b515-5381543969aa --- @@ -66,7 +65,7 @@ The following example specifies three custom workflow status column values: **Ca Canceled Approved Rejected - + ``` @@ -75,13 +74,3 @@ The following example specifies three custom workflow status column values: **Ca - [Workflow Definitions](workflow-definitions.md) - [Workflows in Windows SharePoint Services](https://msdn.microsoft.com/library/be0888d4-20b2-4d39-bf28-2d8a71829d8e(Office.15).aspx) - [Workflow Deployment Using Features](https://msdn.microsoft.com/library/ad294f09-483d-4e87-bd19-fa37795ed558(Office.15).aspx) - - - - - - - - - - diff --git a/docs/schema/statuspageurl-element-workflow.md b/docs/schema/statuspageurl-element-workflow.md index b1367e7da..56d6be65d 100644 --- a/docs/schema/statuspageurl-element-workflow.md +++ b/docs/schema/statuspageurl-element-workflow.md @@ -1,13 +1,13 @@ --- title: StatusPageUrl Element (Workflow) manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 +description: Describes StartPage element StatusPageUrl Element (Workflow) and provides information on elements and attributes, additional remarks, and an example. ms.audience: Developer ms.topic: reference keywords: - workflow definition schema, statuspageurl element (workflow) -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 844cbf61-91bb-467b-ac38-cbfb027c9159 --- @@ -82,12 +82,3 @@ The following example specifies a custom workflow status page for the workflow. - [Workflow Definitions](workflow-definitions.md) - [Workflows in Windows SharePoint Services](https://msdn.microsoft.com/library/be0888d4-20b2-4d39-bf28-2d8a71829d8e(Office.15).aspx) - [Workflow Deployment Using Features](https://msdn.microsoft.com/library/ad294f09-483d-4e87-bd19-fa37795ed558(Office.15).aspx) - - - - - - - - - diff --git a/docs/schema/strip-element.md b/docs/schema/strip-element.md index 9b1e7eaf5..7edfac42e 100644 --- a/docs/schema/strip-element.md +++ b/docs/schema/strip-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Defines a horizontally scrolling strip that contains one or more co # Strip element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Defines a horizontally scrolling strip that contains one or more controls. - + ```XML ``` @@ -35,20 +34,20 @@ None ### Child elements - [ControlRef](controlref-element.md) - + ### Parent elements - [Row](row-element.md) - + ### Occurrences - Minimum: 0 -- Maximum: unbounded - +- Maximum: unbounded + ## Example The following example defines a strip with three controls for paging forward and backward. - + ```XML @@ -58,5 +57,3 @@ The following example defines a strip with three controls for paging forward and ``` - - diff --git a/docs/schema/subject-element-alerttemplates.md b/docs/schema/subject-element-alerttemplates.md index cebded35e..bb44400c0 100644 --- a/docs/schema/subject-element-alerttemplates.md +++ b/docs/schema/subject-element-alerttemplates.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - AlertTemplates schema api_type: @@ -17,9 +16,9 @@ description: Specifies the subject of the alert message. # Subject element (AlertTemplates) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Specifies the subject of the alert message. - + ```XML @@ -32,14 +31,12 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements None - -### Parent elements -- [Digest](digest-element-alerttemplates.md) -- [Immediate](immediate-element-alerttemplates.md) - +### Parent elements +- [Digest](digest-element-alerttemplates.md) +- [Immediate](immediate-element-alerttemplates.md) diff --git a/docs/schema/subscription-element-subscription-schema.md b/docs/schema/subscription-element-subscription-schema.md index b75243461..0c9ddcb9d 100644 --- a/docs/schema/subscription-element-subscription-schema.md +++ b/docs/schema/subscription-element-subscription-schema.md @@ -1,15 +1,15 @@ --- title: Subscription element manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 +description: Describes Subscription element and provides information on elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 1eaeefb2-8b18-bf8c-3594-f72ac27cd74d --- -# Subscription element +# Subscription element (Subscription schema) @@ -97,49 +97,14 @@ The following sections describe attributes, child elements, and parent elements. ### Child elements - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Element

    Description

    LocalizedDisplayNames element in MetadataObject (Subscription schema)

    Properties element in MetadataObject (Subscription schema)

    Identities element in Subscription (Subscription schema)

    Queries element in Subscription (Subscription schema)

    Associations element in Subscription (Subscription schema)

    +| Element | Description | +| --- | --- | +| [LocalizedDisplayNames element in MetadataObject (Subscription schema)](localizeddisplaynames-element-in-metadataobject-subscription-schema.md) | | +| [Properties element in MetadataObject (Subscription schema)](properties-element-in-metadataobject-subscription-schema.md) | | +| [Identities element in Subscription (Subscription schema)](identities-element-in-subscription-subscription-schema.md) | | +| [Queries element in Subscription (Subscription schema)](queries-element-in-subscription-subscription-schema.md) | | +| [Associations element in Subscription (Subscription schema)](associations-element-in-subscription-subscription-schema.md) | | ### Parent elements None. - - - - - - - - diff --git a/docs/schema/subscription-schema.md b/docs/schema/subscription-schema.md index 5b8413ca5..3cc5fc370 100644 --- a/docs/schema/subscription-schema.md +++ b/docs/schema/subscription-schema.md @@ -1,11 +1,11 @@ --- title: Subscription schema manager: soliver -ms.date: 11/16/2014 +ms.date: 06/14/2022 +description: Describes Subscription schema and contains the documentation for the Subscription schema (Subscription.xsd). ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 43e40fe9-ac57-e09d-b7b2-f8ef2ba5b7a4 --- @@ -42,11 +42,3 @@ This section contains the documentation for the **Subscription schema (Subscript - [Query element in Queries (Subscription schema)](query-element-in-queries-subscription-schema.md) - [Subscription element (Subscription schema)](subscription-element-subscription-schema.md) - - - - - - - - diff --git a/docs/schema/supportedlanguages-element-propertiesdefinition-complextypesharepoint-add-in-man.md b/docs/schema/supportedlanguages-element-propertiesdefinition-complextypesharepoint-add-in-man.md index ea71dcce5..08159e935 100644 --- a/docs/schema/supportedlanguages-element-propertiesdefinition-complextypesharepoint-add-in-man.md +++ b/docs/schema/supportedlanguages-element-propertiesdefinition-complextypesharepoint-add-in-man.md @@ -1,15 +1,15 @@ --- title: SupportedLanguages element (PropertiesDefinition complexType) manager: soliver -ms.date: 9/17/2015 +ms.date: 06/14/2022 +description: Describes SupportedLanguages element (PropertiesDefinition complexType) and provides information elements and attributes. ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7a8da886-5731-9abd-2911-5cd268bba4cf --- -# SupportedLanguages element (PropertiesDefinition complexType) +# SupportedLanguages element (PropertiesDefinition complexType) (SharePoint Add-in Manifest) @@ -17,12 +17,12 @@ ms.assetid: 7a8da886-5731-9abd-2911-5cd268bba4cf Please do not use this element. It has been deprecated in favor of the **SupportedLocales** element. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +|Information|Location| |---|---| | **Element type** | SupportedLanguagesDefinition | | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | @@ -31,7 +31,7 @@ Please do not use this element. It has been deprecated in favor of the **Support ## Definition ```XML  - + ``` ## Elements and attributes @@ -76,10 +76,3 @@ None.

    - - - - - - - diff --git a/docs/schema/supportedlanguagesdefinition-simpletype-sharepoint-add-in-manifest.md b/docs/schema/supportedlanguagesdefinition-simpletype-sharepoint-add-in-manifest.md index e12fa772d..af9796596 100644 --- a/docs/schema/supportedlanguagesdefinition-simpletype-sharepoint-add-in-manifest.md +++ b/docs/schema/supportedlanguagesdefinition-simpletype-sharepoint-add-in-manifest.md @@ -1,26 +1,26 @@ --- title: SupportedLanguagesDefinition simpleType manager: soliver -ms.date: 9/17/2015 +ms.date: 06/14/2022 +description: Describes SupportedLanguagesDefinition simpleType and provides information on type and applications. ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 2dc9b295-4355-d6e9-c734-4d636bef3a74 --- -# SupportedLanguagesDefinition simpleType +# SupportedLanguagesDefinition simpleType (SharePoint Add-in Manifest) **Applies to**: SharePoint Add-ins | SharePoint Foundation 2013 | SharePoint Server 2013 -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +|Information|Location| |---|---| | **Base type** | xs:string | | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | @@ -29,17 +29,10 @@ ms.assetid: 2dc9b295-4355-d6e9-c734-4d636bef3a74 ## Definition ```XML - + ``` - - - - - - - diff --git a/docs/schema/supportedlocale-element-supportedlocalesdefinition-complextypesharepoint-add-in.md b/docs/schema/supportedlocale-element-supportedlocalesdefinition-complextypesharepoint-add-in.md index 1f0055f9b..bfd90fe80 100644 --- a/docs/schema/supportedlocale-element-supportedlocalesdefinition-complextypesharepoint-add-in.md +++ b/docs/schema/supportedlocale-element-supportedlocalesdefinition-complextypesharepoint-add-in.md @@ -1,15 +1,15 @@ --- title: SupportedLocale element (SupportedLocalesDefinition complexType) manager: soliver -ms.date: 9/17/2015 +ms.date: 06/14/2022 +description: Describes SupportedLocale element (SupportedLocalesDefinition complexType) and provides information elements and attributes. ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 099a9e03-4cb7-6ccb-83dd-756498aeeb1d --- -# SupportedLocale element (SupportedLocalesDefinition complexType) +# SupportedLocale element (SupportedLocalesDefinition complexType) (SharePoint Add-in Manifest) @@ -17,12 +17,12 @@ ms.assetid: 099a9e03-4cb7-6ccb-83dd-756498aeeb1d Specifies a locale that the add-in supports. This element is required for add-ins that are submitted to the Office Store. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Information | Location | |---|---| | **Element type** | SupportedLocaleDefinition | | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | @@ -37,7 +37,7 @@ Specifies a locale that the add-in supports. This element is required for add-in
    -> [!WARNING] +> [!WARNING] > Although the **maxOccurs** attribute in the XSD for the add-in manifest markup is set to 256, the Office Store may set a lower effective maximum. As of the release of SharePoint 2013, there is an effective maximum of 25 **SupportedLocale** elements in the parent **SupportedLocales** element. ## Elements and attributes @@ -108,9 +108,3 @@ None.

    - - - - - - diff --git a/docs/schema/supportedlocaledefinition-complextype-sharepoint-add-in-manifest.md b/docs/schema/supportedlocaledefinition-complextype-sharepoint-add-in-manifest.md index 1be0749cf..47ff6778e 100644 --- a/docs/schema/supportedlocaledefinition-complextype-sharepoint-add-in-manifest.md +++ b/docs/schema/supportedlocaledefinition-complextype-sharepoint-add-in-manifest.md @@ -1,15 +1,15 @@ --- title: SupportedLocaleDefinition complexType manager: soliver -ms.date: 9/17/2015 +ms.date: 06/14/2022 +description: Describes SupportedLocaleDefinition complexType and provides information elements and attributes. ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: f3affad3-4ac8-2124-57fc-b3599899997b --- -# SupportedLocaleDefinition complexType +# SupportedLocaleDefinition complexType (SharePoint Add-in Manifest) @@ -17,12 +17,12 @@ ms.assetid: f3affad3-4ac8-2124-57fc-b3599899997b Identifies a locale in [Internet Engineering Task Force (IETF)](http://tools.ietf.org/html/rfc1766)-compliant format; for example, en-us. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +|Information|Location| |---|---| | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | | **Schema file** | appmanifest.xsd | @@ -75,11 +75,3 @@ None. - - - - - - - - diff --git a/docs/schema/supportedlocales-element-propertiesdefinition-complextypesharepoint-add-in-manif.md b/docs/schema/supportedlocales-element-propertiesdefinition-complextypesharepoint-add-in-manif.md index 0b15c6733..0691983ad 100644 --- a/docs/schema/supportedlocales-element-propertiesdefinition-complextypesharepoint-add-in-manif.md +++ b/docs/schema/supportedlocales-element-propertiesdefinition-complextypesharepoint-add-in-manif.md @@ -1,15 +1,15 @@ --- title: SupportedLocales element (PropertiesDefinition complexType) manager: soliver -ms.date: 9/17/2015 +ms.date: 06/14/2022 +description: Describes SupportedLocales element (PropertiesDefinition complexType) and provides information elements and attributes. ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 49bde91a-8d7a-be17-4c91-82c9c19f0f61 --- -# SupportedLocales element (PropertiesDefinition complexType) +# SupportedLocales element (PropertiesDefinition complexType) (SharePoint Add-in Manifest) @@ -17,12 +17,12 @@ ms.assetid: 49bde91a-8d7a-be17-4c91-82c9c19f0f61 Specifies the locales that the add-in supports. This element is required for add-ins that are submitted to the Office Store. Its primary purpose is to populate the **spstore** UI with a list of supported locales. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Information | Location | |---|---| | **Element type** | SupportedLocalesDefinition | | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | @@ -90,7 +90,7 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -> [!WARNING] +> [!WARNING] > Although the **maxOccurs** attribute for the **SupportedLocale** element in the XSD for the add-in manifest markup is set to 256, the Office Store may set a lower effective maximum. As of the release of SharePoint 2013, there is an effective maximum of 25 **SupportedLocale** elements in the parent **SupportedLocales** element. ### Attributes @@ -100,6 +100,3 @@ None.

    - - - diff --git a/docs/schema/supportedlocalesdefinition-complextype-sharepoint-add-in-manifest.md b/docs/schema/supportedlocalesdefinition-complextype-sharepoint-add-in-manifest.md index 0039692e2..256a24c7c 100644 --- a/docs/schema/supportedlocalesdefinition-complextype-sharepoint-add-in-manifest.md +++ b/docs/schema/supportedlocalesdefinition-complextype-sharepoint-add-in-manifest.md @@ -1,15 +1,15 @@ --- title: SupportedLocalesDefinition complexType manager: soliver -ms.date: 9/17/2015 +ms.date: 06/14/2022 +description: Describes SupportedLocalesDefinition complexType and provides information elements and attributes. ms.audience: Developer ms.topic: article -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 0efd105a-d89e-039c-3f64-cc78d8160503 --- -# SupportedLocalesDefinition complexType +# SupportedLocalesDefinition complexType (SharePoint Add-in Manifest) @@ -17,12 +17,12 @@ ms.assetid: 0efd105a-d89e-039c-3f64-cc78d8160503 Specifies the locales that an add-in supports. -> [!NOTE] +> [!NOTE] > The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Type information -| | | +| Information | Location | |---|---| | **Namespace** | `http://schemas.microsoft.com/sharepoint/2012/app/manifest` | | **Schema file** | appmanifest.xsd | @@ -71,11 +71,3 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** ### Attributes None. - - - - - - - - diff --git a/docs/schema/switch-element-view.md b/docs/schema/switch-element-view.md index 59234194d..7d15c1556 100644 --- a/docs/schema/switch-element-view.md +++ b/docs/schema/switch-element-view.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - View schema api_type: @@ -17,9 +16,9 @@ description: Allows for conditional rendering based on the value of a Collaborat # Switch element (View) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Allows for conditional rendering based on the value of a Collaborative Application Markup Language (CAML) expression. - + ```XML @@ -40,34 +39,34 @@ The following sections describe attributes, child elements, and parent elements. |**Attribute**|**Description**| |:-----|:-----| |**StripWS**
    |Optional **Boolean**. **TRUE** to remove white space from the beginning and end of the value returned by the element.
    | - + ### Child elements - [Case](case-element-view.md) - [Default](default-element-view.md) - [Expr](expr-element-view.md) - + ### Parent elements -Numerous - +Numerous + ### Occurrences - Minimum: 0 -- Maximum: Unbounded - +- Maximum: Unbounded + ### Remarks -A **Switch** element contains an [Expr](expr-element-view.md) element, any number of [Case](case-element-view.md) elements, and a [Default](default-element-view.md) element. The value of the **Expr** element is compared against the **Value** attribute of each **Case** element. +A **Switch** element contains an [Expr](expr-element-view.md) element, any number of [Case](case-element-view.md) elements, and a [Default](default-element-view.md) element. The value of the **Expr** element is compared against the **Value** attribute of each **Case** element. + +When a match is found, the **Switch** element returns the value of the matching **Case** element. If no match is found, and if a **Default** element is given, the **Switch** element returns the value of the **Default** element. If no **Default** element is specified and none of the **Case** values match the **Expr** value, the **Switch** element returns an empty string. -When a match is found, the **Switch** element returns the value of the matching **Case** element. If no match is found, and if a **Default** element is given, the **Switch** element returns the value of the **Default** element. If no **Default** element is specified and none of the **Case** values match the **Expr** value, the **Switch** element returns an empty string. - This element does not require any particular parent element. - + ## Example -The following example returns "User Zero" if the **UserID** value equals 0 (zero); otherwise, the example returns "Not User Zero." - +The following example returns "User Zero" if the **UserID** value equals 0 (zero); otherwise, the example returns "Not User Zero." + ```XML @@ -79,4 +78,3 @@ The following example returns "User Zero" if the **UserID** value equals 0 (zero ## See also - [FieldSwitch element (View)](fieldswitch-element-view.md) - diff --git a/docs/schema/synchronization-element-event.md b/docs/schema/synchronization-element-event.md index 8ae59ba7b..32ae623a6 100644 --- a/docs/schema/synchronization-element-event.md +++ b/docs/schema/synchronization-element-event.md @@ -1,11 +1,11 @@ --- title: Synchronization Element (Event) manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 +description: Describes Synchronization Element (Event) and provides information elements and attributes, occurrences, and an example. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d94e2c12-b543-4ae5-8c62-5e9fcef2cfe8 --- @@ -63,11 +63,3 @@ None ## Example For an example of how this element is used, see [Event Registrations](event-registrations.md). - - - - - - - - diff --git a/docs/schema/systemdata-element-deploymentsystemdata.md b/docs/schema/systemdata-element-deploymentsystemdata.md index 53004a1eb..bf9778626 100644 --- a/docs/schema/systemdata-element-deploymentsystemdata.md +++ b/docs/schema/systemdata-element-deploymentsystemdata.md @@ -1,28 +1,27 @@ --- title: "SystemData Element (DeploymentSystemData)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 +description: Describes SystemData Element (DeploymentSystemData) and provides information elements and attributes, type, and additional remarks. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 79e46615-3108-4103-9553-1d57938333b1 -description: "Last modified: March 09, 2015" --- # SystemData Element (DeploymentSystemData) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Represents a system data wrapper object (**SPSystemData**) that contains the deployment system data object collections. This is the schema root element. + +Represents a system data wrapper object (**SPSystemData**) that contains the deployment system data object collections. This is the schema root element. ## Definition ```XML DECLARATION - USAGE @@ -36,7 +35,7 @@ USAGE ## Type **SPSystemData** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -44,22 +43,21 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements -- [SchemaVersion Element (DeploymentSystemData)](schemaversion-element-deploymentsystemdata.md) +- [SchemaVersion Element (DeploymentSystemData)](schemaversion-element-deploymentsystemdata.md) - [ManifestFiles Element (DeploymentSystemData)](manifestfiles-element-deploymentsystemdata.md) - [SystemObjects Element (DeploymentSystemData)](systemobjects-element-deploymentsystemdata.md) - + ### Parent elements None - + ### Remarks -The **SystemData** element is the schema root element and therefore has no parent element. - +The **SystemData** element is the schema root element and therefore has no parent element. + ## See also - [DeploymentSystemData Schema](deploymentsystemdata-schema.md) - diff --git a/docs/schema/systemobject-element-deploymentsystemdata.md b/docs/schema/systemobject-element-deploymentsystemdata.md index cdc30ed01..8ff4c012e 100644 --- a/docs/schema/systemobject-element-deploymentsystemdata.md +++ b/docs/schema/systemobject-element-deploymentsystemdata.md @@ -1,29 +1,28 @@ --- title: "SystemObject Element (DeploymentSystemData)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 +description: Describes SystemObject Element (DeploymentSystemData) and provides information elements and attributes, attributes, and type. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 45f77771-640b-432f-afd0-65d3f43332df -description: "Last modified: March 09, 2015" --- # SystemObject Element (DeploymentSystemData) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a SharePoint Foundation system object instance (**SPSystemObject**) exported to the content migration package. ## Definition ```XML DECLARATION - USAGE @@ -39,7 +38,7 @@ USAGE ## Type **SPSystemObject** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -51,16 +50,15 @@ The following sections describe attributes, child elements, and parent elements. |**Id**
    |[Guid Simple Type (DeploymentSystemData)](guid-simple-type-deploymentsystemdata.md)
    |Optional. Unique identifier of the system object.
    | |**Type**
    |[SPDeploymentObjectType Simple Type (DeploymentSystemData)](spdeploymentobjecttype-simple-type-deploymentsystemdata.md)
    |Optional. Specification of the object type: **Site**, **Web**, **Folder**, **List**, **ListItem**, or **File**.
    | |**Url**
    |xs:string
    |Optional. URL to the system object.
    | - + ### Child elements None - + ### Parent elements [SystemObjects Element (DeploymentSystemData)](systemobjects-element-deploymentsystemdata.md) - + ## See also - [DeploymentSystemData Schema](deploymentsystemdata-schema.md) - diff --git a/docs/schema/systemobjects-element-deploymentsystemdata.md b/docs/schema/systemobjects-element-deploymentsystemdata.md index cd0aa3c06..3a7d42209 100644 --- a/docs/schema/systemobjects-element-deploymentsystemdata.md +++ b/docs/schema/systemobjects-element-deploymentsystemdata.md @@ -1,29 +1,28 @@ --- title: "SystemObjects Element (DeploymentSystemData)" manager: soliver -ms.date: 3/9/2015 +ms.date: 06/14/2022 +description: Describes SystemObjects Element (DeploymentSystemData) and provides information elements and attributes, attributes, and type. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 7100c23d-ec75-489d-8549-8ea765820489 -description: "Last modified: March 09, 2015" --- # SystemObjects Element (DeploymentSystemData) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a collection of SharePoint Foundation system object (**SPSystemObject**) instances. ## Definition ```XML DECLARATION - USAGE @@ -37,7 +36,7 @@ USAGE ## Type **SPSystemObject** - + ## Elements and attributes The following sections describe attributes, child elements, and parent elements. @@ -45,16 +44,15 @@ The following sections describe attributes, child elements, and parent elements. ### Attributes None - + ### Child elements [SystemObject Element (DeploymentSystemData)](systemobject-element-deploymentsystemdata.md) - + ### Parent elements [SystemData Element (DeploymentSystemData)](systemdata-element-deploymentsystemdata.md) - + ## See also - [DeploymentSystemData Schema](deploymentsystemdata-schema.md) - diff --git a/docs/schema/tab-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/tab-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index 2252f036a..a2a48b411 100644 --- a/docs/schema/tab-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/tab-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,24 +1,24 @@ --- title: Tab element (CommandUIDefinitionType complexType) manager: soliver -ms.date: 9/16/2015 +ms.date: 06/14/2022 +description: Describes Tab element (CommandUIDefinitionType complexType) and provides information elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: d787785a-24f8-f183-56ad-3ec39dc01334 --- -# Tab element (CommandUIDefinitionType complexType) +# Tab element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Information | Location | |---|---| | **Element type** | TabType | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | @@ -59,26 +59,18 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements None. -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/tab-element.md b/docs/schema/tab-element.md index 9edcf7f19..7be22a643 100644 --- a/docs/schema/tab-element.md +++ b/docs/schema/tab-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Represents a tab control. # Tab element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Represents a tab control. - + ```XML |Required. A string that identifies the control, such as "Ribbon.CustomTabExample".
    | |**Sequence**
    |Optional. An integer that specifies the order of placement among other tab controls.
    | |**Title**
    |Optional. The title to display on the tab.
    | - + ### Child elements -- [Scaling](scaling-element.md) -- [Groups](groups-element.md) - +- [Scaling](scaling-element.md) +- [Groups](groups-element.md) + ### Parent elements -- [ContextualGroup](contextualgroup-element.md) -- [Tabs](tabs-element.md) - +- [ContextualGroup](contextualgroup-element.md) +- [Tabs](tabs-element.md) + ### Occurrences - Minimum: 0 -- Maximum: unbounded - +- Maximum: unbounded + ## See also - [Walkthrough: Adding a Tab to the Server Ribbon](https://msdn.microsoft.com/library/3d1fb8b6-4c9b-4801-9bba-6d2f5caee0d9%28Office.15%29.aspx) - diff --git a/docs/schema/tabs-element-commanduidefinitiontype-complextypeapphostwebfeatures.md b/docs/schema/tabs-element-commanduidefinitiontype-complextypeapphostwebfeatures.md index b971341d0..822e00725 100644 --- a/docs/schema/tabs-element-commanduidefinitiontype-complextypeapphostwebfeatures.md +++ b/docs/schema/tabs-element-commanduidefinitiontype-complextypeapphostwebfeatures.md @@ -1,30 +1,30 @@ --- title: Tabs element (CommandUIDefinitionType complexType) manager: soliver -ms.date: 9/16/2015 +ms.date: 06/14/2022 +description: Describes Tabs element (CommandUIDefinitionType complexType) and provides information elements and attributes. ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium ms.assetid: 33ef42f3-1e70-8450-4606-ec6b4321ff52 --- -# Tabs element (CommandUIDefinitionType complexType) +# Tabs element (CommandUIDefinitionType complexType) (AppHostWebFeatures) -> [!NOTE] -> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. +> [!NOTE] +> The string `app` appears as part of or all of some element, attribute, and file names because SharePoint Add-ins were originally called "apps for SharePoint." To ensure backward compatibility, the schemas have not been changed. ## Element information -| | | +| Information | Location | |---|---| | **Element type** | TabsType | | **Namespace** | `http://schemas.microsoft.com/sharepoint/` | | **Schema file** | apphostwebfeatures.xsd | -## Definition +## Definition ```XML @@ -59,26 +59,18 @@ If the schema defines specific requirements, such as **sequence**, **minOccurs** -
    +
    ### Child elements None. -
    +
    ### Attributes None. -
    - -
    - - - - - - - +
    +
    diff --git a/docs/schema/tabs-element.md b/docs/schema/tabs-element.md index 7e57d814f..fc5c568b3 100644 --- a/docs/schema/tabs-element.md +++ b/docs/schema/tabs-element.md @@ -4,8 +4,7 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Server Ribbon schema api_type: @@ -17,9 +16,9 @@ description: Contains elements that define tab controls. # Tabs element (Server Ribbon) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - + Contains elements that define tab controls. - + ```XML |Required. A string that identifies the element, such as "Ribbon.Tabs".
    | - + ### Child elements - [Tab](tab-element.md) - + ### Parent elements - [Ribbon](ribbon-element.md) - + ### Occurrences - Minimum: 1 -- Maximum: 1 - - +- Maximum: 1 diff --git a/docs/schema/template-element-site.md b/docs/schema/template-element-site.md index c07e03725..51602f0e7 100644 --- a/docs/schema/template-element-site.md +++ b/docs/schema/template-element-site.md @@ -4,22 +4,21 @@ manager: soliver ms.date: 3/9/2015 ms.audience: Developer ms.topic: reference -ms.prod: sharepoint -localization_priority: Normal +ms.localizationpriority: medium api_name: - Site schema api_type: - schema ms.assetid: 093d5a6c-c6a0-472e-8e79-172ceedd0e24 -description: Specifies, in a WebTemp*.xml file, a site definition that can be used to create websites within the deployment. +description: Specifies, in a WebTemp*.xml file, a site definition that can be used to create websites within the deployment. --- # Template element (Site) **Applies to:** SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013 - -Specifies, in a `WebTemp*.xml` file, a site definition that can be used to create websites within the deployment. - + +Specifies, in a `WebTemp*.xml` file, a site definition that can be used to create websites within the deployment. + ```XML