API Reference
VisioComment
Represents a native Visio comment stored in the document comments part.
Inheritance
- Object
- VisioComment
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method VisioCommentExtensions.AddComment
- Method VisioCommentExtensions.AddComment
- Method VisioCommentExtensions.AddCommentToShape
- Method VisioCommentExtensions.CommentsForShape
- Method VisioCommentExtensions.FindComment
- Method VisioCommentExtensions.ReopenComment
- Method VisioCommentExtensions.ResolveComment
- Method VisioCommentExtensions.ResolvedComments
- Method VisioCommentExtensions.UnresolvedComments
- Method VisioCommentExtensions.UpdateCommentText
- Extension method VisioPage.AddComment
- Extension method VisioPage.AddComment
- Extension method VisioPage.AddCommentToShape
- Extension method VisioPage.CommentsForShape
- Extension method VisioPage.CommentsForShape
- Extension method VisioPage.FindComment
- Extension method VisioPage.ReopenComment
- Extension method VisioPage.ResolveComment
- Extension method VisioPage.ResolvedComments
- Extension method VisioPage.UnresolvedComments
- Extension method VisioPage.UpdateCommentText
- Property VisioPage.Comments
Accepted by parameters
- Method VisioFluentPage.Comments
- Method VisioFluentPage.ShapeComments
- Method VisioCommentExtensions.RemoveComment
- Extension method VisioPage.RemoveComment
- Extension method VisioPage.RemoveComment
Constructors
public VisioComment(String text) #Initializes a new comment with the current UTC creation time.
Parameters
- text System.String
- Comment text.
Methods
public Void Reopen(Nullable<DateTimeOffset> editedAt = null) #VoidReopens a resolved comment and records the edit timestamp.
Parameters
- editedAt System.Nullable{System.DateTimeOffset} = null
- Optional edit timestamp. Uses current UTC time when not provided.
public Void Resolve(Nullable<DateTimeOffset> editedAt = null) #VoidMarks the comment as done and records the edit timestamp.
Parameters
- editedAt System.Nullable{System.DateTimeOffset} = null
- Optional edit timestamp. Uses current UTC time when not provided.
public Void UpdateText(String text, Nullable<DateTimeOffset> editedAt = null) #VoidUpdates the comment text and records the edit timestamp.
Parameters
- text System.String
- New comment text.
- editedAt System.Nullable{System.DateTimeOffset} = null
- Optional edit timestamp. Uses current UTC time when not provided.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public Int32 Id { get; set; } #Gets the comment identifier, unique within its page once attached to a page.
public String Text { get; set; } #Gets or sets the plain text comment content.
public String AuthorName { get; set; } #Gets or sets the display name of the comment author.
public String AuthorInitials { get; set; } #Gets or sets the author initials shown by Visio.
public String AuthorResolutionId { get; set; } #Gets or sets the optional Visio author resolution identifier.
public String ShapeId { get; set; } #Gets or sets the semantic shape or connector identifier this comment targets. When null, the comment applies to the page.
public DateTimeOffset CreatedAt { get; set; } #Gets or sets when the comment was created.
public Nullable<DateTimeOffset> EditedAt { get; set; } #Gets or sets when the comment was last edited.
public Boolean Done { get; set; } #Gets or sets whether the comment is marked as done.
public Nullable<Int32> AutoCommentType { get; set; } #Gets or sets the native AutoCommentType value. Visio ignores this value, but it is preserved when present.