BCS-Client-Objektmodellreferenz für SharePointBCS client object model reference for SharePoint

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.Learn about the objects that are available for creating client-side scripts using the SharePoint client object model to access external data exposed by Business Connectivity Services (BCS). The following objects are available for creating client-side scripts using the SharePoint client object model to access external data that is exposed by Business Connectivity Services (BCS). The BCS object model components that are exposed to the client object model are located in Microsoft.SharePoint.Client.dll.

Entity-ObjektEntity object

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.The Entity object essentially represents a table in a database. The methods and properties presented here show the objects that can be manipulated through the use of the client code library. Each of these calls maps directly to a server object model call. However, they are callable by a detached client, such as in a web browser using JavaScript.

MethodenMethods

MethodenMethods MethodensignaturMethod signature ****Description****Description
CreateCreate
Identity Create(FieldValueDictionary fieldValues, LobSystemInstance lobSystemInstanceName)
FindSpecificDefaultFindSpecificDefault
EntityInstance FindSpecificDefault(Identity identity, LobSystemInstance lobSystemInstanceName)
FindspecificByBdcIDDefaultFindspecificByBdcIDDefault
EntityInstance FindSpecific(Identity identity, string specificFinderName, LobSystemInstance lobSystemInstanceName)
FindSpecificByBdcIDFindSpecificByBdcID
EntityInstance FindSpecificByBdcIDDefault(string BdcIdentity, LobSystemInstance lobSystemInstanceName)
GetCreatorViewGetCreatorView
EntityInstance FindSpecificByBdcID(string BdcIdentity, string specificFinderName,LobSystemInstance LobSystemInstanceName)
GetDefaultSpecificFinderViewGetDefaultSpecificFinderView
View GetCreatorView(string methodInstanceName)
GetSpecificFinderView_ClientGetSpecificFinderView_Client
View GetDefaultSpecificFinderView()
GetUpdaterView_ClientGetUpdaterView_Client
View GetSpecificFinderView_Client( string specificFinderName)
GetIdentifiersGetIdentifiers
View GetUpdaterView_Client(string updaterName)
GetIdentifiers()GetIdentifiers()

EigenschaftenProperties

EigenschaftProperty BeschreibungDescription
long EstimatedInstanceCount { get; }
Ruft die Anzahl der erwarteten externen Elemente dieses externen Inhaltstyps ab.Gets the number of expected external items of this external content type.
string Name { get; }
Ruft den Namen des Metadatenobjekts ab.Gets the name of the metadata object.
string Namespace { get; }
Ruft den Namespace der angegebenen Daten-Klasse.Gets the namespace of the given data class.
int GetIdentifierCount()

EntityInstance-MethodeEntityInstance method

NamespacesNamespaces

VerwaltetManaged JavaScriptJavaScript
Microsoft.BusinessData.RuntimeMicrosoft.BusinessData.Runtime
SP.BusinessData.RuntimeSP.BusinessData.Runtime

MethodenMethods

MethodeMethod RückgabetypReturn type BeispieleDescription
DeleteDelete
voidvoid
Löscht das externe Element.Deletes the External Item.
FromXmlFromXml
voidvoid
Die Werte festgelegt aus der angegebenen XML in diesem Wörterbuch.Sets the values in this dictionary from specified XML.
Methodensignatur FromXml(string xml)Method signature FromXml(string xml)
GetIdentityGetIdentity
IdentitätIdentity
Ruft die Identität des externen Elements ab.Gets the identity of this External Item.
DeleteDelete
voidvoid
Löscht das externe Element.Deletes the External Item.
ToXmlToXml
Zeichenfolgestring
Ruft die Werte im XML-Format ab.Retrieves the values in XML format.
UpdateUpdate
voidvoid
Sendet Änderungen an externen Elements an.Submits the changes made to the External Item.

EigenschaftenProperties

EigenschaftProperty RückgabetypReturn type DescriptionDescription
this[string fieldDotNotation] { get; set; }
ObjektObject
Dient zum Abrufen oder Festlegen des Werts des Felds, die durch die punktierte Schreibweise bezeichnet wird.Gets or sets the value of the field referred to by the dot notation.
RelatedSpecificFinderName { get; }
stringstring

EntityView-MethodeEntityView method

Gibt eine benutzerdefinierte Ansicht der Entität DatenSpecifies a customized view of the Entity data

NamespacesNamespaces

VerwaltetManaged JavaScriptJavaScript
Microsoft.BusinessData.MetadataModelMicrosoft.BusinessData.MetadataModel
SP.BusinessDataSP.BusinessData

MethodenMethods

MethodeMethod RückgabetypReturn type BeschreibungDescription
GetDefaultValues_Client()GetDefaultValues_Client()
FieldValueDictionaryFieldValueDictionary
Ruft ein Wörterbuch der Feld-Wert, der die Standardwerte für diese Ansicht enthält.Gets a field value dictionary that contains the default values for this view.
GetXmlSchema()GetXmlSchema()
Zeichenfolgestring
Ruft das XML-Schema der Ansicht ab.Gets the XML Schema of the view.
GetType(string fieldDotNotation)GetType(string fieldDotNotation)
Zeichenfolgestring
Ruft den Typ des angegebenen Felds ab.Gets the type of the specified field.
GetType(string fieldDotNotation)GetType(string fieldDotNotation)
TypeDescriptorTypeDescriptor
Ruft das TypeDescriptor -Objekt, das die angegebene punktierte Schreibweise entspricht.Gets the TypeDescriptor object that corresponds to the given dot notation.

EigenschaftenProperties

EigenschaftProperty RückgabetypReturn type BeschreibungDescription
Fields { get; }
FieldCollectionFieldCollection
Ruft die Auflistung von Feldern in der Ansicht ab.Gets the collection of fields in the view.
Name { get; }
Zeichenfolgestring
Ruft den Namen dieses View -ObjektsGets the name of this View object
RelatedSpecificFinderName { get; }
Zeichenfolgestring
Ruft den Namen der spezifischen Finder- MethodInstance, die in dieser Ansicht an gebunden ist.Retrieves the name of the specific finder MethodInstance that this view is tied to.

LobSystem-MethodeLobSystem method

NamespacesNamespaces

VerwaltetManaged JavaScriptJavaScript
Microsoft.BusinessData.MetadataModelMicrosoft.BusinessData.MetadataModel
SP.BusinessDataSP.BusinessData

MethodenMethods

MethodeMethod RückgabetypReturn type DescriptionDescription
GetLobSystemInstances()GetLobSystemInstances()
voidvoid
Gibt die Liste der LOB-Systeminstanzen an.Gives the list of LOB system instances.
NameName
voidvoid
Ruft den Namen der LobSystemab.Gets the name of the LobSystem.

EigenschaftenProperties

EigenschaftProperty BeschreibungDescription
Keine.None.

LobSystemInstance-MethodeLobSystemInstance method

NamespacesNamespaces

VerwaltetManaged JavaScriptJavaScript
Microsoft.BusinessData.MetadataModelMicrosoft.BusinessData.MetadataModel
SP.BusinessDataSP.BusinessData

MethodenMethods

MethodeMethod RückgabetypReturn type DescriptionDescription
Keine.None.
voidvoid

EigenschaftenProperties

EigenschaftProperty BeschreibungDescription
Keine.None.

ID-MethodeIdentifier method

NamespacesNamespaces

VerwaltetManaged JavaScriptJavaScript
Microsoft.BusinessData.MetadataModelMicrosoft.BusinessData.MetadataModel
SP.BusinessDataSP.BusinessData

MethodenMethods

MethodeMethod RückgabetypReturn type DescriptionDescription
ContainsLocalizedDisplayNameContainsLocalizedDisplayName
boolbool
Bestimmt, ob das Metadatenobjekt lokalisierten Anzeigenamen enthält.Determines whether the metadata object contains localized display name.
GetDefaultDisplayNameGetDefaultDisplayName
Zeichenfolgestring
Der standardmäßige Anzeigename zurückgegeben.Returns the default display name.
GetLocalizedDisplayNameGetLocalizedDisplayName
Zeichenfolgestring
Gibt den lokalisierten Anzeigenamen zurück.Returns the localized display name.

EigenschaftenProperties

EigenschaftProperty RückgabetypReturn type DescriptionDescription
IdentifierType {get;}
Stringstring
Gibt den Typ des Bezeichners.Returns the type of identifier.
Name {get;}
Zeichenfolgestring
Ruft den Namen des Bezeichners ab.Gets the name of the identifier.

IdentifierCollection-MethodeIdentifierCollection method

NamespacesNamespaces

VerwaltetManaged JavaScriptJavaScript
Microsoft.BusinessData.MetadataModel.CollectionsMicrosoft.BusinessData.MetadataModel.Collections
SP.BusinessData.CollectionsSP.BusinessData.Collections

MethodenMethods

MethodeMethod RückgabetypReturn type DescriptionDescription
Keine.None.
voidvoid

EigenschaftenProperties

EigenschaftProperty BeschreibungDescription
Keine.None.

Identity-MethodeIdentity method

NamespacesNamespaces

VerwaltetManaged JavaScriptJavaScript
Microsoft.BusinessData.RuntimeMicrosoft.BusinessData.Runtime
SP.BusinessData.RuntimeSP.BusinessData.Runtime

KonstruktorConstructor

KonstruktorConstructor BeschreibungDescription
public Identity (Object[] identifierValues)
Erstellt eine neue Instanz der Klasse mithilfe von ein Array von ID-Werte.Constructs a new instance of the class by using an array of identifier values.

MethodenMethods

MethodeMethod RückgabetypReturn type DescriptionDescription
SerializeSerialize
Zeichenfolgestring
Ruft eine Zeichenfolgendarstellung der Identität ab.Gets a string representation of the identity.

EigenschaftenProperties

EigenschaftProperty RückgabetypReturn type BeschreibungDescription
IdentifierCount { get; }
intint
Gibt die Anzahl der Bezeichner zurück.Returns the number of identifiers.
IsTemporary { get; }
boolbool
Überprüft, ob die Identität temporär ist.Checks whether the identity is temporary.
this[int identifierIndex] { get; }
ObjektObject
Ruft das Element am angegebenen Index ab. CSOM unterstützt Int-basierte Indizierung nicht. Basis-Accessor für den gleichen implementiert.Retrieves the element at the given index. CSOM does not support int-based indexing. String-based accessor implemented for the same.
TemporaryId { get; }
GuidGuid
Gibt den temporären Teil der Identität zurück.Returns the temporary part of the identity.

Abgerufenen "FieldValueDictionary"-MethodeFieldValueDictionary method

NamespacesNamespaces

VerwaltetManaged JavaScriptJavaScript
Microsoft.BusinessData.RuntimeMicrosoft.BusinessData.Runtime
SP.BusinessData.RuntimeSP.BusinessData.Runtime

MethodenMethods

MethodeMethod RückgabetypReturn type DescriptionDescription
FromXmlFromXml
voidvoid
Die Werte festgelegt aus der angegebenen XML in diesem Wörterbuch.Sets the values in this dictionary from specified XML.
GetCollectionSizeGetCollectionSize
intint
Gibt die Größe der Auflistung, der auf die punktierte Schreibweise verweist.Returns the size of the collection that the dot notation refers to.
ToXmlToXml
Zeichenfolgestring
Ruft die Werte im XML-Format ab.Retrieves the values in XML format.

EigenschaftenProperties

EigenschaftProperty BeschreibungDescription
Object this[string fieldDotNotation] { get; set; }
Dient zum Abrufen oder Festlegen des Werts des Felds, die durch die punktierte Schreibweise bezeichnet wird.Gets or sets the value of the field referred to by the dot notation.

EntityFieldCollection-MethodeEntityFieldCollection method

NamespacesNamespaces

VerwaltetManaged JavaScriptJavaScript
Microsoft.BusinessData.RuntimeMicrosoft.BusinessData.Runtime
SP.BusinessData.RuntimeSP.BusinessData.Runtime

MethodenMethods

MethodeMethod RückgabetypReturn type DescriptionDescription
Keine.None.
voidvoid

EigenschaftenProperties

EigenschaftProperty BeschreibungDescription
Keine.None.

EntityField-MethodeEntityField method

NamespacesNamespaces

VerwaltetManaged JavaScriptJavaScript
Microsoft.BusinessData.RuntimeMicrosoft.BusinessData.Runtime
SP.BusinessData.RuntimeSP.BusinessData.Runtime

MethodenMethods

MethodeMethod RückgabetypReturn type DescriptionDescription
Keine.None.
voidvoid

EigenschaftenProperties

EigenschaftProperty RückgabetypReturn type SchreibgeschütztRead Only BeschreibungDescription
ContainsLocalizedDisplayNameContainsLocalizedDisplayName
BooleanBoolean
JaYes
Bestimmt, ob das Feld einen lokalisierten Anzeigenamen enthält.Determines whether the field contains a localized display name.
DefaultDisplayNameDefaultDisplayName
Zeichenfolgestring
JaYes
Der standardmäßige Anzeigename des Felds abgerufen.Retrieves the default display name of the Field.
GetLocalizedDisplayNameGetLocalizedDisplayName
Zeichenfolgestring
Ruft den lokalisierten Anzeigenamen des Felds ab.Retrieves the localized display name of the Field.
NameName
Zeichenfolgestring
JaYes
Ruft den Namen des Felds ab.Retrieves the name of the Field.

TypeDescriptor-KlasseTypeDescriptor class

NamespacesNamespaces

VerwaltetManaged JavaScriptJavaScript
Microsoft.BusinessData.MetadataModelMicrosoft.BusinessData.MetadataModel
SP.BusinessDataSP.BusinessData

MethodenMethods

MethodeMethod RückgabetypReturn type SchreibgeschütztRead Only BeschreibungDescription
ContainsLocalizedDisplayName()ContainsLocalizedDisplayName()
BooleanBoolean
JaYes
Bestimmt, ob der Typdeskriptor einen lokalisierten Anzeigenamen enthält.Determines whether the type descriptor contains a localized display name.
GetLocalizedDisplayName()GetLocalizedDisplayName()
Zeichenfolgestring
JaYes
Gibt den lokalisierten Anzeigenamen zurück.Returns the localized display name.
GetDefaultDisplayName()GetDefaultDisplayName()
Zeichenfolgestring
Der standardmäßige Anzeigename zurückgegeben.Returns the default display name.

EigenschaftenProperties

EigenschaftProperty RückgabetypReturn type BeschreibungDescription
NameName
stringstring
Ruft den Namen des Felds ab.Retrieves the name of the Field.
TypeNameTypeName
stringstring
Ruft den Namen des Datentyps durch diesen Typdeskriptor dargestellt.Retrieves the name of the data type represented by this type descriptor.
IsReadOnlyIsReadOnly
Boolescher WertBoolean
Bestimmt, ob dieser Typdeskriptor eine nur-Lese-Datenstruktur darstellt.Determines whether this type descriptor represents a read-only data structure.
ContainsReadOnlyContainsReadOnly
Boolescher WertBoolean
Bestimmt, ob dieser Typdeskriptor oder eines der untergeordneten eine nur-Lese-Datenstruktur darstellen.Determines whether this type descriptor or one of its children represent a read-only data structure.
IsCollectionIsCollection
BooleanBoolean
Bestimmt, ob der beschriebene Typ eine Datenstruktur Auflistung darstellt.Determines whether the described type represents a collection data structure.

SchnittstellenInterfaces

Der Namespace ist Microsoft.BusinessData.MetadataModel.The namespace is Microsoft.BusinessData.MetadataModel.

SchnittstelleInterface BeschreibungDescription
IMetadataCatalogIMetadataCatalog
Der Einstiegspunkt in das BDC-Objektmodell. Verwenden Sie die DatabaseBasedMetadataCatalog auf dem Server.The entry point into the BDC object model. Use the DatabaseBasedMetadataCatalog on the server.
ILobSystemILobSystem
Enthält die Details zu einem externen System.Contains the details about an external system.
IEntityIEntity
Ein externer Inhaltstyp im BDC-Metadatenspeicher.An external content type in the BDC Metadata Store.
IMethodIMethod
Ein Vorgang, der für den externen Inhaltstyp ausgeführt werden kann.An operation that can be performed on the external content type.
IEntityInstanceIEntityInstance
Eine Entitätsinstanz (auch bekannt als externes Element) ist ein einzelnes Element in einem externen System im BDC zurückgegeben.An entity instance (also known as external item) is a single item returned from an external system in BDC.
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. The IEntityInstance interface abstracts the underlying data sources and insulates the clients from having to learn application-specific coding paradigms; it enables them to access all business data in a single, simplified way. By using the IEntityInstance interface, you can work with a row of data from a database in just the same way as working with a complex .NET Framework structure returned by a web service.
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. An entity instance in BDC has special semantics attached to it. For example, it has the ability to know which field or fields in the row represent the identifier for the entity instance, and it enables you to call methods, such as GetAssociated, GetIdentifierValues, and Execute, on that entity instance.
IEntityInstanceEnumeratorIEntityInstanceEnumerator
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.Enumerators can be used to read the data in the external items collection, but they cannot be used to modify the underlying collection. IEntityInstanceEnumerator supports streaming and is therefore very useful when the back-end application returns large amounts of data.

Client Object Model - häufig gestellte FragenClient Object model FAQ

  • Does the tag need to be included in a CAML query when querying an external listDoes the tag need to be included in a CAML query when querying an external list

    Nein.No.

  • Müssen alle Felder in der externen Liste in der CAML-Abfrage angegeben werden?Do all fields in the external list need to be specified in the CAML query?

    Ü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.Using the ViewXML tag in the BDC model, the developer can specify only those fields that are required and the CSOM APIs for Lists will return only those fields.

Siehe auchSee also