Get Started

API Reference

Class

VisioCommentExtensions

Edit on GitHub
Namespace OfficeIMO.Visio
Assembly OfficeIMO.Visio
Source OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:14
Modifiers static

Editing helpers for native Visio comments.

Inheritance

  • Object
  • VisioCommentExtensions

Methods

AddComment 2 overloads
public static VisioComment AddComment(VisioPage page, String text, String authorName = null, String authorInitials = null, VisioCommentOptions options = null) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:14
Returns: VisioComment

Adds a page-level native Visio comment.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
text System.String requiredposition: 1
authorName System.String = null optionalposition: 2
authorInitials System.String = null optionalposition: 3
options OfficeIMO.Visio.VisioCommentOptions = null optionalposition: 4
public static VisioComment AddComment(VisioPage page, VisioShape target, String text, String authorName = null, String authorInitials = null, VisioCommentOptions options = null) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:27
Returns: VisioComment

Adds a native Visio comment to a shape on the page.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
target OfficeIMO.Visio.VisioShape requiredposition: 1
text System.String requiredposition: 2
authorName System.String = null optionalposition: 3
authorInitials System.String = null optionalposition: 4
options OfficeIMO.Visio.VisioCommentOptions = null optionalposition: 5
public static VisioComment AddCommentToShape(VisioPage page, String shapeId, String text, String authorName = null, String authorInitials = null, VisioCommentOptions options = null) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:46
Returns: VisioComment

Adds a native Visio comment to a shape or connector by identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
shapeId System.String requiredposition: 1
text System.String requiredposition: 2
authorName System.String = null optionalposition: 3
authorInitials System.String = null optionalposition: 4
options OfficeIMO.Visio.VisioCommentOptions = null optionalposition: 5
CommentsForShape 2 overloads
public static IReadOnlyList<VisioComment> CommentsForShape(VisioPage page, String shapeId) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:72
Returns: IReadOnlyList<VisioComment>

Returns comments that target the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
target OfficeIMO.Visio.VisioShape requiredposition: 1
CommentsForShape(OfficeIMO.Visio.VisioPage page, System.String shapeId) #

Returns comments that target the provided shape or connector identifier.

Parameters

page OfficeIMO.Visio.VisioPage required
shapeId System.String required
public static VisioComment FindComment(VisioPage page, Int32 commentId) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:89
Returns: VisioComment

Finds a native Visio comment by its page-scoped identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
commentId System.Int32 requiredposition: 1
RemoveComment 2 overloads
public static Boolean RemoveComment(VisioPage page, Int32 commentId) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:164
Returns: Boolean

Removes a native Visio comment from the page.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
comment OfficeIMO.Visio.VisioComment requiredposition: 1
RemoveComment(OfficeIMO.Visio.VisioPage page, System.Int32 commentId) #

Removes a native Visio comment by its page-scoped identifier.

Parameters

page OfficeIMO.Visio.VisioPage required
commentId System.Int32 required
public static Int32 RemoveCommentsForShape(VisioPage page, String shapeId) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:172
Returns: Int32

Removes all native Visio comments targeting a shape or connector identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
shapeId System.String requiredposition: 1
public static VisioComment ReopenComment(VisioPage page, Int32 commentId, Nullable<DateTimeOffset> editedAt = null) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:140
Returns: VisioComment

Reopens a native Visio comment by its page-scoped identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
commentId System.Int32 requiredposition: 1
editedAt System.Nullable{System.DateTimeOffset} = null optionalposition: 2
public static VisioComment ResolveComment(VisioPage page, Int32 commentId, Nullable<DateTimeOffset> editedAt = null) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:131
Returns: VisioComment

Marks a native Visio comment as done by its page-scoped identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
commentId System.Int32 requiredposition: 1
editedAt System.Nullable{System.DateTimeOffset} = null optionalposition: 2
public static IReadOnlyList<VisioComment> ResolvedComments(VisioPage page) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:111
Returns: IReadOnlyList<VisioComment>

Returns native Visio comments that are marked as done.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
public static IReadOnlyList<VisioComment> UnresolvedComments(VisioPage page) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:100
Returns: IReadOnlyList<VisioComment>

Returns native Visio comments that are not marked as done.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
public static VisioComment UpdateCommentText(VisioPage page, Int32 commentId, String text, Nullable<DateTimeOffset> editedAt = null) #
OfficeIMO.Visio/Editing/VisioCommentExtensions.cs:122
Returns: VisioComment

Updates a native Visio comment's text by its page-scoped identifier.

Parameters

page OfficeIMO.Visio.VisioPage requiredposition: 0
commentId System.Int32 requiredposition: 1
text System.String requiredposition: 2
editedAt System.Nullable{System.DateTimeOffset} = null optionalposition: 3