Home Library Learn Samples Downloads Support Community Forums
MSDN Library
.NET Development
WCF Data Services 5.0
OData Library
Microsoft.Data.Edm
ExtensionMethods Class
ExtensionMethods Methods
BaseComplexType Method
BaseEntityType Method
BaseType Method
CollectionDefinition Method
ComplexDefinition Method
DeclaredNavigationProperties Method
DeclaredStructuralProperties Method
DeclaringEntityType Method
DirectValueAnnotations Method
ElementType Method
EntityContainers Method
EntityDefinition Method
EntityReferenceDefinition Method
EntitySets Method
EntityType Method
EnumDefinition Method
FindEntityContainer Method
FindFunctions Method
FindNavigationProperty Method
FindProperty Method
FindPropertyBinding Method
FindType Method
FindValueTerm Method
FindVocabularyAnnotations Method
FindVocabularyAnnotationsIncludingInheritedAnnotations Method
FullName Method
FunctionImports Method
GetAnnotationValue Method
GetAnnotationValues Method
GetDocumentation Method
GetEdmVersion Method
GetPropertyValue Method
GetTermValue Method
IsAbstract Method
IsOpen Method
Key Method
Location Method
Multiplicity Method
NavigationProperties Method
PrimitiveDefinition Method
PrimitiveKind Method
Properties Method
RowDefinition Method
SchemaElementsAcrossModels Method
SetAnnotationValue Method
SetAnnotationValues Method
SetDocumentation Method
SetEdmVersion Method
StructuralProperties Method
StructuredDefinition Method
ToEntityType Method
TryGetRelativeEntitySetPath Method
TryGetStaticEntitySet Method
TypeKind Method
TypeTerm Method
ValueTerm Method
VocabularyAnnotations Method
Expand Minimize
This topic has not yet been rated - Rate this topic

GetDocumentation Method

WCF Data Services 5.0

Gets documentation for a specified element.

Namespace:  Microsoft.Data.Edm
Assembly:  Microsoft.Data.Edm (in Microsoft.Data.Edm.dll)
C#
C++
F#
JScript
VB
Copy 
public static IEdmDocumentation GetDocumentation(
	this IEdmModel model,
	IEdmElement element
)

Parameters

model
Type: Microsoft.Data.Edm..::..IEdmModel
The model containing the documentation.
element
Type: Microsoft.Data.Edm..::..IEdmElement
The element.

Return Value

Type: Microsoft.Data.Edm..::..IEdmDocumentation
The documentation that exists on the element. Otherwise, null.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEdmModel. When you use instance method syntax to call this method, omit the first parameter. For more information, see http://msdn.microsoft.com/en-us/library/bb384936(v=vs.103) or http://msdn.microsoft.com/en-us/library/bb383977(v=vs.103).
Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.