Udvikle tilpassede sektionslayouts med API'er

Et JavaScript-objekt, der indeholder følgende egenskaber:

• sectionlayoutData (Objekt) : De sektionslayoutdata, der blev fundet i sidemodellen.

• componentId (Streng): componentId-værdien for sektionslayoutet, der normalt er et GUID.

• renderMode (Streng, valgfri): Gengivelsestilstanden for gengivelsesoperationen.

• customSettingsData (Objekt): En kopi af de customSettingsData, der blev fundet i sectionLayoutData.

Afsender DOM-elementer, der kan bruges i sektionslayoutet, til siden, herunder container-DIV-tags for underordnede komponenter.

container (Element) : Det DOM-element, som sektionslayoutets markup skal gengives i.

Når denne metode returneres, gengives underordnede komponenter.

Du kan identificere underordnede komponenter ved at finde underordnede div[id]-elementer

Bruges sammen med indholdslistekomponenter til dynamisk at føje underordnede komponenter til et sektionslayout.

Denne funktion er valgfri.

container (Element) : Det DOM-element, som den nye komponent skal gengives i.

componentId (Streng): ID'et for det nye komponent, der skal føjes til sektionslayoutet.

Når denne metode returneres, gengives det element, hvis ID matcher componentId-inputtet.

Et JavaScript-objekt, der indeholder følgende egenskab:

• componentId (Streng): componentId-værdien for sektionslayoutet, der normalt er et GUID.

getCapabilities

Returnerer et objekt, der beskriver sektionslayoutets redigeringsfunktioner.

Et JavaScript-objekt, der beskriver sektionslayoutets redigeringsfunktioner.

Efter input angives standardfunktionerne til funktionen. Funktionen kan modificere objektet Capabilities efter behov.

Objektet Funktioner kan omfatte følgende funktioner:

• title (Streng): Titlen på det sektionslayout, der skal vises til brugeren.

• settingsTitle (Streng): Den titel, der skal vises i dialogboksen Indstillingspanel.

• hasSettings (Boolesk): Angiver, om sektionslayoutet understøtter et indstillingspanel.

• allowMove (Boolesk): Angiver, om sektionslayoutet gør det muligt at flytte underordnede elementer.

• allowDelete (Boolesk): Angiver, om sektionslayoutet gør det muligt at slette underordnede elementer.

• isHidden (Boolesk): Angiver, om sektionslayoutet p.t. er skjult som følge af brugervalg.

• dropTarget (Boolesk): Angiver, om sektionslayoutet er mål for træk og slip-operationer.

• customMenuOptions (Array): Tilpassede menupunkter, der skal føjes til sektionslayoutets kontekstmenu. Hvert menupunktobjekt har følgende egenskaber:

  • label (Streng) : Menupunktets visningstekst.

  • action (Funktion): Den funktion, der kaldes, når der klikkes på menupunktet.

  • disabled (Boolesk): Angiver, at menupunktet skal vises som deaktiveret.

  • icon (Streng): Den URL, der skal vises ved siden af etiketten i menupunktet. Denne egenskab er reserveret til fremtidig brug.

  • checkmark (Boolesk): Angiver, at der skal vises en markering ved siden af etiketten i menupunktet.

  • subMenuItems (Array): Menupunkter, der skal vises i en undermenu.

(Object): Funktionerne til sektionslayoutet.

getCaptionContent

Returnerer sektionslayoutets visningsnavn, der vises i elementer i brugergrænsefladen.

Ingen.

(String): Sektionslayoutets visningsnavn.

Gør det muligt for sektionslayoutet at modificere objektet Funktioner, før menuer vises til brugeren.

Du kan bruge denne API til regulering eller fjernelse af menupunkter. (Se også getCapabilities).

Et JavaScript-objekt, der beskriver sektionslayoutets redigeringsfunktioner. Ved input angives standardfunktionerne til funktionen.

eventObject (Begivenhedsobjekt): Et begivenhedsobjekt, der indeholder oplysninger om træk-begivenheden.

dataTransfer (DataTransfer-objekt): Et DataTransfer-objekt, der indeholder oplysninger om det element, der trækkes hen over sektionslayoutet.

(Boolesk) En værdi, der angiver, om det element, der trækkes, accepteres af sektionslayoutet.

Returnerer sand, hvis sektionslayoutet accepterer det element, der trækkes, og returnerer i modsat fald falsk.

eventObject (Begivenhedsobjekt): Et begivenhedsobjekt, der indeholder oplysninger om slip-begivenheden.

dataTransfer (DataTransfer-objekt): Et DataTransfer-objekt, der indeholder oplysninger om det element, der slippes i sektionslayoutet.

(Boolesk) En værdi, der angiver, om slip-operationen blev håndteret af sektionslayoutet.

Hvis sand returneres, springes standardlogikken over.

eventObject (Begivenhedsobjekt): Et begivenhedsobjekt, der indeholder oplysninger om træk-begivenheden.

dataTransfer (DataTransfer-objekt): Et DataTransfer-objekt, der indeholder oplysninger om det element, der slippes i sektionslayoutet.

componentId (Streng): componentId-værdien for det element, der lige er tilføjet.

Giver sektionslayoutet besked om, at en træk og slip-operation flyttede et element i sektionslayoutet.

eventObject (Begivenhedsobjekt): Et begivenhedsobjekt, der indeholder oplysninger om træk-begivenheden.

dataTransfer (DataTransfer-objekt): Et DataTransfer-objekt, der indeholder oplysninger om det element, der slippes i sektionslayoutet.

componentId (Streng): componentId-værdien for det flyttede element.

Gør det muligt for sektionslayoutet at ændre indstillingsdataene, før indstillingspanelet vises.

settingsData (Objekt): De standardindstillingsdata, der beregnes for sektionslayoutet

Gør det muligt for sektionslayoutet at ændre indstillingerne, efter at indstillingspanelet er lukket.

Denne API kaldes, lige før indstillingerne gemmes i sidemodellen.

parameters (Objekt): Det rå parameterobjekt, der returneres fra indstillingspanelet.

sectionlayoutData (Objekt) : De sektionslayoutdata, der gemmes. Der genereres standarddata fra parameters (Object), som videregives til funktionen i dette parameter.

Gør det muligt for redigeringsmodulet at frigøre hukommelse, fjerne begivenheder og deallokere ressourcer, der er knyttet til redigerings-handlerne.

Denne API kaldes, når sektionslayoutet skal tegnes forfra igen, for eksempel under en Fortryd/Annuller Fortryd-operation.