FilesExpand file tree

 master

/

Document.cs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

45 lines (38 loc) · 1.29 KB

 master

/

Document.cs

Copy path

Top

File metadata and controls

• Code
• Blame

45 lines (38 loc) · 1.29 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

// Copyright (c) Microsoft Corporation. All rights reserved.

// Licensed under the MIT license.

using System.IO;

using System.Text;

namespace Microsoft.ClearScript

{

/// <summary>

/// Provides an abstract representation of a document.

/// </summary>

public abstract class Document

{

// ReSharper disable EmptyConstructor

/// <summary>

/// Initializes a new <c><see cref="Document"/></c> instance.

/// </summary>

protected Document()

{

// the help file builder (SHFB) insists on an empty constructor here

}

// ReSharper restore EmptyConstructor

/// <summary>

/// Gets a structure containing meta-information for the document.

/// </summary>

public abstract DocumentInfo Info { get; }

/// <summary>

/// Gets a stream that provides read access to the document.

/// </summary>

public abstract Stream Contents { get; }

/// <summary>

/// Gets the document's character encoding.

/// </summary>

/// <remarks>

/// This property returns <c>null</c> if the document contains binary data or if its

/// character encoding is unknown.

/// </remarks>

public virtual Encoding Encoding => null;

}

}