Rasterobjecten en -methoden (clientreferentie)

  • Artikel

 

Gepubliceerd: november 2016

Is van toepassing op: Dynamics CRM 2015

Met Update 1 voor Microsoft Dynamics CRM Online 2015 kunt u meer doen met besturingselementen voor subrasters in formulieren door nieuwe gebeurtenissen en objecten te gebruiken.Meer informatie:Scripts schrijven voor subrasters

Belangrijk

Voor Microsoft Dynamics CRM Online-organisaties is deze functie alleen beschikbaar als uw organisatie is bijgewerkt naar Dynamics CRM Online 2015 Update 1. Deze functie is niet beschikbaar voor Dynamics CRM (on-premises).

In dit onderwerp

  • Rasterbesturingselement
    Gebeurtenissen en methoden voor de GridControl: Gebeurtenis OnLoad, addOnLoad, getEntityName, getGrid, getViewSelector en removeOnLoad.

  • Raster
    Methoden voor de Grid die wordt geretourneerd door de methode GridControl.getGrid: getRows, getSelectedRows en getTotalRecordCount.

  • GridRow
    De methode getData voor de GridRow die wordt geretourneerd door de methoden **Grid.**getRows en **Grid.**getSelectedRows.

  • GridRowData
    De methode getEntity voor de GridRowData die wordt geretourneerd door de methode **GridRow.**getData.

  • GridEntity
    Methoden voor de GridEntity die wordt geretourneerd door de methode **GridRowData.**getEntity: getEntityName, getEntityReference, getId en getPrimaryAttributeValue.

  • ViewSelector
    Methoden voor de ViewSelector die wordt geretourneerd door de GridControl.getViewSelector, getCurrentView, isVisible en setCurrentView

Rasterbesturingselement

Vóór CRM Online 2015 Update 1 vormde refresh de enige unieke methode voor het subrasterbesturingselement. Als u de naam van het subrasterbesturingselement weet, kunt u hier toegang toe krijgen met de volgende code, bijvoorbeeld om toegang te krijgen tot het subraster CONTACTPERSONEN in het standaard accountformulier.

var contactsSubgrid = Xrm.Page.getControl("Contacts");

Tip

Zie de informatie in Ontwikkelingshulpmiddelen voor browsers gebruiken voor het identificeren van de namen van subrasterbesturingselementen in het formulier zonder de formuliereneditor te openen.

Als Xrm.Page.ui-besturingselement, beschikt GridControl tevens over alle standaard besturingselementmethoden: methoden getControlType, Label, methoden getParent, Zichtbaar, methoden setFocus en methoden Melding, alsmede refresh. Zie Xrm.Page.ui control (referentie aan de clientzijde) voor meer informatie over deze methoden.

Gebeurtenis OnLoad

Voeg gebeurtenishandlers toe aan deze gebeurtenis zodat deze wordt uitgevoerd telkens wanneer het subraster wordt vernieuwd. Dit is inclusief wanneer gebruikers de waarden sorteren door op de kolomkoppen te klikken. Gebruik de methoden GridControl.addOnLoad en GridControl.removeOnLoad om gebeurtenishandlers te beheren, gewoonlijk in de gebeurtenis Onload voor formulieren.

addOnLoad

Gebruik deze methode om gebeurtenishandlers toe te voegen aan het GridControlGebeurtenis OnLoad.

Parametertype: Functie

Voorbeeld: Voeg de functie myContactsGridOnloadFunction toe aan de gebeurtenis OnLoad van het subraster Contactpersonen.

var myContactsGridOnloadFunction = function () { console.log("Contacts Subgrid OnLoad occurred") };
Xrm.Page.getControl("Contacts").addOnLoad(myContactsGridOnloadFunction);

getEntityName

Gebruik deze methode om de logische naam op te halen van de entiteitsgegevens die worden weergegeven in het raster.

Type retourwaarde: Tekenreeks

Voorbeeld: Stel de variabele opportunitySubgrids in op een matrix van subrasterbesturingselementen die verkoopkansrecords weergeven.

var opportunitySubgrids = Xrm.Page.getControl(function (ctrl, i) {
 if (ctrl.getControlType() == "subgrid") {
  return (ctrl.getEntityName() == "opportunity");
 }
 else {
  return false;
 }
})

getGrid

Gebruik deze methode om toegang te krijgen tot het Raster dat beschikbaar is in het GridControl.

**Type retourwaarde:**Raster

Voorbeeld: Stel de variabele contactsSubgridGrid in op het raster van het subraster Contactpersonen.

var contactsSubgridGrid = Xrm.Page.getControl("Contacts").getGrid();

getViewSelector

Gebruik deze methode om toegang te krijgen tot de ViewSelector die beschikbaar is voor het GridControl.

**Type retourwaarde:**ViewSelector

Voorbeeld: Stel de variabele contactsSubgridViewSelector in op de weergaveselectie van het subraster Contactpersonen.

var contactsSubgridViewSelector = Xrm.Page.getControl("Contacts").getViewSelector();

removeOnLoad

Gebruik deze methode om gebeurtenishandlers te verwijderen uit het GridControlGebeurtenis OnLoad.

Parametertype: Functie

Voorbeeld: Voeg de functie myContactsGridOnloadFunction toe aan de gebeurtenis OnLoad van het subraster Contactpersonen en verwijder deze vervolgens.

var myContactsGridOnloadFunction = function () { console.log("Contacts Subgrid OnLoad occurred") };
Xrm.Page.getControl("Contacts").addOnLoad(myContactsGridOnloadFunction);
Xrm.Page.getControl("Contacts").removeOnLoad(myContactsGridOnloadFunction);

Raster

Gebruik de Grid-methoden voor toegang tot informatie over gegevens in het raster.Grid wordt geretourneerd door de methode GridControl.getGrid.

getRows

Retourneert een verzameling van elke GridRow in het Grid.

Type retourwaarde: Verzameling

Voorbeeld: Stel de variabele allRows in op een verzameling van GridRow vanuit het subraster Contactpersonen.

var allRows = Xrm.Page.getControl("Contacts").getGrid().getRows();

Opmerkingen:

Zie Verzamelingen (clientreferentie) voor informatie over de methoden die beschikbaar zijn om toegang te verkrijgen tot gegevens in een verzameling.

getSelectedRows

Retourneert een verzameling van elke geselecteerde GridRow in het Grid.

Type retourwaarde: Verzameling

Voorbeeld: Vul de variabele selectedEntityReferencesArray met entiteitsverwijzingen voor geselecteerde rijen vanuit het subraster Contactpersonen.

//Get an array of entity references for all selected rows in the subgrid
var selectedEntityReferences = [];
var selectedRows = Xrm.Page.getControl("Contacts").getGrid().getSelectedRows();
selectedRows.forEach(function (selectedRow, i) {
 selectedEntityReferences.push(selectedRow.getData().getEntity().getEntityReference());
});

Opmerkingen:

Zie Verzamelingen (clientreferentie) voor informatie over de methoden die beschikbaar zijn om toegang te verkrijgen tot gegevens in een verzameling.

getTotalRecordCount

In de webtoepassing of de Dynamics CRM voor Outlook-client bij een verbinding met de server, retourneert deze methode het totale aantal records dat overeenkomt met de filtercriteria van de weergave, niet beperkt door het aantal dat zichtbaar is op een enkele pagina.

Als de Dynamics CRM voor Outlook-client niet is verbonden met de server, is dit aantal beperkt tot de records die de gebruikers heeft geselecteerd om mee offline te nemen.

Voor Microsoft Dynamics CRM voor tablets en Microsoft Dynamics CRM voor telefoons retourneert deze methode het aantal records in het subraster.

Type retourwaarde: Getal

Voorbeeld: Stel de variabele filteredRecordCount in op het totale aantal records dat overeenkomt met de filtercriteria van de weergave.

var filteredRecordCount = Xrm.Page.getControl("Contacts").getGrid().getTotalRecordCount();

GridRow

Gebruik de methode **GridRow.**getData om toegang te verkrijgen tot de GridRowData. Een verzameling van GridRow wordt geretourneerd door de methoden **Grid.**getRows en **Grid.**getSelectedRows.

getData

Retourneert de GridRowData voor de GridRow.

**Type retourwaarde:**GridRowData

Voorbeeld: Vul de variabele allGridRowDataArray met GridRowData voor alle rijen vanuit het subraster Contactpersonen.

var allGridRowData = [];
var rows = Xrm.Page.getControl("Contacts").getGrid().getRows();
rows.forEach(function (row, i) {
 allGridRowData.push(row.getData());
});

GridRowData

Gebruik de methode **GridRowData.**getEntity om toegang te verkrijgen tot de GridEntity.GridRowData wordt geretourneerd door de methode **GridRow.**getData.

getEntity

Retourneert de GridEntity voor de GridRowData.

**Type retourwaarde:**GridEntity

Voorbeeld: Vul de variabele allGridEntitiesArray met GridEntity voor alle rijen vanuit het subraster Contactpersonen.

var allGridEntities = [];
var rows = Xrm.Page.getControl("Contacts").getGrid().getRows();
rows.forEach(function (row, i) {
 allGridEntities.push(row.getData().getEntity());
});

GridEntity

Gebruik de methoden GridEntity voor toegang tot gegevens over specifieke records in de rijen.GridEntity wordt geretourneerd door de methode **GridRowData.**getEntity.

getEntityName

Retourneert de logische naam voor de record in de rij.

Type retourwaarde: Tekenreeks

Voorbeeld: Stel de variabele firstEntityType in op de waarde van de logische naam van de entiteit voor de eerste rij in het subraster Contactpersonen.

var firstEntityType = Xrm.Page.getControl("Contacts").getGrid().getRows().get(0).getData().getEntity().getEntityName();
// firstEntityType == "contact"

getEntityReference

Type retourwaarde: Opzoekveld

Voorbeeld: Stel de variabele firstEntityType in op een entiteitsverwijzing voor de eerste rij in het subraster Contactpersonen.

var firstEntityReference = Xrm.Page.getControl("Contacts").getGrid().getRows().get(0).getData().getEntity().getEntityReference();
// firstEntityReference.entityType == "contact"
// firstEntityReference.id == "{13CD16BD-3EC4-E411-80CF-00155DB58496}"
// firstEntityReference.name == "Rene Valdes (sample)"

Opmerkingen:

Dit opzoekveld heeft de volgende eigenschappen:

Naam

Type

Beschrijving

entityType

Tekenreeks

De logische naam voor de record in de rij. Dezelfde gegevens als worden geretourneerd door de methode GridEntity.getEntityName.

id

Tekenreeks

De id voor de record in de rij. Dezelfde gegevens als worden geretourneerd door de methode GridEntity.getId.

naam

Tekenreeks

De primaire kenmerkwaarde voor de record in de rij. Dezelfde gegevens als worden geretourneerd door de methode GridEntity.getPrimaryAttributeValue.

getId

Retourneert de id voor de record in de rij.

Type retourwaarde: Tekenreeks

Voorbeeld: Stel de variabele firstEntityId in op de waarde van de id van de record voor de eerste rij in het subraster Contactpersonen.

var firstEntityId = Xrm.Page.getControl("Contacts").getGrid().getRows().get(0).getData().getEntity().getId();
// firstEntityId == "{13CD16BD-3EC4-E411-80CF-00155DB58496}"

getPrimaryAttributeValue

Retourneert de primaire kenmerkwaarde voor de record in de rij.

Type retourwaarde: Tekenreeks

Voorbeeld: Stel de variabele currentView in op de huidige weergave van de weergaveselectie voor het subraster Contactpersonen.

var firstEntityPrimaryAttributeValue = Xrm.Page.getControl("Contacts").getGrid().getRows().get(0).getData().getEntity().getPrimaryAttributeValue();
// firstEntityPrimaryAttributeValue == "Rene Valdes (sample)"

ViewSelector

Gebruik de ViewSelector-methoden om informatie over de weergaveselectie van het subraster Contactpersonen op te halen of in te stellen.

Notitie

Als het subrasterbesturingselement niet is geconfigureerd voor het weergeven van de weergaveselectie, treedt er een fout op bij het aanroepen van de ViewSelector-methoden.

getCurrentView

Gebruik deze methode om een verwijzing naar de huidige weergave op te halen.

Type retourwaarde: Opzoekobject

Voorbeeld: Stel de variabele currentView in op de huidige weergave van de weergaveselectie voor het subraster Contactpersonen.

var currentView = Xrm.Page.getControl("Contacts").getViewSelector().getCurrentView();

Opmerkingen:

Als het subrasterbesturingselement niet is geconfigureerd voor het weergeven van de weergaveselectie, treedt er een fout op bij het aanroepen van de ViewSelector die wordt geretourneerd door de methode GridControl.getViewSelector.

isVisible

Gebruik deze methode om te bepalen of de weergaveselectie zichtbaar is.

Type retourwaarde: Boole-waarde

Voorbeeld: Stel de variabele viewSelectorIsVisible in om de zichtbaarheidsstatus van de weergaveselectie voor het subraster Contactpersonen weer te geven.

var viewSelectorIsVisible = Xrm.Page.getControl("Contacts").getViewSelector().isVisible();

Opmerkingen:

Als het subrasterbesturingselement niet is geconfigureerd voor het weergeven van de weergaveselectie, treedt er een fout op bij het aanroepen van de ViewSelector die wordt geretourneerd door de methode GridControl.getViewSelector.

setCurrentView

Gebruik deze methode om een verwijzing naar de huidige weergave in te stellen.

Parametertype: Opzoekobject

Voorbeeld: Stel de variabele ContactsIFollow in op de huidige weergave van het subraster Contactpersonen.

var ContactsIFollow = {
 entityType: 1039, // SavedQuery
 id:"{3A282DA1-5D90-E011-95AE-00155D9CFA02}", 
 name: "Contacts I Follow"
}
//Set the view using ContactsIFollow
Xrm.Page.getControl("Contacts").getViewSelector().setCurrentView(ContactsIFollow);

Opmerkingen:

Als het subrasterbesturingselement niet is geconfigureerd voor het weergeven van de weergaveselectie, treedt er een fout op bij het aanroepen van de ViewSelector die wordt geretourneerd door de methode GridControl.getViewSelector.

Dit opzoekveld heeft de volgende eigenschappen:

Naam

Type

Beschrijving

entityType

Nummer

De objecttypecode voor de SavedQuery (1039) of UserQuery (4230) die de weergave vertegenwoordigt die de gebruiker kan selecteren.

id

Tekenreeks

De id voor de weergave die de gebruiker kan selecteren.

naam

Tekenreeks

De naam van de weergave die de gebruiker kan selecteren.

Zie ook

Nieuwe functies in Microsoft Dynamics CRM Online 2015 Update 1
Scripts schrijven voor subrasters
Xrm.Page.ui control (referentie aan de clientzijde)
Verzamelingen (clientreferentie)
Programmeerreferentie op de client
Code schrijven voor Microsoft Dynamics CRM 2015-formulieren
Uitbreidingen van clienttoepassingen schrijven

© 2017 Microsoft. Alle rechten voorbehouden. Auteursrecht