Freigeben über

BCS-Client-Objektmodellreferenz für SharePoint

  • Artikel

Klassenbibliotheken und -verweise

Informationen Sie zu den Objekten, die für das Erstellen von clientseitigen Skripts mithilfe des Clientobjektmodells SharePoint Zugriff auf externe Daten verfügbar gemacht werden, indem Business Connectivity Services (BCS) verfügbar sind. Die folgenden Objekte stehen für die Erstellung von clientseitigen Skripts mithilfe des Clientobjektmodells SharePoint Zugriff auf externe Daten, die von Business Connectivity Services (BCS) verfügbar gemacht wird. Die BCS-Objektmodell Komponenten, die dem Client-Objektmodell verfügbar gemacht werden, in denen Microsoft.SharePoint.Client.dll befinden.

Entity-Objekt

Das Entity -Objekt stellt im Wesentlichen eine Tabelle in einer Datenbank. Die Methoden und Eigenschaften, die hier aufgeführten die Objekte anzeigen, die bearbeitet werden können durch Verwendung der Clientbibliothek Code. Jede dieser Anrufe ordnet direkt zu einem Modell-Anruf von Server-Objekt. Jedoch können sie von einem getrennten Client, wie in einem Webbrowser mit JavaScript aufgerufen werden.

Methoden

Methoden Methodensignatur Beschreibung
Create
Identity Create(FieldValueDictionary fieldValues, LobSystemInstance lobSystemInstanceName)
FindSpecificDefault
EntityInstance FindSpecificDefault(Identity identity, LobSystemInstance lobSystemInstanceName)
FindspecificByBdcIDDefault
EntityInstance FindSpecific(Identity identity, string specificFinderName, LobSystemInstance lobSystemInstanceName)
FindSpecificByBdcID
EntityInstance FindSpecificByBdcIDDefault(string BdcIdentity, LobSystemInstance lobSystemInstanceName)
GetCreatorView
EntityInstance FindSpecificByBdcID(string BdcIdentity, string specificFinderName,LobSystemInstance LobSystemInstanceName)
GetDefaultSpecificFinderView
View GetCreatorView(string methodInstanceName)
GetSpecificFinderView_Client
View GetDefaultSpecificFinderView()
GetUpdaterView_Client
View GetSpecificFinderView_Client( string specificFinderName)
GetIdentifiers
View GetUpdaterView_Client(string updaterName)
GetIdentifiers()

Eigenschaften

Eigenschaft Beschreibung
long EstimatedInstanceCount { get; }
Ruft die Anzahl der erwarteten externen Elemente dieses externen Inhaltstyps ab.
string Name { get; }
Ruft den Namen des Metadatenobjekts ab.
string Namespace { get; }
Ruft den Namespace der angegebenen Daten-Klasse.
int GetIdentifierCount()

EntityInstance-Methode

Namespaces

Verwaltet JavaScript
Microsoft.BusinessData.Runtime
SP.BusinessData.Runtime

Methoden

Methode Rückgabetyp Beschreibung
Delete
void
 Löscht das externe Element.
FromXml
void
 Die Werte festgelegt aus der angegebenen XML in diesem Wörterbuch.
MethodensignaturFromXml(string xml)
GetIdentity
Identität
 Ruft die Identität des externen Elements ab.
Delete
void
 Löscht das externe Element.
ToXml
string
 Ruft die Werte im XML-Format ab.
Update
void
 Sendet Änderungen an externen Elements an.

Eigenschaften

Eigenschaft Rückgabetyp Beschreibung
this[string fieldDotNotation] { get; set; }
Objekt
 Dient zum Abrufen oder Festlegen des Werts des Felds, die durch die punktierte Schreibweise bezeichnet wird.
RelatedSpecificFinderName { get; }
string

EntityView-Methode

Gibt eine benutzerdefinierte Ansicht der Entität Daten

Namespaces

Verwaltet JavaScript
Microsoft.BusinessData.MetadataModel
SP.BusinessData

Methoden

Methode Rückgabetyp Beschreibung
GetDefaultValues_Client()
FieldValueDictionary
Ruft ein Wörterbuch der Feld-Wert, der die Standardwerte für diese Ansicht enthält.
GetXmlSchema()
Zeichenfolge
Ruft das XML-Schema der Ansicht ab.
GetType(string fieldDotNotation)
Zeichenfolge
Ruft den Typ des angegebenen Felds ab.
GetType(string fieldDotNotation)
TypeDescriptor
Ruft das TypeDescriptor -Objekt, das die angegebene punktierte Schreibweise entspricht.

Eigenschaften

Eigenschaft Rückgabetyp Beschreibung
Fields { get; }
FieldCollection
Ruft die Auflistung von Feldern in der Ansicht ab.
Name { get; }
Zeichenfolge
Ruft den Namen dieses View -Objekts
RelatedSpecificFinderName { get; }
Zeichenfolge
Ruft den Namen der spezifischen Finder- MethodInstance, die in dieser Ansicht an gebunden ist.

LobSystem-Methode

Namespaces

Verwaltet JavaScript
Microsoft.BusinessData.MetadataModel
SP.BusinessData

Methoden

Methode Rückgabetyp Beschreibung
GetLobSystemInstances()
void
Gibt die Liste der LOB-Systeminstanzen an.
Name
void
Ruft den Namen der LobSystemab.

Eigenschaften

Eigenschaft Beschreibung
Keine.

LobSystemInstance-Methode

Namespaces

Verwaltet JavaScript
Microsoft.BusinessData.MetadataModel
SP.BusinessData

Methoden

Methode Rückgabetyp Beschreibung
Keine.
void

Eigenschaften

Eigenschaft Beschreibung
Keine.

ID-Methode

Namespaces

Verwaltet JavaScript
Microsoft.BusinessData.MetadataModel
SP.BusinessData

Methoden

Methode Rückgabetyp Beschreibung
ContainsLocalizedDisplayName
bool
Bestimmt, ob das Metadatenobjekt lokalisierten Anzeigenamen enthält.
GetDefaultDisplayName
Zeichenfolge
Der standardmäßige Anzeigename zurückgegeben.
GetLocalizedDisplayName
Zeichenfolge
Gibt den lokalisierten Anzeigenamen zurück.

Eigenschaften

Eigenschaft Rückgabetyp Beschreibung
IdentifierType {get;}
Zeichenfolge
Gibt den Typ des Bezeichners.
Name {get;}
Zeichenfolge
Ruft den Namen des Bezeichners ab.

IdentifierCollection-Methode

Namespaces

Verwaltet JavaScript
Microsoft.BusinessData.MetadataModel.Collections
SP.BusinessData.Collections

Methoden

Methode Rückgabetyp Beschreibung
Keine.
void

Eigenschaften

Eigenschaft Beschreibung
Keine.

Identity-Methode

Namespaces

Verwaltet JavaScript
Microsoft.BusinessData.Runtime
SP.BusinessData.Runtime

Konstruktor

Konstruktor Beschreibung
public Identity (Object[] identifierValues)
Erstellt eine neue Instanz der Klasse mithilfe von ein Array von ID-Werte.

Methoden

Methode Rückgabetyp Beschreibung
Serialize
Zeichenfolge
Ruft eine Zeichenfolgendarstellung der Identität ab.

Eigenschaften

Eigenschaft Rückgabetyp Beschreibung
IdentifierCount { get; }
int
Gibt die Anzahl der Bezeichner zurück.
IsTemporary { get; }
bool
Überprüft, ob die Identität temporär ist.
this[int identifierIndex] { get; }
Objekt
Ruft das Element am angegebenen Index ab. CSOM unterstützt Int-basierte Indizierung nicht. Basis-Accessor für den gleichen implementiert.
TemporaryId { get; }
Guid
Gibt den temporären Teil der Identität zurück.

Abgerufenen "FieldValueDictionary"-Methode

Namespaces

Verwaltet JavaScript
Microsoft.BusinessData.Runtime
SP.BusinessData.Runtime

Methoden

Methode Rückgabetyp Beschreibung
FromXml
void
Die Werte festgelegt aus der angegebenen XML in diesem Wörterbuch.
GetCollectionSize
int
 Gibt die Größe der Auflistung, der auf die punktierte Schreibweise verweist.
ToXml
string
 Ruft die Werte im XML-Format ab.

Eigenschaften

Eigenschaft Beschreibung
Object this[string fieldDotNotation] { get; set; }
Dient zum Abrufen oder Festlegen des Werts des Felds, die durch die punktierte Schreibweise bezeichnet wird.

EntityFieldCollection-Methode

Namespaces

Verwaltet JavaScript
Microsoft.BusinessData.Runtime
SP.BusinessData.Runtime

Methoden

Methode Rückgabetyp Beschreibung
Keine.
void

Eigenschaften

Eigenschaft Beschreibung
Keine.

EntityField-Methode

Namespaces

Verwaltet JavaScript
Microsoft.BusinessData.Runtime
SP.BusinessData.Runtime

Methoden

Methode Rückgabetyp Beschreibung
Keine.
void

Eigenschaften

Eigenschaft Rückgabetyp Schreibgeschützt Beschreibung
ContainsLocalizedDisplayName
Boolean
Ja
 Bestimmt, ob das Feld einen lokalisierten Anzeigenamen enthält.
DefaultDisplayName
Zeichenfolge
Ja
 Der standardmäßige Anzeigename des Felds abgerufen.
GetLocalizedDisplayName
Zeichenfolge
Ruft den lokalisierten Anzeigenamen des Felds ab.
Name
Zeichenfolge
Ja
 Ruft den Namen des Felds ab.

TypeDescriptor-Klasse

Namespaces

Verwaltet JavaScript
Microsoft.BusinessData.MetadataModel
SP.BusinessData

Methoden

Methode Rückgabetyp Schreibgeschützt Beschreibung
ContainsLocalizedDisplayName()
Boolean
Ja
 Bestimmt, ob der Typdeskriptor einen lokalisierten Anzeigenamen enthält.
GetLocalizedDisplayName()
Zeichenfolge
Ja
 Gibt den lokalisierten Anzeigenamen zurück.
GetDefaultDisplayName()
Zeichenfolge
Der standardmäßige Anzeigename zurückgegeben.

Eigenschaften

Eigenschaft Rückgabetyp Beschreibung
Name
string
 Ruft den Namen des Felds ab.
TypeName
string
 Ruft den Namen des Datentyps durch diesen Typdeskriptor dargestellt.
IsReadOnly
Boolescher Wert
 Bestimmt, ob dieser Typdeskriptor eine nur-Lese-Datenstruktur darstellt.
ContainsReadOnly
Boolean
 Bestimmt, ob dieser Typdeskriptor oder eines der untergeordneten eine nur-Lese-Datenstruktur darstellen.
IsCollection
Boolean
 Bestimmt, ob der beschriebene Typ eine Datenstruktur Auflistung darstellt.

Schnittstellen

Der Namespace ist Microsoft.BusinessData.MetadataModel.

Schnittstelle Beschreibung
IMetadataCatalog
Der Einstiegspunkt in das BDC-Objektmodell. Verwenden Sie die DatabaseBasedMetadataCatalog auf dem Server.
ILobSystem
Enthält die Details zu einem externen System.
IEntity
Ein externer Inhaltstyp im BDC-Metadatenspeicher.
IMethod
Ein Vorgang, der für den externen Inhaltstyp ausgeführt werden kann.
IEntityInstance
Eine Entitätsinstanz (auch bekannt als externes Element) ist ein einzelnes Element in einem externen System im BDC zurückgegeben.
Die Schnittstelle IEntityInstance abstrahiert die zugrunde liegenden Datenquellen und isoliert von anwendungsspezifischen Codierung Paradigmen erfahren, dass die Clients; Sie können alle Geschäftsdaten in eine einzige, vereinfachte Möglichkeit zugreifen. Mithilfe der IEntityInstance -Schnittstelle können Sie mit einer Reihe von Daten aus einer Datenbank in genauso wie Arbeiten mit einer komplexen .NET Framework-Struktur, die von einem Webdienst zurückgegeben arbeiten.
Eine Entitätsinstanz im BDC-hat spezielle Semantik angefügt. Er hat die Möglichkeit, wissen, welches Feld oder Felder in der Zeile den Bezeichner für die Entitätsinstanz darstellen, und es ermöglicht Ihnen das Aufrufen von Methoden, wie GetAssociated, GetIdentifierValuesund Execute, für diese Entitätsinstanz.
IEntityInstanceEnumerator
Enumeratoren zum Lesen der Daten in der externen Items-Auflistung verwendet werden, jedoch nicht zum Ändern der zugrunde liegenden Auflistung verwendet werden. IEntityInstanceEnumerator unterstützt streaming und ist daher sehr nützlich, wenn die Back-End-Anwendung große Datenmengen zurückgibt.

Client Object Model - häufig gestellte Fragen

  • Muss das <Method-Tag> beim Abfragen einer externen Liste in eine CAML-Abfrage eingeschlossen werden?

    Nein.

  • Müssen alle Felder in der externen Liste in der CAML-Abfrage angegeben werden?

    Über den ViewXML-Tag im BDC-Modell der Entwickler kann angeben, dass nur die Felder, die erforderlich sind, und die CSOM-APIs für Listen gibt nur die Felder zurück.

Siehe auch