Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 658 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Class

VisioCommentExtensions

OfficeIMO.Visio

Edit on GitHub
Namespace
OfficeIMO.Visio
Assembly
OfficeIMO.Visio
Source revision
e163ccb36643 with working tree changes
Source
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) #
VisioCommentExtensions.cs:14

Adds a page-level native Visio comment.

Parameters

page OfficeIMO.Visio.VisioPage required
text string required
authorName string? = null optional
authorInitials string? = null optional
options OfficeIMO.Visio.VisioCommentOptions? = null optional

Returns

VisioComment
public static VisioComment AddComment(VisioPage page, VisioShape target, string text, string? authorName = null, string? authorInitials = null, VisioCommentOptions? options = null) #
VisioCommentExtensions.cs:25

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

Parameters

page OfficeIMO.Visio.VisioPage required
target OfficeIMO.Visio.VisioShape required
text string required
authorName string? = null optional
authorInitials string? = null optional
options OfficeIMO.Visio.VisioCommentOptions? = null optional

Returns

VisioComment
public static VisioComment AddCommentToShape(VisioPage page, string shapeId, string text, string? authorName = null, string? authorInitials = null, VisioCommentOptions? options = null) #
VisioCommentExtensions.cs:40

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

Parameters

page OfficeIMO.Visio.VisioPage required
shapeId string required
text string required
authorName string? = null optional
authorInitials string? = null optional
options OfficeIMO.Visio.VisioCommentOptions? = null optional

Returns

VisioComment
public static IReadOnlyList<VisioComment> CommentsByAuthor(VisioPage page, VisioCommentAuthor author) #
VisioCommentExtensions.cs:145

Returns comments written by one stable author identity.

Parameters

page OfficeIMO.Visio.VisioPage required
author OfficeIMO.Visio.VisioCommentAuthor required

Returns

IReadOnlyList<VisioComment>
CommentsForShape 2 overloads
public static IReadOnlyList<VisioComment> CommentsForShape(VisioPage page, VisioShape target) #
VisioCommentExtensions.cs:53

Returns comments that target the provided shape.

Parameters

page OfficeIMO.Visio.VisioPage required
target OfficeIMO.Visio.VisioShape required

Returns

IReadOnlyList<VisioComment>
public static IReadOnlyList<VisioComment> CommentsForShape(VisioPage page, string shapeId) #
VisioCommentExtensions.cs:62

Returns comments that target the provided shape or connector identifier.

Parameters

page OfficeIMO.Visio.VisioPage required
shapeId string required

Returns

IReadOnlyList<VisioComment>
public static VisioComment? FindComment(VisioPage page, int commentId) #
VisioCommentExtensions.cs:77

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

Parameters

page OfficeIMO.Visio.VisioPage required
commentId int required

Returns

VisioComment?
public static IReadOnlyList<VisioCommentThread> GetCommentThreads(VisioPage page) #
VisioCommentExtensions.cs:123

Returns deterministic root-and-reply thread projections.

Parameters

page OfficeIMO.Visio.VisioPage required

Returns

IReadOnlyList<VisioCommentThread>
RemoveComment 2 overloads
public static bool RemoveComment(VisioPage page, VisioComment comment) #
VisioCommentExtensions.cs:185

Removes a native Visio comment from the page.

Parameters

page OfficeIMO.Visio.VisioPage required
comment OfficeIMO.Visio.VisioComment required

Returns

bool
public static bool RemoveComment(VisioPage page, int commentId) #
VisioCommentExtensions.cs:198

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

Parameters

page OfficeIMO.Visio.VisioPage required
commentId int required

Returns

bool
public static int RemoveCommentsForShape(VisioPage page, string shapeId) #
VisioCommentExtensions.cs:208

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

Parameters

page OfficeIMO.Visio.VisioPage required
shapeId string required

Returns

int
public static VisioComment ReopenComment(VisioPage page, int commentId, DateTimeOffset? editedAt = null) #
VisioCommentExtensions.cs:176

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

Parameters

page OfficeIMO.Visio.VisioPage required
commentId int required
editedAt System.DateTimeOffset? = null optional

Returns

VisioComment
public static VisioComment ReplyToComment(VisioPage page, int parentCommentId, string text, VisioCommentAuthor author, VisioCommentOptions? options = null) #
VisioCommentExtensions.cs:104

Adds a native comment reply with stable thread metadata.

Parameters

page OfficeIMO.Visio.VisioPage required
parentCommentId int required
text string required
author OfficeIMO.Visio.VisioCommentAuthor required
options OfficeIMO.Visio.VisioCommentOptions? = null optional

Returns

VisioComment
public static VisioComment ResolveComment(VisioPage page, int commentId, DateTimeOffset? editedAt = null) #
VisioCommentExtensions.cs:167

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

Parameters

page OfficeIMO.Visio.VisioPage required
commentId int required
editedAt System.DateTimeOffset? = null optional

Returns

VisioComment
public static IReadOnlyList<VisioComment> ResolvedComments(VisioPage page) #
VisioCommentExtensions.cs:95

Returns native Visio comments that are marked as done.

Parameters

page OfficeIMO.Visio.VisioPage required

Returns

IReadOnlyList<VisioComment>
public static IReadOnlyList<VisioComment> UnresolvedComments(VisioPage page) #
VisioCommentExtensions.cs:86

Returns native Visio comments that are not marked as done.

Parameters

page OfficeIMO.Visio.VisioPage required

Returns

IReadOnlyList<VisioComment>
public static VisioComment UpdateCommentText(VisioPage page, int commentId, string text, DateTimeOffset? editedAt = null) #
VisioCommentExtensions.cs:158

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

Parameters

page OfficeIMO.Visio.VisioPage required
commentId int required
text string required
editedAt System.DateTimeOffset? = null optional

Returns

VisioComment