WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Interface IResourceProvider

    Show / Hide Table of Contents

    Interface IResourceProvider

    Interface that declares the functionality for objects exposing data of the document.

    Inherited Members
    System.IDisposable.Dispose()
    Namespace: Syncfusion.HTMLUI.Base
    Assembly: Syncfusion.HTMLUI.Base.dll
    Syntax
    public interface IResourceProvider : IDisposable

    Properties

    FileName

    Returns the source for parser is file, otherwise must be null. Property has higher priority

    Declaration
    string FileName { get; }
    Property Value
    Type Description
    System.String

    Format

    Returns the format of resource provider.

    Declaration
    DataFormat Format { get; }
    Property Value
    Type Description
    DataFormat

    IsFileName

    Indicates whether input HTML document is loaded from file.

    Declaration
    bool IsFileName { get; }
    Property Value
    Type Description
    System.Boolean

    IsStream

    Indicates whether input HTML document is loaded from stream.

    Declaration
    bool IsStream { get; }
    Property Value
    Type Description
    System.Boolean

    IsUri

    Indicates whether input HTML document is loaded by Uri.

    Declaration
    bool IsUri { get; }
    Property Value
    Type Description
    System.Boolean

    RootDirectory

    Gets or sets root directory for the document.

    Declaration
    string RootDirectory { get; set; }
    Property Value
    Type Description
    System.String

    Stream

    Returns the source specified as stream, otherwise must be null. Has lowest priority.

    Declaration
    Stream Stream { get; }
    Property Value
    Type Description
    System.IO.Stream

    Uri

    Returns the source for parser specified by URI, otherwise must be null. Second property by priority for source checks.

    Declaration
    Uri Uri { get; }
    Property Value
    Type Description
    System.Uri

    Methods

    GetDocumentBody()

    Searches for a body of the document and returns data contained in it.

    Declaration
    TokenStream GetDocumentBody()
    Returns
    Type Description
    TokenStream

    Data of document's body if found; Null otherwise.

    GetResource(String)

    Overloaded. Searches for resource by it's location inside of document.

    Declaration
    Stream GetResource(string path)
    Parameters
    Type Name Description
    System.String path

    Path to the resource.

    Returns
    Type Description
    System.IO.Stream

    Data of resource if found; Null otherwise.

    GetResource(String, ResourceType)

    Searches for resource by it's location inside of document.

    Declaration
    Stream GetResource(string fullPath, ResourceType type)
    Parameters
    Type Name Description
    System.String fullPath

    Full path to the resource.

    ResourceType type

    Type of resource.

    Returns
    Type Description
    System.IO.Stream

    Data of resource if found; Null otherwise.

    ResourceExists(String, out String, out ResourceType)

    Indicates whether such resource exists. Checks as local file as remote resource.

    Declaration
    bool ResourceExists(string path, out string fullPath, out ResourceType type)
    Parameters
    Type Name Description
    System.String path

    Path for searching.

    System.String fullPath

    Full path to the resource.

    ResourceType type

    Type of resource.

    Returns
    Type Description
    System.Boolean

    True if resource found; False otherwise.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved