DocumentLoaderLoadDocumentAsync Method |
Loads a document asynchronously.
Namespace:
Microsoft.ClearScript
Assembly:
ClearScript.Core (in ClearScript.Core.dll) Version: 7.2.4
Syntaxpublic abstract Task<Document> LoadDocumentAsync(
DocumentSettings settings,
DocumentInfo? sourceInfo,
string specifier,
DocumentCategory category,
DocumentContextCallback contextCallback
)
Public MustOverride Function LoadDocumentAsync (
settings As DocumentSettings,
sourceInfo As DocumentInfo?,
specifier As String,
category As DocumentCategory,
contextCallback As DocumentContextCallback
) As Task(Of Document)
public:
virtual Task<Document^>^ LoadDocumentAsync(
DocumentSettings^ settings,
Nullable<DocumentInfo> sourceInfo,
String^ specifier,
DocumentCategory^ category,
DocumentContextCallback^ contextCallback
) abstract
abstract LoadDocumentAsync :
settings : DocumentSettings *
sourceInfo : Nullable<DocumentInfo> *
specifier : string *
category : DocumentCategory *
contextCallback : DocumentContextCallback -> Task<Document>
Parameters
- settings
- Type: Microsoft.ClearScriptDocumentSettings
Document access settings for the operation. - sourceInfo
- Type: SystemNullableDocumentInfo
An optional structure containing meta-information for the requesting document. - specifier
- Type: SystemString
A string specifying the document to be loaded. - category
- Type: Microsoft.ClearScriptDocumentCategory
An optional category for the requested document. - contextCallback
- Type: Microsoft.ClearScriptDocumentContextCallback
An optional context callback for the requested document.
Return Value
Type:
TaskDocumentA task that represents the asynchronous operation. Upon completion, the task's result is a
Document instance that represents the loaded document.
Remarks
A loaded document must have an absolute
URI. Once a
load operation has completed successfully, subsequent requests that resolve to the same
URI are expected to return the same
Document reference, although loaders
are not required to manage document caches of unlimited size.
See Also