ConsoleAction - Classe

Article
03/15/2016

Représente la classe de base qui doivent hériter de toutes les actions de console spécifiques à utiliser dans le ConsoleDataSource.

Hiérarchie d’héritage

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      Microsoft.SharePoint.Publishing.WebControls.EditingMenuActions.ConsoleAction

Espace de noms : Microsoft.SharePoint.Publishing.WebControls.EditingMenuActions
Assembly : Microsoft.SharePoint.Publishing (dans Microsoft.SharePoint.Publishing.dll)

Syntaxe

'Déclaration
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public MustInherit Class ConsoleAction _
    Inherits WebControl _
    Implements IPostBackEventHandler
'Utilisation
Dim instance As ConsoleAction

[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public abstract class ConsoleAction : WebControl, 
    IPostBackEventHandler

Remarques

Le menu Actions du Site , Menu d'accès rapideou Menu éditionprésente les différentes actions à l'utilisateur. Chacun de ces menus contient une instance de l'objet ConsoleDataSource qui fournit une collection hiérarchique d'objets ConsoleNode , certaines d'entre elles implémentent la classe ConsoleAction . Chaque implémentation de cette classe représente une action spécifique, par exemple Créer une Page, Publier, Afficher l'historique de Versionou Enregistrer et arrêter les modifications.

L'exemple de code présenté ici est simplifiée, mais montre comment une action de console doit être construite. Exécution de cet exemple d'application ajoute un bouton « Enregistrer et arrêter la modification » au Menu d'accès rapide. Elle nécessite que la page est en mode édition et que l'utilisateur dispose des autorisations pour cet objet PublishingPageEditListItem . L'exemple utilise ECMAScript (JavaScript, JScript) pour effectuer une publication sur ce contrôle, et lorsqu'il déclenche un événement de publication (postback), l'événement enregistre l'objet PublishingPage en cours et affiche la page enregistrée en mode d'affichage.

Exemples

using Microsoft.SharePoint;
using Microsoft.SharePoint.WebControls;
using Microsoft.SharePoint.Publishing.WebControls.EditingMenuActions;

/// Assemblies that need to be referenced in this sample;
///     Microsoft.SharePoint.dll
///     Microsoft.SharePoint.Publishing.dll
///     Microsoft.Web.CommandUI.dll
namespace Microsoft.SDK.SharePointServer.Samples.Publishing.RteExtensions
{
    public class RteExtensionsAction : ConsoleAction
    {
        /// <summary>
        /// This Console Action will include on the client a reference to RteExtension.js file 
        /// on pages that have a Rich Text Editor.
        /// </summary>
        public RteExtensionsAction()
            : base()
        {
        }

        /// <summary>
        /// Gets the rights required for this console action to be active on the page.
        /// 
        /// For this example, we will have the same value as the Publishing Rich Text Editor
        /// which requires Edit List Item Right, since we want to activate under
        /// the same circumstances.
        /// </summary>
        /// <value>
        /// The rights required for this console action to be active on the page.
        /// </value>
        public override SPBasePermissions UserRights
        {
            get { return SPBasePermissions.EditListItems; }
        }

        /// <summary>
        /// The value returned by this function represents a list of Ribbon tabs, if these
        /// ribbon tabs are currently shown, then this console action will be activate on this page.
        /// 
        /// For this example, we are specifying the Format Text tab, which is requested
        /// when the Publishing Rich Text Editor is on the page. Also, we are adding a new
        /// button to this tab, and hence we want to activate when that button is present on
        /// the page.
        /// </summary>
        /// <returns>
        /// A list of ribbon tabs for which the ConsoleAction is activated.
        /// </returns>
        public override string[] GetRibbonTabIdsWhereConsoleActionIsShown()
        {
            return new string[] { SPRibbon.EditTabId };
        }

        /// <summary>
        /// If the UserRights are met and the Ribbon Tabs have been found, then this method will be called.
        /// This is where you register your appropriate ribbon files and send to the client data it requires.
        /// 
        /// For this example, we will tell SharePoint ScriptLink about the existance of RteExtensions.js.
        /// This will allow code on the client to download it on demand. 
        /// The second part will register a startup script that will download RteExtensions.js once the
        /// SharePoint rich text editor file (sp.ui.rte.js) has finished downloaded.
        /// </summary>
        public override void RegisterClientData()
        {
            // Register the extension script, such that it can be downloaded on demand.
            ScriptLink.RegisterOnDemand(this.Page, "RteExtensions.js", false);

            // Download the RteExtension script when the SharePoint RTE has finished downloaded.
            string onDemandScript = @"
// This method informs SharePoint to start downloading the Script On Demand
// file that was registered on the server.
function loadRteExtensions()
{
// Include the RteExtensions.js if it is not already on the page.
var defd;
try
{
defd = typeof(RteExtensions);
}
catch (e)
{
defd = 'undefined';
}
EnsureScript('RteExtensions.js', defd, null);
}
// This method is run when the body has finished loading.
// Inform SharePoint to wait until the rich text editor has been 
// downloaded on the page before including the rte extensions.
function loadExtensionsDependencies()
{
ExecuteOrDelayUntilScriptLoaded(loadRteExtensions, 'sp.ui.rte.js');
}
// Add to the SharePoint array of functions to call when the 
// body of the document has finished loading
// Wait for the page to have completed to load
// this will make sure that all script on demand information
// has been processed by SharePoint.
if (_spBodyOnLoadFunctionNames != null)
{
_spBodyOnLoadFunctionNames.push('loadExtensionsDependencies');
}
";
            Page.ClientScript.RegisterStartupScript(typeof(RteExtensionsAction), "RteExtensionsAction", onDemandScript, true);
        }
    }
}