Facilitates to retrieve values from the form variables and the environment variables.
Represents the collection of form variables. Form variables are input fields in a form.
object.FormVars
CGIObjs.
Read-only.
This property will return a valid collection of form variables, if the script is invoked through HTTP post method. The value of the ACTION property of the respective form should be POST. Else, this property will throw an exception.
This example retrieves the name and the value of the form fields.
Set formvars=doc.formvars
For each formvar in formvars
Print "Name:"&formvar.name&"nbsp;nbsp"
&"Value:"&formvar.value
Next
Represents the collection of web server provided environment variables.
object.EnvVars
EnvObjs.
Read-only.
This example retrieves the name and the value of the environment fields.
Set envvars=doc.envvars
For each envvar in envvars
Print "Name:"&envvar.name&"nbsp;nbsp"
&envvar.value
Next
Adds an item to a bulleted list in an HTML document.
object.AddBullet(
HREF As String)
Boolean. Returns TRUE if the string is successfully added to the list, else returns FALSE.
To add a string to a numbered list, see the AddNumber method.
This example shows the AddBullet method in its typical context. It adds the text item "NSN lets you access the UCS" to the bulleted list.
doc.BeginBullet()
doc.AddBullet("NSN lets you access the UCS")
doc.EndBullet()
Creates a frame in an HTML document.
doc.AddFrame(
Source As String
[,Name As String
[,Scrolling As Integer
[,NoResize As Boolean
[,MarginHeight As Integer
[,MarginWidth As Integer
[,FrameBorder As Boolean]]]]]])
Scrolling Constants.
Boolean. Returns TRUE if the frame is successfully added, else returns FALSE.
This example shows the AddFrame method in its typical context. It adds two frames, which display the URLs http://www.novell.com and http://www.sun.com, to the HTML document.
doc.BeginFrame("50%, 50%")
doc.AddFrame("http://www.novell.com")
doc.AddFrame("http://www.sun.com")
doc.EndFrame()
Adds data to a numbered list in an HTML document.
doc.AddNumber(
HREF As String)
Boolean. Returns TRUE if the string is successfully added to the numbered list, else returns FALSE.
To add a string to a bulleted list, see the AddBullet method.
This example shows the AddNumber method in its typical context. It adds four items to the numbered list in the HTML document.
doc.BeginNumber() doc.AddNumber("Open a new document.") doc.AddNumber("Edit the document.") doc.AddNumber("Save the document.") doc.AddNumber("Close the document.") doc.EndNumber()
Adds an address tag an HTML document.
doc.Address(
AddressInfo As String)
Boolean. Returns TRUE if the address is successfully added to the document, else returns FALSE.
This example shows the Address method in its typical context. It adds the address "Novell Headquarters, Provo, Utah" to the HTML document.
doc.Address("Novell HeadQuarters,Provo,Utah")
Adds a line to a text box in an HTML document.
object.AddTextArea(
Data As String)
Boolean. Returns TRUE if the string is successfully added to the text box, else returns FALSE.
This AddTextArea example adds the string "NetWare 5 is terrific!" to the text box.
doc.BeginForm("cgi.bas")
doc.AddTextArea("NetWare 5 is terrific!")
doc.EndForm()
Starts a bulleted list in an HTML document.
object.BeginBullet()
None.
Boolean. Returns TRUE if the bulleted list is successfully started, else returns FALSE.
This example shows the BeginBullet method in its typical context.
doc.BeginBullet()
doc.AddBullet("NSN lets you access the UCS")
doc.EndBullet()
Starts adding data to a table in an HTML document.
object.BeginData(
Data As String
[,Height As Integer
[,Width As Integer
[,HAlign As Integer
[,VAlign As Integer
[,Color As String]]]]])
Alignment Constants.
Alignment Constants.
Color Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginData example starts adding data to the table in the HTML document.
doc.BeginTable(TRUE)
doc.Caption("Table")
doc.BeginRow()
doc.TableHeading("Head1")
doc.TableHeading("Head2")
doc.EndRow()
doc.BeginRow()
doc.DataTable("Line11")
doc.DataTable("Line12")
doc.EndRow()
doc.BeginRow()
doc.BeginData()
doc.Print("Line21")
doc.EndData()
doc.BeginData()
doc.Print("Line22")
doc.EndData()
doc.EndRow()
doc.EndTable()
Specifies the text color, size, and preferred font in an HTML document.
object.BeginFont(
[Color As String
[,Size As String
[,Face As String]]])
Color Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginFont example specifies the font appearance as 7 point red (#FF0000).
doc.BeginFont("#FF0000", "7")
doc.Print("Doc Component")
doc.EndFont()
Creates the form in an HTML document.
object.BeginForm(
URL As String,
Target As String)
Void.
This BeginForm example creates the form process.bas.
doc.BeginForm("process.bas")
doc.BeginSelect("Selection", 5, TRUE)
doc.OptionSelect("First option", "First", TRUE)
doc.OptionSelect("Second option", "Second", False)
doc.OptionSelect("Third option", "Third", False)
doc.OptionSelect("Fourth option", "Fourth", False)
doc.OptionSelect("Fifth option", "Fifth", False)
doc.OptionSelect("Sixth option", "Sixth", False)
doc.EndSelect()
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Creates a frame in an HTML document.
object.BeginFrame(
Rows As String
[,Cols As String
[,FrameBorder As Boolean
[,BorderColor As String
[,Border As Integer]]]])
Color Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginFrame example creates a frame in the HTML document.
doc.BeginFrame("50%, 50%"
doc.AddFrame("http://www.novell.com")
doc.AddFrame("http://www.sun.com")
doc.EndFrame()
Defines the beginning of the function in an HTML document.
object.BeginFunction(
Function As String
[,Parameters As String])
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginFunction example defines the beginning of the "FunctionName" function.
doc.BeginFunction("FunctionName", "param1, param2")
doc.EndFunction()
Begins a heading definition in an HTML document.
object.BeginHeading()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginHeading example begins the Document component heading definition in the HTML document.
doc.BeginHeading()
doc.Title("Document component")
doc.Meta("Author", "Ken Ceo")
doc.EndHeading()
Begins an anchor definition in an HTML document.
object.BeginLink(
HREF As String
[,Name As String
[,Target As String]])
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginLink example begins the anchor definition in the HTML document.
doc.BeginLink("http://www.novell.com")
doc.Print("Novell home page")
doc.EndLink()
Defines a client-side image map.
object.BeginMap(
MapName As String)
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginMap example defines a client-side image map named ClientMap for the HTML document.
doc.BeginMap("ClientMap")
doc.MapArea("0, 0, 50 ,50", "http://www.novell.com", 1)
doc.MapArea("50, 50, 50 ,100", "http://www.microsoft.com", 1)
doc.MapArea("50, 100, 100 ,100", "http://www.sun.com", 1)
doc.EndMap()
Begins a No Script definition in an HTML document.
object.BeginNoScript()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This example shows the BeginNoScript method in its typical context. It begins a No Script definition in the HTML document.
doc.BeginNoScript()
Starts defining a numbered list in an HTML document.
object.BeginNumber()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginNumber example defines a numbered list in the HTML document.
doc.BeginNumber()
doc.AddNumber("Item1 in Numbered list")
doc.AddNumber("Item2 in Numbered list")
doc.AddNumber("Item3 in Numbered list")
doc.EndNumber()
Begins a table row in an HTML document.
object.BeginRow(
[HAlign As Integer
[,Valign As Integer]])
Alignment Constants.
Alignment Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginRow example defines a typical context of creating a row in a table and adding data to it.
doc.Begintable(TRUE)
doc.Caption("Table")
doc.BeginRow(3,3)
doc.Tableheading("Row1")
doc.Tableheading("Row2")
doc.EndRow()
doc.BeginRow(3,3)
doc.DataTable("col1 of row1")
doc.DataTable("col2 of row1")
doc.Endrow()
doc.BeginRow(3,3)
doc.DataTable("col1 of row2")
doc.Datatable("col2 of row2")
doc.EndRow()
doc.Endtable()
Defines the beginning of a script in an HTML document.
object.BeginScript(
[Language As String
[,Source As String]])
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginScript example defines the beginning of a script written with Novell script for NetWare, in the HTML document.
doc.BeginScript("Novell Script for NetWare","Process.bas")
Begins the definition of a combo box in an HTML document.
object.BeginSelect(
Variable As String
[,Size As Integer
[,Multiple As Boolean
[,Align As Integer]]])
Alignment Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginSelect example begins a combo box definition in the HTML document. It specifies a CGI variable of "Selection," allows a total of five items to be displayed in a combo box at a time, and allows multiple items to be selected in a combo box.
doc.BeginForm("process.bas")
doc.BeginSelect("Selection", 5, TRUE)
doc.OptionSelect("First option", "First", TRUE)
doc.OptionSelect("Second option", "Second", False)
doc.OptionSelect("Third option", "Third", False)
doc.OptionSelect("Fourth option", "Fourth", False)
doc.OptionSelect("Fifth option", "Fifth", False)
doc.OptionSelect("Sixth option", "Sixth", False)
doc.EndSelect()
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Defines the beginning of a table in an HTML document.
object.BeginTable(
Border As AnyType
[,Height As String
[,Width As String
[,HAlign As Integer
[,CellSpacing As Integer
[,CellPadding As Integer]]]]])
Alignment Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This BeginTable example defines the beginning of a table in the HTML document.
doc.BeginTable(TRUE)
doc.Caption("Table")
doc.BeginRow()
doc.TableHeading("Head1")
doc.TableHeading("Head2")
doc.EndRow()
doc.BeginRow()
doc.DataTable("Line11")
doc.DataTable("Line12")
doc.EndRow()
doc.BeginRow()
doc.DataTable("Line21")
doc.DataTable("Line22")
doc.EndRow()
doc.EndTable()
Adds a user-defined HTML tag to an HTML document.
object.BeginTag(
TagName As String
[,OptionalParameters As String])
Tag Name Constants.
Tag Name Constants.
Boolean. Returns TRUE if the tag is added to the HTML document, else returns FALSE.
This BeginTable example adds the HTML tag B to the HTML document. The B tag will print the word "Hello".
doc.BeginTag("B")
doc.Print("Hello")
doc.EndTag()
Adds a text area to an HTML document.
object.BeginTextArea(
Variable As String,
Rows As Integer,
Columns As Integer
[,Align As Integer])
Alignment Constants.
Boolean. Returns TRUE if the text area is added to the HTML document, else returns FALSE.
This BeginTextArea example adds the specified text area to the HTML document.
doc.BeginForm("process.bas")
doc.BeginTextArea("tVar", 5, 30)
doc.Print("This is the default Text")
doc.EndTextArea()
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Begins the body definition of an HTML document.
object.Body(
[BGColor As String,
[TextColor As String,
[LinkColor As String,
[BGGraphic As String]]]])
Color Constants.
Color Constants.
Color Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This Body example defines the body of the HTML document. The background color is red (#FF0000), the text color is green (#00FF00), and the link color is blue (#0000FF).
doc.Body("#FF0000", "#00FF00", "#0000FF")
doc.Print("This document has been generated by NSN")
Adds a line break to an HTML document.
object.Break()
None.
Boolean. Returns TRUE if the line break is added to the HTML document, else returns FALSE.
This Break example adds a line break to the HTML document.
doc.Print("This is the first line")
doc.Break()
doc.Print("This is the second line")
Creates a bulleted list for each specified parameter.
object.BulletList(
Item1 As String
[,ItemN As String])
Void.
This BulletList example creates a bulleted list that contains two items.
doc.BulletList("Item 1 of the bulleted list",
"Item 2 of the bulleted list")
Defines a button link in an HTML document.
object.ButtonLink(
HREF As String,
Text As String)
Boolean. Returns TRUE if successful, else returns FALSE.
This ButtonLink example defines a button link called "Novell Inc" that links to the Novell home page at http://www.novell.com.
doc.ButtonLink("http://www.novell.com", "Novell Inc")
Adds a table caption to an HTML document.
object.Caption(
Caption As String,
Align As Integer)
Alignment Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This Caption example adds the title "Table" to the table in the HTML document.
doc.BeginTable(TRUE)
doc.Caption("Table")
doc.BeginRow()
doc.TableHeading("Head1")
doc.TableHeading("Head2")
doc.EndRow()
doc.BeginRow()
doc.DataTable("Line11")
doc.DataTable("Line12")
doc.EndRow()
doc.Beginrow()
doc.DataTable("Line21")
doc.DataTable("Line22")
doc.EndRow()
doc.EndTable()
Creates a check box in an HTML document.
object.CheckBox(
Variable As String,
Value As String,
Text As String,
Check As Boolean
[,Align As Integer])
Color Constants.
Alignment Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This CheckBox example creates four check boxes in the HTML document. The first check box is labeled green and is selected by default initially. The next three check boxes are labeled red, blue, and yellow respectively and are unchecked by default.
doc.BeginForm("process.bas")
doc.CheckBox("Color", "Green", "Green", TRUE)
doc.Break
doc.CheckBox("Color", "Red", "Red", FALSE)
doc.Break
doc.CheckBox("Color", "Blue", "Blue", FALSE)
doc.Break
doc.CheckBox("Color", "Yellow", "Yellow", FALSE)
doc.Break
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Adds data to a table.
object.DataTable(
Data As String
[, Height As String
[, Width As String
[, Halign As Integer
[, Valign As Integer
[, BGColor As String]]]]])
Alignment Constants.
Alignment Constants.
Color Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This DataTable example adds Line11, Line12, Line21, and Line22 to the table in the HTML document.
doc.BeginTable(TRUE)
doc.Caption("Table")
doc.BeginRow()
doc.TableHeading("Head1")
doc.TableHeading("Head2")
doc.EndRow()
doc.BeginRow()
doc.DataTable("Line11")
doc.DataTable("Line12")
doc.EndRow()
doc.BeginRow()
doc.DataTable("Line21")
doc.DataTable("Line22")
doc.EndRow()
doc.EndTable()
Ends the definition of a bulleted list within an HTML document.
object.EndBullet()
None.
Boolean. Returns TRUE if the bulleted list is ended successfully, else returns FALSE.
This EndBullet example ends the definition of the bulleted list in the HTML document.
doc.BeginBullet()
doc.AddBullet("Item1 in Bulleted list")
doc.AddBullet("Item2 in Bulleted list")
doc.AddBullet("Item3 in Bulleted list")
doc.EndBullet()
Ends the data definition within a table in an HTML document.
object.EndData()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndData example ends the data definition in the HTML document.
doc.BeginTable(TRUE)
doc.Caption("Table")
doc.BeginRow()
doc.TableHeading("Head1")
doc.TableHeading("Head2")
doc.EndRow()
doc.BeginRow()
doc.DataTable("Line11")
doc.DataTable("Line12")
doc.EndRow()
doc.BeginRow()
doc.BeginData()
doc.Print("Line21")
doc.EndData()
doc.BeginData()
doc.Print("Line22")
doc.EndData()
doc.EndRow()
doc.EndTable()
Ends the font definition within a table in an HTML document.
object.EndFont()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndFont example ends the font definition in the HTML document.
doc.BeginFont("#FF0000", "7")
doc.Print("Doc Component")
doc.EndFont()
Ends the definition of an HTML form.
object.EndForm()
None.
Void.
This EndForm example ends the definition of an HTML form.
doc.BeginForm("process.bas")
doc.CheckBox("Var", "Green", "Green", TRUE)
doc.Break()
doc.CheckBox("Var", "Red", "Red", FALSE)
doc.Break()
doc.CheckBox("Var", "Blue", "Blue", TRUE)
doc.Break()
doc.CheckBox("Var", "Yellow", "Yellow", FALSE)
doc.Break()
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Ends a frame definition in an HTML document.
object.EndFrame()
None.
Void.
This EndFrame example ends two frames in the HTML document.
doc.BeginFrame("50%, 50%", "", TRUE, "#008000", 10)
doc.AddFrame("http://www.novell.com")
doc.BeginFrame("", "50%, 50%", TRUE, "#008000", 10)
doc.AddFrame("http://www.sun.com")
doc.AddFrame("http://www.microsoft.com")
doc.EndFrame()
doc.EndFrame()
Ends a function definition in an HTML document.
object.EndFunction()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndFunction example ends the function definition in the HTML document.
doc.BeginFunction("Function1", "param1, param2")
doc.Print("document.Write(\"Out put from function 1\")")
doc.EndFunction()
Ends the heading definition in an HTML document.
object.EndHeading()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndHeading example ends the heading definition in the HTML document.
doc.BeginHeading()
doc.Title("Document component")
doc.Meta("Author", "Ken Ceo")
doc.EndHeading()
Ends an anchor definition in an HTML document.
object.EndLink()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndLink example ends the anchor definition in the HTML document.
doc.BeginLink("http://www.novell.com")
doc.Print("Novell home page")
doc.EndLink()
Ends a client-side image map definition in an HTML document.
object.EndMap()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndMap example ends the client-side definition image map in the HTML document.
doc.BeginMap("ClientMap")
doc.MapArea("0, 0, 50 ,50", "http://www.novell.com", 1)
doc.MapArea("50, 50, 50 ,100", "http://www.microsoft.com", 1)
doc.MapArea("50, 100, 100 ,100", "http://www.sun.com", 1)
doc.EndMap()
Ends the definition of a no script in an HTML document.
object.EndNoScript()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndNoScript example ends the no script definition in the HTML document.
doc.EndNoScript()
Ends a numbered list definition in an HTML document.
object.EndNumber()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndNumber example ends the numbered list definition in the HTML document.
doc.BeginNumber()
doc.AddNumber("Item1 in Numbered list")
doc.AddNumber("Item2 in Numbered list")
doc.AddNumber("Item3 in Numbered list")
doc.EndNumber()
Ends a table row definition in an HTML document.
object.EndRow()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndRow example ends the table row definitions in the HTML document.
doc.BeginTable(TRUE)
doc.Caption("Table")
doc.BeginRow()
doc.TableHeading("Head1")
doc.TableHeading("Head2")
doc.EndRow()
doc.BeginRow()
doc.DataTable("Line11")
doc.DataTable("Line12")
doc.EndRow()
doc.BeginRow()
doc.BeginData()
doc.Print("Line21")
doc.EndData()
doc.BeginData()
doc.Print("Line22")
doc.EndData()
doc.EndRow()
doc.EndTable()
Ends the script definition in an HTML document.
object.EndScript()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndScript example ends the script definition in the HTML document.
doc.EndScript()
Ends a combo box definition in an HTML document.
object.EndSelect()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndSelect example ends the combo box definition in the HTML document.
doc.BeginForm("process.bas")
doc.BeginSelect("Selection", 5, TRUE)
doc.OptionSelect("First option", "First", TRUE)
doc.OptionSelect("Second option", "Second", False)
doc.OptionSelect("Third option", "Third", False)
doc.OptionSelect("Fourth option", "Fourth", False)
doc.OptionSelect("Fifth option", "Fifth", False)
doc.OptionSelect("Sixth option", "Sixth", False)
doc.EndSelect()
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Ends a table definition in an HTML document.
object.EndTable()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndTable example ends the table definition in the HTML document.
doc.BeginTable(TRUE)
doc.Caption("Table")
doc.BeginRow()
doc.TableHeading("Head1")
doc.TableHeading("Head2")
doc.EndRow()
oc.BeginRow()
doc.DataTable("Line11")
doc.DataTable("Line12")
doc.EndRow()
doc.BeginRow()
doc.DataTable("Line21")
doc.DataTable("Line22")
doc.EndRow()
doc.EndTable()
Writes an end of tag marker to the HTML document.
object.EndTag()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndTag example writes an end of tag marker to the HTML document.
doc.BeginTag("B")
doc.Print("Hello")
doc.EndTag()
Defines the end of a text box in an HTML document.
object.EndTextArea()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This EndTextArea example defines the end of a text edit box in the HTML document.
doc.BeginForm("process.bas")
doc.BeginTextArea("tVar", 5, 30)
doc.Print("This is the default Text")
doc.EndTextArea()
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Enables or disables the HTML formatting in a document.
object.Format(
HTMLFormatting As Boolean)
Boolean. Returns TRUE if successful, else returns FALSE.
This Format example enables HTML formatting in the HTML document.
doc.Format(TRUE)
Reads the value of an HTML environment variable.
object.GetEnvVar(
Variable As String)
String.
This GetEnvVar example reads the value of QUERY_STRING in the HTML document.
doc.Print(doc.GetEnvVar("QUERY_STRING")
Reads one or all of the CGI variables.
object.GetVar(
Variable As String,
DefaultValue As String)
String.
This GetVar example reads the CGI variables Color and Red.
doc.Print(doc.GetVar("Color", "Red"))
Defines a graphic link in an HTML document.
object.GraphicLink(
HREF As String
FileName As String)
Boolean. Returns TRUE if successful, else returns FALSE.
This GraphicLink example defines a link to the graphic novell.jpg in the HTML document.
doc.GraphicLink("http://www.novell.com", "novell.jpg")
Adds a title to an HTML document.
object.Heading(
Heading As String)
Boolean. Returns TRUE if successful, else returns FALSE.
This Heading example adds the title Document component to the HTML document.
doc.Heading("Document component")
doc.Print("This text will appear in the browser")
Defines a hidden input field within an HTML form.
object.HiddenEntry(
Variable As String,
cValue As String)
Void.
This HiddenEntry example defines the hidden input field HiddenVariable within the HTML form.
doc.HiddenEntry("HiddenVariable", "Value")
Adds an image to an HTML document.
object.Image(
FileName As String,
Alt As String
[,Height As Integer
[,Width As Integer
[,Align As Integer
[,Border As Integer
[,Map As String]]]]])
Alignment Constants.
Void.
This Image example adds the image novell.jpg to the HTML document.
doc.Image("novell.jpg", "Novell")
Returns the path of the image files in an HTML document.
object.ImagePath()
None.
String.
This ImagePath example returns the path of the image files in the HTML document.
doc.Print(doc.ImagePath())
Adds a horizontal line to an HTML document.
object.Line(
Size As Integer,
Width As Integer)
Boolean. Returns TRUE if successful, else returns, else returns FALSE.
This Line example adds a horizontal line to the HTML document that is one pixel thick and runs half the width of the document.
doc.Line(1,50)
Defines an area in a client-side image map.
object.MapArea(
Coords As String,
HREF As String
[,Shape As Integer
[,Target As String]])
Shape Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This MapArea example defines three areas in the client-side image map. Each MapArea operation defines one-third of a rectangle.
doc.beginmap("ClientMap")
doc.maparea("0, 0, 50, 50", "http://www.novell.com", 1)
doc.maparea("0, 50, 50, 100", "http://www.microsoft.com", 1)
doc.maparea("0, 100, 50, 150", "http://www.sun.com", 1)
doc.endmap()
Defines the HTTP meta name/value pair for the document. These are used to extend the HTTP header information returned by the HTTP server.
object.Meta(
Name As String,
Content As String
[,HTTP-EQUIV As String])
Optional. Can be used in place of the NAME attribute and has a special significance when the documents are loaded by the HTTP server.
Boolean. Returns TRUE if successful, else returns FALSE.
This Meta example defines the HTTP meta name/value pair for the HTML document.
doc.BeginHeading()
doc.Title("Document component testing")
doc.Meta("Author","Ken Ceo")
doc.Meta("Keywords","NSN, Doc, Testing")
doc.EndHeading()
Creates a numbered list in an HTML document.
object.NumberList(
Item1 As String
[,ItemN As String])
Void.
This method takes a maximum of 15 items (including Item1) corresponding to the ItemN parameter.
This NumberList example creates a three-item numbered list in the HTML document.
doc.NumberList("Milk","Eggs","Bread")
Adds an option to a combo box in an HTML document.
object.OptionSelect(
Option As String
[,Value As String
[,Selected As Boolean]])
Boolean. Returns TRUE if successful, else returns FALSE.
This OptionSelect example adds six options to the combo box in the HTML document.
doc.BeginForm("process.bas")
doc.BeginSelect("Selection", 5, TRUE)
doc.OptionSelect("First option", "First", TRUE)
doc.OptionSelect("Second option", "Second", False)
doc.OptionSelect("Third option", "Third", False)
doc.OptionSelect("Fourth option", "Fourth", False)
doc.OptionSelect("Fifth option", "Fifth", False)
doc.OptionSelect("Sixth option", "Sixth", False)
doc.EndSelect()
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Begins a new paragraph in an HTML document.
object.Paragraph(
[AlignType As Integer
[,HTMLAttrs As String]])
Alignment Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This Paragraph example begins a new paragraph in the HTML document.
doc.Print("This is the first paragraph.")
doc.Paragraph(3,"ID=Para#1")
doc.Print("This is the second paragraph.")
Parses a query string within a user-defined object.
object.Parse(
QueryString As String)
Object.
This Parse example parses a query string within a user-defined object.
doc.Parse()
Creates a password entry object in an HTML document.
object.PasswordEntry(
Variable As String
[,Value As String
[,Label As String
[,MaxLength As String
[,Size As String
[,Align As Integer]]]]])
Alignment Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This PasswordEntry example creates a password entry object in the HTML document.
doc.BeginForm("process.bas")
doc.PasswordEntry("password","xyz","Enter the password", "20")
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Prints the information to an HTML document.
object.Print(
[Item1 As String]
[,ItemN As String])
Void.
This method takes a maximum of 15 items (including Item1) corresponding to the ItemN parameter.
This Print example prints the specified information to the HTML document.
doc.Print("Once again, Novell leads the way!")
Defines a radio button in an HTML document.
object.RadioButton(
Variable As String,
Value As String,
Message As String
Checked As Boolean,
[,Align As Integer])
Alignment Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This RadioButton example defines five radio buttons in the HTML document.
doc.BeginForm("process.bas")
doc.Print("Select the color")
doc.Break()
doc.RadioButton("Var", "Green", "Green", TRUE)
doc.Break()
doc.RadioButton("Var", "Red", "Red", FALSE)
doc.Break()
doc.RadioButton("Var", "Blue", "Blue", FALSE)
doc.Break()
doc.RadioButton("Var", "Yellow", "Yellow", FALSE)
doc.Break()
doc.RadioButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Stops the creation of the HTTP header in an HTML document.
object.Raw()
None.
Boolean. Returns TRUE if successful, else returns FALSE.
This Raw example stops the creation of an HTTP header in the HTML document.
doc.Raw()
Adds a reset form to the defaults button in an HTML document.
object.ResetButton(
Value As String
[,Align As Integer]))
Alignment Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This ResetButton example adds a reset form to the default button in the HTML document.
doc.BeginForm("process.bas")
doc.Print("Select the color")
doc.Break()
doc.RadioButton("Var", "Green", "Green", TRUE)
doc.Break
doc.RadioButton("Var", "Red", "Red", FALSE)
doc.Break
doc.RadioButton("Var", "Blue", "Blue", FALSE)
doc.Break
doc.RadioButton("Var", "Yellow", "Yellow", FALSE)
doc.Break
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Adds a submit form to the defaults button to an HTML document.
object.SubmitButton(
Value As String
[,Align As Integer])
Alignment Constants
Boolean. Returns TRUE if successful, else returns FALSE.
This SubmitButton example adds a submit form button to the HTML document.
doc.BeginForm("process.bas")
doc.Print("Select the color")
doc.Break()
doc.RadioButton("Var", "Green", "Green", TRUE)
doc.Break()
doc.RadioButton("Var", "Red", "Red", FALSE)
doc.Break()
doc.RadioButton("Var", "Blue", "Blue", FALSE)
doc.Break()
doc.RadioButton("Var", "Yellow", "Yellow", FALSE)
doc.Break()
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Adds a heading to a table in an HTML document.
object.TableHeading(
Heading As String
[,Height As String
[,Width As String
[,HAlign As Integer
[,VAlign As Integer]]]])
Alignment Constants.
Alignment Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This TableHeading example adds two headings to a table in the HTML document.
doc.BeginTable(TRUE)
doc.Caption("Table")
doc.BeginRow()
doc.TableHeading("Head1")
doc.TableHeading("Head2")
doc.EndRow()
doc.BeginRow()
doc.DataTable("Line11")
doc.DataTable("Line12")
doc.EndRow()
doc.BeginRow()
doc.BeginData()
doc.Print("Line21")
doc.EndData()
doc.BeginData()
doc.Print("Line22")
doc.EndData()
doc.EndRow()
doc.EndTable()
Defines a text edit box in an HTML document.
object.TextArea(
Variable As String,
Rows As Integer,
Columns As Integer,
Text As String)
Void.
This TextArea example defines a text edit box of five rows and thirty columns in the HTML document.
doc.BeginForm("process.bas")
doc.TextArea("tVar", 5, 30, "This is the default text")
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Defines a text input area in an HTML document.
object.TextEntry(
Variable As String
[,Value As String
[,Label As String
[,MaxLength As String
[,Size As String
[,Align As Integer]]]]])
Alignment Constants.
Boolean. Returns TRUE if successful, else returns FALSE.
This TextEntry example defines a text input area in the HTML document.
doc.BeginForm("process.bas")
doc.TextEntry("tvar","Initial Value","Testing the Text Entry","10",70" 0)
doc.ResetButton("Reset the form")
doc.SubmitButton("Submit the form")
doc.EndForm()
Defines a text link in an HTML document.
object.TextLink(
HREF As String,
Text As String)
Boolean. Returns TRUE if successful, else returns FALSE.
This TextLink example defines a text link to the Novell Web site.
doc.TextLink("http://www.novell.com", "Novell")
Adds a title to an HTML document.
object.Title(
Title As String)
Boolean. Returns TRUE if successful, else returns FALSE.
This Title example adds the title Document component to the HTML document.
doc.BeginHeading()
doc.Title("Document component")
doc.Meta("Author", "Ken Ceo")
doc.EndHeading()
Translates the NLM screen contents to display in a browser.
object.TranslateScreen(
Buffer As String
[,HighlightOn As String,
HighlightOff As String]]
Boolean. Returns TRUE if successful, else returns FALSE.
This TranslateScreen example translates the NLM screen contents to display in a browser.
set server= createobject("ucx:server")
set screens= server.Screens
screens.Reset()
set scr=screens.Next()
buf= scr.Read
doc.TranslateScreen(buf)
Returns the URL prefix used by an NSN script.
object.URLPrefix()
None.
String.
This URLPrefix example returns the /NSN which is the URL prefix for NSN script.
doc.Print(doc.URLPrefix())
At the end of the HTML page, this method displays the message: “This page was created by NSN. For more information on additional NLM components, contact Novell."
object.ZZEval()
None.
Void.
This ZZEVal example causes the message “This page was created by NSN. For more information on additional NLM components, contact Novell” to be generated at the end of HTML page.
doc.ZZEval()