Libraries.Web.Page.Comment Documentation

The Comment represents HTML's (Hypertext Markup Language) !-- tag which allows a comment to be added to the webpage. You can find more information about this tag at: The comment attribute.

Example Code



use Libraries.Web.Page.all
class Main
action main
   //make a web page
   WebPage page
   
   //create a comment
   Comment c
   c:SetDescription("This is a comment")

end
end

Inherits from: Libraries.Web.Page.WebGenerator, Libraries.Language.Object

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

Generate()

This action sets the comment close value. If true, the comment is closed with a //--> to prevent javascript from executing the -->. If false, the comment is closed with a -->.

Return

text:

Example


use Libraries.Web.Page.Comment
Comment comment
comment:SetCommentClose(false)

GetCommentClose()

This action gets the comment close value. If true, the comment is closed with a //--> to prevent javascript from executing the -->. If false, the comment is closed with a -->.

Return

boolean: true if // is needed and false if not.

Example


use Libraries.Web.Page.Comment
Comment comment
boolean close = comment:GetCommentClose()

GetDescription()

This action gets the description or the comment text.

Return

text: The comment text.

Example


use Libraries.Web.Page.Comment
Comment comment
comment:SetDescription("This is a comment.")
output comment:GetDescription()

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

SetCommentClose(boolean commentClose)

This action sets the comment close value. If true, the comment is closed with a //--> to prevent javascript from executing the -->. If false, the comment is closed with a -->.

Parameters

  • boolean commentClose: True if // is needed and false if not.

Example


use Libraries.Web.Page.Comment
Comment comment
comment:SetCommentClose(false)

SetDescription(text description)

This action sets the description(text) in the comment.

Parameters

  • text description: The comments text.

Example


use Libraries.Web.Page.Comment
Comment comment
comment:SetDescription("This is my comment")