Freigeben über


OpenDocumentOptions Class

Definition

Options defining how to open documents on the client.

public ref class OpenDocumentOptions
[System.Runtime.Serialization.DataContract]
public class OpenDocumentOptions
[<System.Runtime.Serialization.DataContract>]
type OpenDocumentOptions = class
Public Class OpenDocumentOptions
Inheritance
OpenDocumentOptions
Attributes

Constructors

OpenDocumentOptions()

Initializes a new instance of the OpenDocumentOptions class.

OpenDocumentOptions(Nullable<Range>, Nullable<Range>, Nullable<EnsureRangeVisibleOptions>, Boolean, Nullable<Boolean>, Nullable<LogicalViewKind>, Nullable<Guid>, Nullable<Guid>)

Initializes a new instance of the OpenDocumentOptions class.

OpenDocumentOptions(Nullable<Range>, Nullable<Range>, Nullable<EnsureRangeVisibleOptions>, Boolean, Nullable<Boolean>, Nullable<LogicalViewKind>, Nullable<Guid>, Nullable<Guid>, Nullable<DocumentWindowCaptionKind>, String, Nullable<Boolean>)

Initializes a new instance of the OpenDocumentOptions class.

Properties

Activate

Gets a value indicating whether to activate the document after opening by sending an expicit focus.

CustomDocumentWindowCaption

Gets custom document window caption. The following substitution variables are supported: %1 - the project name %2 - the document's project item hierarchy name %3 - the document name.

DocumentWindowCaptionKind

Gets the kind of the document window caption.

EditorType

Gets unique identifier of the editor type.

EnsureVisible

Gets range of document text to be made visible on document open.

EnsureVisibleOptions

Gets options to control scrolling behavior when EnsureVisible is provided.

IsPreview

Gets a value indicating whether to open document in preview mode.

IsUserReadonly

Gets a value indicating whether the document should be open in user readonly mode.

LogicalView

Gets a kind of logical document view to open.

ProjectId

Gets a project to open document in.

Selection

Gets range of document text to be selected on document open.

Applies to