Welcome Guest! Register/Login
Web services for automated content conversion and deployment

Building Web Applications with Hyper.Net Framework SDK

 Show Comments (0)    Public Domain Bookmark this publication
Building Web Applications with the Hyper.Net Framework SDK Hyper.Net Framework SDK Business Object Model Class Overview Primary Data Classes
Primary Data Classes
Building Web Applications with the Hyper.Net Framework SDK - Hyper.Net Framework SDK Business Object Model Class Overview
 
 
MetaInfo
Public Instance Properties
 
   
Name
Gets or sets the name of the MetaInfo
Sequence
Gets or sets the sequence number of the MetaInfo
Type
Gets or sets the value indicating type of the MetaInfo
Value
Gets or sets the value of the MetaInfo
Xml
Gets the XmlDocument representing the current MetaInfo Object.
 
 
MetaInfoCollection
Public Instance Properties
 
   
Xml
Gets the XML representation of the set of meta information contained in the collection.
Public Instance Methods
   
Add
Adds the specified MetaInfo object to the end of the MetaInfoCollection.
Contains
Returns a value indicating whether the specified MetaInfo is member of the MetaInfoCollection
IndexOf
Searches for the specified MetaInfo and returns the zero-based index of the first occurrence within the collection.
Insert
Adds the specified MetaInfo object to the MetaInfoCollection at the specified zero-based index.
Item
Gets the MetaInfo object at the specified index.
Remove
Removes the specified MetaInfo from the collection.
 
Publication
Public Instance Properties
 
     
ApprovalNotificationEmail
Gets the email address of the person in charge of approvals for the current Publication.
 
Audience
Gets the value indicating the intended audience for the Publication.
 
AvailableFormat
Gets the value indicating the formats this Publication is available
 
Category
Gets the category of the current Publication class.
 
Comment
Gets the actual comment made to the current Publication.
 
Custom1
Gets the actual value of a custom field #1 made to the current Publication.
V4.7
Custom2
Gets the actual value of a custom field #2 made to the current Publication.
V4.7
Custom3
Gets the actual value of a custom field #3 made to the current Publication.
V4.7
Custom4
Gets the actual value of a custom field #4 made to the current Publication.
V4.7
Custom5
Gets the actual value of a custom field #5 made to the current Publication.
V4.7
Custom6
Gets the actual value of a custom field #6 made to the current Publication.
V4.7
Custom7
Gets the actual value of a custom field #7 made to the current Publication.
V4.7
CustomDate
Gets the Publication Custom Date field value.
V4.7
DocumentId
Gets the document identification for the current Publication instance.
 
DocumentTitle
Gets the Document Title for the current Publication object.
V4.7
DocumentType
Gets the document type which was used in the Doument Management System for the Publication
 
EffectiveDate
Gets the string date since when the current Publication is marked as effective.
 
ExpirationDate
Gets the string date of the expiration date of the current Publication.
 
FolderPath
Gets the Folder Path for the current Publication object.
V4.7
IsApproved
Gets the boolean value representing whether the current Publication was approved or not.
 
IsEffective
Gets the boolean value representing whether the current Publication is effective or not.
 
Language
Gets the Language for the current Publication object.
V4.7
LastApprovedBy
Gets the name of the last person who had approved the current Publication.
 
LastApprovedDate
Gets the string date from the last approval of the current Publication.
 
LastModifiedBy
Gets the name of the person who had modified the Publication for the last time.
 
LastModifiedDate
Gets the string date from the last modification of the current Publication.
 
MetaInfos
Gets the meta informations that are available for the current Publication instance.
 
ProductionNotificationEmail
Gets the email address of the person in charge of production for the current Publication.
 
PublicationDate
Gets the string date of publication for the current Publication instance.
 
PublicationId
Gets the interal Id for this Publication
 
TableOfContents
Gets all the topics of the PublicationTable of Contents.
V4.7
Title
Gets the tilte for the current Publication instance.
V4.7
URLDMS
Gets the URL to the source document within the Document Management System represented by the Publication
 
URLMasterIndex
Gets the URL to the Hyper.Net Master Index containing the request to publish the current Publication
 
Version
Gets the version of the document within the Document Management System representing the Publication
 
Xml
Gets the XmlDocument representing the current Publication Object.
 
 
PublicationCollection
Public Instance Properties
   
Count 
Gets the number of elements contained in the CollectionBase instance.
Xml
Gets the XML representation of the set of Publication class instances contained in the collection.
Public Instance Methods
     
Add
Adds the specified Publication to the end of the PublicationCollection.
 
Clear 
Removes all objects from the CollectionBase instance.
 
Contains
Returns a value indicating whether the specified Publication is member of the PublicationCollection
 
GetPublication
Overloaded. Gets the Publication object using the specified PublicationId.
V4.7
IndexOf
Searches for the specified Publication and returns the zero-based index of the first occurrence within the collection.
 
Insert
Adds the specified Publication object to the PublicationCollection at the specified zero-based index.
 
Item
Overloaded. Gets the Publication object at the specified index.
 
Remove
Removes the specified Publication from the collection.
 
RemoveAt 
Removes the element at the specified index of the CollectionBase instance.
 
 
Search
Public Instance Properties
 
     
CountColumnFormater
Returns a value indicating the number of ColumnFormater objects in the Search. Read-only.
 
CountHyperNetFilesForLevel
Get Count of HyperNet fields on level
 
DateTimeStyle
Gets or sets the value indicating the DateTimeStyle to be used when implementing the Search.
V4.7
FuzzySearch
Enables the full-text search, and stores the information to be queried in the database
V4.7
SearchCriteria
Sets the proper criteria-WHERE statement to condition the results of the query.
 
Xml
xml result of search;
 
XmlTreeView
xml presentation of search result for TreeView Control;
V4.7
Public Instance Methods
     
AddNewOutputNode
Overloaded. Overloaded. This function replaces the format specification in a string with the literal equivalent of the value of a specified HyperNetField object instance.
 
Execute
Execute search
 
ExecuteColumn
Execute search for defined column
 
ExecuteColumnForTreeview
Executes a search defined for a column, tailored for the TreeviewNavigation Web Server Control.
V4.7
ExecuteForTreeview
Execute the defined search, tailoring the proper estructure for the TreeviewNavigation Web Server Control.
V4.7
getConnectionString
Function to get the connection string to the sql database from web.config settings
 
GetHyperNetFields
Get HyperNetField[] for ColumnFormater
 
 
Topic
Public Instance Properties
   
AttachmentName
Contains the name of the attachment - if any - to this Topic
AttachmentType
Gets the value indicating the file extension of the attachment
Bookmarks
Gets an XmlDocument containing the bookmarks that belongs to the current Topic Instance.
BrokenLinks
Gets an XmlDocument containing the broken links for the current Topic object, in order to hide them when presented by the Content Web Server Control.
Children
Gets the number of children to the current Topic instance.
Content
Gets the content of the current instance of the Topic
ContentStorageDirectory
Gets or sets the ContentStorageDirectory value of a Topic instance.
ExcludeTopics
Sets the ExcludeTopicTypes value of a Topic instance.
HasContent
Gets the value indicating whether the current Topic has available content or not.
HasHNXML
Gets the value indicating whether the XML that has been created by Hyper.Net is available or not.
HasTransformed
Gets the value indicating whether the html is available for the Topic or not.
Heading
Gets the heading of the current Topic instance.
HNXML
Gets the transformed XML document that represents the content of the Topic.
Indexes
Gets the Indexes of the current Topic instance.
IsAttachment
Gets the value indicating whether the current Topic instance is an attachement or not.
Level
Gets the number indicating the level of the Topic within a hierarchical structure of a Publication
MetaInfos
Gets the meta informations that are available for the current Topic instance.
Next
Gets the Next TopicId relative to the current Topic
ParentTopic
Gets a reference to the Topic's Parent Topic in the Publication hierarchy.
ParentTopicId
Gets the value indicating the TopicId of the parent Topic, whether exists.
Previous
Gets the Previous TopicId relative to the current Topic
Publication
Gets the reference to the Publication object that contains the current instance of the Topic.
Reader
Gets or sets the Reader value of a Topic instance.
RelatedTopics
Gets a TopicCollection representing the siblings to the current Topic instance.
SequenceNumber
Gets the number indicating the position of the Topic within the Publication
SubTopics
Gets a TopicCollection representing the children of the current Topic instance.
TopicId
Gets the TopicId value of the current Topic instance.
TopicLevel
Gets the value indicating the precise hierarchical position of the Topic within the Publication
Type
Gets the value indicating the type of the Topic
Xml
Gets the XmlDocument representing the current Topic Object.
Public Instance Methods
   
GetAttachment
Gets the attachment related to the current instance of the Topic
GetContent
Gets the content of the current instance of the Topic
GetTopicSource
Returns a Topic instance with the specified source type, null in case that there is no source type available for the current Topic instance.
 
TopicCollection
Public Instance Properties
   
Count 
Gets the number of elements contained in the CollectionBase instance.
Xml
Gets the XML representation of the set of topics contained in the collection.
Public Instance Methods
     
Add
Adds the specified Topic object to the end of the TopicCollection.
 
Clear 
Removes all objects from the CollectionBase instance.
 
Contains
Returns a value indicating whether the specified Topic is member of the TopicCollection
 
GetTopic
Overloaded. Gets the Topic object using TopicId and Reader
 
GetTopicByDocumentId
Overloaded. Returns the first Topic found based on the Document identification.
V4.7
GetTopicByPublicationId
Overloaded. Get the one Topic of the Publication with the source type of a topic, either a PDF, Source, NativeHTML or Topic.
V4.7
IndexOf
Searches for the specified Topic and returns the zero-based index of the first occurrence within the collection.
 
Insert
Adds the specified Topic object to the TopicCollection at the specified zero-based index.
 
Item
Overloaded. Gets the Topic object at the specified index.
 
Remove
Removes the specified Topic from the collection.
 
RemoveAt 
Removes the element at the specified index of the CollectionBase instance.
 
 
 
Web.UI
 
 
Bookmarks
Relevant Public Instance Properties
   
CssClassName
Gets or sets the Cascading Style Sheet that must be applied to this control.
Target
Gets or sets the target frame where the Topic Content must be displayed.
 
Content
Relevant Public Instance Properties
     
AlwaysClearHtmlWapper
Get or sets whether the control must take off the HTML that wrapps the content.
V4.7
ClearHtmlWapperForNativeHtml
Get or sets whether the control must take off the HTML that wrapps the content in case of NativeHtml content.
V4.7
HNF_WebCtrls_Client_WebPath
Gets or sets the relative web path to the hn4fwebctrl_client folder, located by default in the [x]:\inetpub\wwwroot.
V4.7
ManageBrokenLinks
Get or sets whether the control must manage broken links or not.
V4.7
TopicId
Get or sets the value of the TopicId that the Topic Content Web Server Control must render.
 
TransformScripts
Gets or sets true or false when desired this control to transform the Scripts embeded into the content, e.g. when the content has a PopUp or so.
V4.7
 
JavigatorNavigation
Relevant Public Instance Properties
 
   
AlternativeNavigation
Gets or sets the URL name for the alternate navigation web page, in this case the page that contains the TreeViewNavigation Web Server Control.
CodeBase
Gets or sets the CodeBase 'jar' file path for the Java Applet.
CollapseURL
Gets or sets the URL path of a valid image that tells the Java Applet to collapse.
DocPreExpandableInActiveURL
Gets or sets the URL path of a valid image to present before an active level of the navigation is going to be expanded.
DocPreExpandableMouseOverURL
Gets or sets the URL path of an valid image that tells the Java Applet that a level can be expanded.
DocPreExpandableSelectedURL
Gets or sets the URL path of a valid image to present before a expandable level of the navigation is selected.
DocPreExpandedSelectedURL
Gets or sets the URL path of a valid image to present when a level of the navigation is selected and expanded.
DocPreExpandedURL
Gets or sets the URL path of a valid image to present before a level of the navigation be expanded.
DocPreInActiveURL
Gets or sets the URL path of a valid image to present when an active level of the navigation is selected.
DocPreMouseOverURL
Gets or sets the URL path of a valid image to present when the mouse moves over a level of the navigation.
DocPreSelectedURL
Gets or sets the URL path of a valid image to present when a level of the navigation is selected.
EcblankURL
Gets or sets the URL path of a transparent image of 1x1 pixel.
ExpandURL
Gets or sets the URL path of a valid image that tells the Java Applet to expand.
JavaCatClickURL
Gets or sets the URL path of a valid image of a category when is being clicked within the Java Applet.
JavaCatMoURL
Gets or sets the URL path of a valid image to present when the mouse is moved over a category within the Java Applet.
JavaCatURL
Gets or sets the URL path of a valid image of a category when the mouse is not over it within the Java Applet.
JavaClickURL
Gets or sets the URL path of a valid image when the Java Applet is being clicked.
JavaMoURL
Gets or sets the URL path of a valid image to present when the mouse is moved over the Java Applet.
JavaURL
Gets or sets the URL path of a valid image to the Java Applet.
MaxReturnRecords
Get or Set the maximal number of rows that must be pulled out from the database.
SearchCriteria
Sets a Search instance to be bound to the control at run-time.
TopicNodesStructured
Gets or sets a boolean value whether is required that the Topic nodes of the tree be structured or not.
 
NavigationImage
Relevant Public Instance Properties
 
   
ContentDisplayWebApplication
Gets or sets the complete URL where the Topic Content Web Server Control is deployed in the web application.
CssClassName
Gets or sets the Cascading Style Sheet that must be applied to this control.
MoveTo
Gets or sets the value that must be used to navigate thru Topics.
Target
Gets or sets the target frame where the Topic Content must be displayed.
 
NavigationLink
Relevant Public Instance Properties
 
   
ContentDisplayWebApplication
Gets or sets the complete URL where the Topic Content Web Server Control is deployed in the web application.
CssClassName
Gets or sets the Cascading Style Sheet that must be applied to this control.
MoveTo
Gets or sets the value that must be used to navigate thru Topics.
Target
Gets or sets the target frame where the Topic Content must be displayed.
 
Subtopics
Relevant Public Instance Properties
 
   
CaptionForRelated
Gets or sets the Caption Text that must be presented in the Control when the RenderTopicFor property is set to RelatedTopics.
CaptionForSub
Gets or sets the Caption Text that must be presented in the Control when the RenderTopicFor property is set to Subtopics.
RenderTopicFor
Gets or sets the proper behavior for the control, whether is required to render related or sub topics.
Target
Gets or sets the string used to redirect the user to the Topic Content area in a target frame.
TopicContentDisplayURL
Gets or sets the string representing a valid URL, used to redirect the user to the Topic Content area.
TopicId
Get or sets the value of the TopicId that the Topic Content Web Server Control must render.
XsltFileName
Gets or sets the file name of the XSLT document in charge of the transformation between the XML memory stream and HMTL.
 
TOC
Relevant Public Instance Properties
 
   
CaptionText
Gets or sets the Caption Text that must be presented for the Control.
Target
Gets or sets the string used to redirect the user to the Topic Content area in a target frame.
TopicContentDisplayURL
Gets or sets the string representing a valid URL, used to redirect the user to the Topic Content area.
TopicId
Get or sets the value of the topicId of the TOC Web Server Control will render.
XsltFileName
Gets or sets the file name of the XSLT document in charge of the transformation between the XML memory stream and HMTL.
 
TopicAncestors
Relevant Public Instance Properties
 
   
ContentDisplayWebApplication
Gets or sets the complete URL where the Topic Content Web Server Control is deployed in the web application.
ExcludeEmptyAncestors
Gets or sets true or false, whether is required to exclude empty Topic ancestors to be rendered.
LinkSeparator
Gets or sets the string used to separate the the ancestor links.
Target
Gets or sets the string used to redirect the user to the Topic Content area in a target frame.
 
TreeViewNavigation
Relevant Public Instance Properties
 
   
AbsoluteUri
Sets the Absolute URI where the control is deployed.
ContentDisplayWebApplication
Gets or sets the complete URL where the Topic Content Web Server Control is deployed in the web application.
HyperNetTreeNodeLevel
Gets or sets the node level when the TreeViewNavigation Web Server Control is intended to allocate custom nodes, and the HyperNet Nodes must be placed in a special level of the tree.
MaxReturnRecords
Get or Set the maximal number of rows that must be pulled.
NodesExpanded
Gets or sets a boolean value whether is required that the nodes of the tree be expanded or not after rendering.
SearchCriteria
Sets the proper criteria-WHERE statement to condition the results of the query.
SearchResultXml
Gets the whole XmlDocument that contains the actual Search instance within the TreeViewNavigation Web Server Control.
SecurityMode
Gets or sets a SecurityModeEnum value whether is required for level of security mode.
TopicContentTarget
Gets or sets the Target frame where the Topic Content must be displayed.
TopicNodesStructured
Gets or sets a boolean value whether is required that the Topic nodes of the tree be structured or not.
 
Relevant Public Instance Methods
 
   
AddNewOutputNode
Overloaded. Overloaded. This function replaces the format specification in a string with the literal equivalent of the value of a specified HyperNetField object instance.
ExecuteSearch
This member set Microsoft.Web.UI.WebControls.TreeView.TreeNodeSrc with result xml form search and make DataBind
GetFirstLevelNodes
Returns the first level Microsoft.Web.UI.WebControls.TreeNodeCollection that can be attached to any TreeViewNavigation, after the execution of the search definition attached to the control.
GetHashCode (inherited from Object)
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
 
 
Web.UI.AppControls
 
 
Download
No Relevant Public Instance Properties, No Relevant Public Instance Methods
 
Feedback
Relevant Public Instance Methods
 
   
Culture
Gets or sets the Culture setting for the current control. Must comply with RFC 1766 standard.
FeedBackStoragePath
Gets or sets the path that should be used to store the Feedbacks in Xml format into disk.
LabelErrorSummaryClass
Gets or sets the Cascading Style Sheet Class to be used for the Error Summary.
LabelMessageSummaryClass
Gets or sets the Cascading Style Sheet Class to be used for the Message Summary.
TextBoxEmailClass
Gets or sets the Cascading Style Sheet Class to be used for the text box Email
TextBoxMessageClass
Gets or sets the Cascading Style Sheet Class to be used for the text box Message.
TextBoxNameClass
Gets or sets the Cascading Style Sheet Class to be used for the text box Name.
TextBoxSubjectClass
Gets or sets the Cascading Style Sheet Class to be used for the text box Subject.
TextBoxSurnameClass
Gets or sets the Cascading Style Sheet Class to be used for the text box Surname
ValidationSummary
Gets or sets the value indicating with method of displaying error messages should be used.
XmlConfigPath
Gets or sets the path where the configuration file is located.
 
Recommend
Relevant Public Instance Methods
 
   
Culture
Gets or sets the Culture setting for the current control. Must comply with RFC 1766 standard.
LabelErrorSummaryClass
Gets or sets the Cascading Style Sheet Class to be used for the Error Summary.
LabelMessageSummaryClass
Gets or sets the Cascading Style Sheet Class to be used for the Message Summary.
TextBoxEmailClass
Gets or sets the Cascading Style Sheet Class to be used for the text box Email
TextBoxMessageClass
Gets or sets the Cascading Style Sheet Class to be used for the text box Message.
TextBoxRecipientClass
Gets or sets the Cascading Style Sheet Class to be used for the text box Recipient.
TextBoxSenderClass
Gets or sets the Cascading Style Sheet Class to be used for the text box Sender.
ValidationSummary
Gets or sets the value indicating with method of displaying error messages should be used.
XmlConfigPath
Gets or sets the path where the configuration file is located.
 
Subscribe
Relevant Public Instance Methods
 
   
Culture
Gets or sets the Culture setting for the current control. Must comply with RFC 1766 standard.
LabelErrorSummaryClass
Gets or sets the Cascading Style Sheet Class to be used for the Error Summary.
LabelMessageSummaryClass
Gets or sets the Cascading Style Sheet Class to be used for the Message Summary.
SubscriptionsReferenceUrl
Gets or sets the url to redirect to the Subscriptions implementer page.
TextBoxEmailClass
Gets or sets the Cascading Style Sheet Class to be used for the text box Email
ValidationSummary
Gets or sets the value indicating with method of displaying error messages should be used.
XmlConfigPath
Gets or sets the path where the configuration file is located.
 
Subscriptions
Relevant Public Instance Methods
 
   
Culture
Gets or sets the Culture setting for the current control. Must comply with RFC 1766 standard.
DeleteLinkClass
Gets or sets the Cascading Style Sheet Class to be used for the Message Summary.
LabelErrorSummaryClass
Gets or sets the Cascading Style Sheet Class to be used for the Error Summary.
LabelMessageSummaryClass
Gets or sets the Cascading Style Sheet Class to be used for the Message Summary.
TableSubscriptionsClass
Gets or sets the Cascading Style Sheet Class to be used for the Message Summary.
XmlConfigPath
Gets or sets the path where the configuration file is located.
 
 
Common
 
 
EmailSender
Public Instance Methods
 
   
Message
Gets or sets a prepared MailMessage object to the current instace
SmtpServer
Gets or sets the name of the SMTP Server for outgoing emails.
Relevant Public Instance Methods
 
   
SendEmail
Overloaded. Sends a template email, allowing to send a single attachment file.
 
EventTrace
Public Static Methods
   
WriteTrace
This method writes a trace entry into the event log and a disk file.
 
HyperNetFuzzySearch
Public Instance Properties
   
IgnoreFuzzyTransformation
Gets or sets true of false, indicating whether the HyperNetFuzzySearch should return fuzzy transformed text out of the PublicationSearchText or TopicSearchText properties.
PublicationSearchText
Gets or sets the value of the fuzzy text to be used by the Full-Text-Search when programmed with the BOM.Search class, to be used on the catalog created for the Publication Table.
TopicSearchText
Gets or sets the value of the fuzzy text to be used by the Full-Text-Search when programmed with the BOM.Search class, to be used on the catalog created for the Topic Table.
 
Tools
Public Static Methods
     
AppendToXml
This function appends to one XML file the elements with their values, and attributes with their values. If the file does not exists is created on the fly.
 
GetContentStorageAreaPath
Returns the Content Storage Area (CSA) path.
 
GetDecryptedString
Returns a decrypted String out of the provided encrypted string.
 
GetEncryptedString
Returns an encrypted String out of the provided string.
 
GetErrorMessage
Gets the proper error message out of the culture resource file.
 
GetInstallPath
Returns the Installation path of the HNFSDK. A String with the Installation path of the HyperNet Framework
 
GetLogsPath
Returns the default logs path where the HNFSDK was installed.
 
GetMIMEType
Returns the proper MIME type associated with the file extension provided.
V4.7
GetMIMETypesPath
Returns the full Path of the for the MIMETypes key in the registry.
V4.7
GetSubtopicsToHtmlXsltPath
Returns the Xslt file used for the Subtopics transformation.
 
GetTocToHtmlXsltPath
Returns the Xslt file used for the TOC transformation.
V4.7
GetTotalXmlElementsOf
Overloaded. This function returns the total number of elements contained in the XmlDocument who needs to be traversed.
 
GetXmlAttributeValueOf
Overloaded. This function retrieves from a XmlDocument the value of an attribute accordingly to its parent element name, as well as the deepness of that element within the XML.
 
GetXmlUrlReferalsPath
Returns the name of the file where all the web application referals is placed.
 
GetXsltFilePathOf
Returns the proper Xslt file path for the requested value.
 
GetXsltPath
Returns the path where the XSLT files are located within the HNFSDK is located.
 
HtmlToXml
Overloaded. Converts an HTML document to a valid XML document using SGML.
V4.7
IsTraceEnabled
Indicates whether the Trace Mode is enabled from the registry.
 
ReadParamenterFromXml
This function uses XPath to locate values within an XmlDocument stream.
 
XmlXlstTransformer
Overloaded. Returns an instance of a String containing the transofmation made upon the XML String representation and a XSLT document.
 
 
TopicFile
Public Instance Properties
   
BLOB
Gets the byte array that contains the Binary Large Object, retreived from the database, and that needs to be rendered into the client's browser.
CSAPath
Gets or sets the value of the path within the Content Storage Area (CSA), from where the current content was loaded from.
Type
Gets or sets the value of the MIME type for the current byte array contained in the property BLOB.
 
 
Loading, please wait...
About Publications
Contributor
Aruna
Published: 5/19/2010
Tags:
0 128 0
Display Options
Embed, Share & Subscribe
Download
Rate & Report
Statistics