Dynamicweb API
Base Class Members
See Also  Fields  Properties  Methods  Send Feedback
Dynamicweb Namespace : Base Class


The following tables list the members exposed by Base.

Public Fields

 NameDescription
public Fieldstatic (Shared in Visual Basic)DWAssemblyVersion  
Top

Public Properties

 NameDescription
public Propertystatic (Shared in Visual Basic)DefaultSmtpServer Returns the first SMTP server from the controlpanel if more then one.  
Top

Public Methods

 NameDescription
public Methodstatic (Shared in Visual Basic)AccessGetValue  
public Methodstatic (Shared in Visual Basic)AddToQueryStringOverloaded.   
public Methodstatic (Shared in Visual Basic)AutoLogin Starts the AutoLogin  
public Methodstatic (Shared in Visual Basic)CanEdit Checks whether a page can be edited.  
public Methodstatic (Shared in Visual Basic)CheckArrayStrings  
public Methodstatic (Shared in Visual Basic)CheckCharInString Checks whether there is a characters in different cases within input string.  
public Methodstatic (Shared in Visual Basic)CheckCharInStringCheckerChecks whether two strings contain similar characters.  
public Methodstatic (Shared in Visual Basic)CheckGetPos  
public Methodstatic (Shared in Visual Basic)CheckGetStatus Checks whether a paragraph is being edited.  
public Methodstatic (Shared in Visual Basic)CheckIn Checks in a paragraph so that it may be edited by other users.  
public Methodstatic (Shared in Visual Basic)CheckNumberInString Checks whether there is a number within input string.  
public Methodstatic (Shared in Visual Basic)CheckOut Checks out a paragraph so that it cannot be edited by another user.  
public Methodstatic (Shared in Visual Basic)CheckSpecialCharInString Checks whether there is a special characters within input string.  
public Methodstatic (Shared in Visual Basic)ChkBooleanOverloaded.  Checks the input string for a true/false statement and returns it as a Boolean.  
public Methodstatic (Shared in Visual Basic)ChkChecked Tests a checkbox value and returns "Checked" if it has been selected.  
public Methodstatic (Shared in Visual Basic)ChkCheckField Checks the input string for a true/false statement and returns it as a integer.  
public Methodstatic (Shared in Visual Basic)ChkDate Determines wether or not an object is 'something' (as opposed to nothing), and if the object type is a date. If so, the function returns the value of the date object. In all other cases Now is returned.  
public Methodstatic (Shared in Visual Basic)ChkDouble Checks the input for a correct Double value.  
public Methodstatic (Shared in Visual Basic)ChkInteger Checks the input for a correct integer value and returns 0 if value is not a valid integer.  
public Methodstatic (Shared in Visual Basic)ChkLong  
public Methodstatic (Shared in Visual Basic)ChkNumber Checks the input for a correct integer value.  
public Methodstatic (Shared in Visual Basic)ChkPassword Checks whether a new password is acceptably secure.  
public Methodstatic (Shared in Visual Basic)ChkString Checks whether the input from the database is DBNull.  
public Methodstatic (Shared in Visual Basic)ChkValue Checks if the string is an instance of an object.  
public Methodstatic (Shared in Visual Basic)ChkValueNoStrip Converts HTML to correct XHTML.  
public Methodstatic (Shared in Visual Basic)ChkValuesChecks whether the input value is empty.  
public Methodstatic (Shared in Visual Basic)CleanInputForXML Replaces illegal chars with their html-representation  
public Methodstatic (Shared in Visual Basic)CQuad Converts a IPv4 address to Quad.  
public Methodstatic (Shared in Visual Basic)CreateLightVersionPages Returns true if the site can create more pages  
public Methodstatic (Shared in Visual Basic)Currency Converts a price to another currency.  
public Methodstatic (Shared in Visual Basic)CurrentVersion Returns the current version.  
public Methodstatic (Shared in Visual Basic)DatareaderToCSV Create a CSV file.  
public Methodstatic (Shared in Visual Basic)DefaultToUtf8Encoding Converts strings to UTF-8 that have been saved in cookies with characters above ASCII127. IE æøå or japanese strings would be geberish if not converted  
public Methodstatic (Shared in Visual Basic)DeletedFolderPathOverloaded.   
public Methodstatic (Shared in Visual Basic)DoubleFromStringConvert input value from string to double.  
public Methodstatic (Shared in Visual Basic)DoubleParseWithCulture Parses the string as a Double using the current culture of the backend or frontend user.  
public Methodstatic (Shared in Visual Basic)DWAssemblyVersionInformation  
public Methodstatic (Shared in Visual Basic)Form2XMLOverloaded.  Puts data posted from a form into an XML document.  
public Methodstatic (Shared in Visual Basic)GetAccessElements Returns restricted elements (ex. folders).  
public Methodstatic (Shared in Visual Basic)GetAreaNameOverloaded.  Returns the name for the specified area ID.  
public Methodstatic (Shared in Visual Basic)GetCultureOverloaded.   
public Methodstatic (Shared in Visual Basic)GetCurrencyPickerControlOverloaded.  Returns HTML representing a currency picker.  
public Methodstatic (Shared in Visual Basic)GetElementAccess Returns the permissions for a specific element.  
public Methodstatic (Shared in Visual Basic)GetFileEncoding Returns the file encoding.  
public Methodstatic (Shared in Visual Basic)getFileextension Returns the file extension of the specified file.  
public Methodstatic (Shared in Visual Basic)getFileSize Converts bytes to KB or MB.  
public Methodstatic (Shared in Visual Basic)getFileSizeKB Converts bytes to KB with 2 decimals  
public Methodstatic (Shared in Visual Basic)GetGs Reads a setting from the globalsettings file.  
public Methodstatic (Shared in Visual Basic)GetHttpDirectory Determines the Http directory.  
public Methodstatic (Shared in Visual Basic)GetHttpDomain Returns the protocol and host of the current pageview  
public Methodstatic (Shared in Visual Basic)GetHttpUrl Returns the written path of the current URL.  
public Methodstatic (Shared in Visual Basic)GetHttpUrlNoScript Returns the current URL from the client.  
public Methodstatic (Shared in Visual Basic)GetHttpUrlRaw Returns the URL of the current pageview  
public Methodstatic (Shared in Visual Basic)GetIcon Determines whether you can create an icon for current file extension type.  
public Methodstatic (Shared in Visual Basic)GetInternal Returns the name of the page in the specified URL.  
public Methodstatic (Shared in Visual Basic)GetInternalPageID Returns the internal ID of the page in the specified URL.  
public Methodstatic (Shared in Visual Basic)getModuleName Returns the name of a module based on its system name.  
public Methodstatic (Shared in Visual Basic)getModuleSettingsPage Returns the module settings page of a module based on its system name.  
public Methodstatic (Shared in Visual Basic)getOrientation Returns the orientation of a picture.  
public Methodstatic (Shared in Visual Basic)GetParagraphModuleSettingsOverloaded.  Returns the paragraph module settings for the specified ParagraphID.  
public Methodstatic (Shared in Visual Basic)getRatio Returns the ratio between width and height.  
public Methodstatic (Shared in Visual Basic)GetStrHrefGet an appropriate Href from the input URL.  
public Methodstatic (Shared in Visual Basic)GetStrHrefFriendly Get an appropriate Href from input friendly URL.  
public Methodstatic (Shared in Visual Basic)GetUserElementAccess Returns elements which the specified user has access to.  
public Methodstatic (Shared in Visual Basic)GsExists Determines wether a setting i present in the globalsettings file.  
public Methodstatic (Shared in Visual Basic)HasAccessOverloaded.  Checks if the current user has access to the module This is the same as calling HasAccess(moduleSystemName, Nothing)  
public Methodstatic (Shared in Visual Basic)HasAccessHIDE Returns a value to show or hide information based on the current user's access rights.  
public Methodstatic (Shared in Visual Basic)HasGs Gets value indicating whether specified setting is defined in the global settings file.  
public Methodstatic (Shared in Visual Basic)HasVersion Checks whether the current version number meets a minimum version requirement.  
public Methodstatic (Shared in Visual Basic)HighlightFiles Processed an input source in aim to find references(href) to internal files and replace them with an appropriate one.  
public Methodstatic (Shared in Visual Basic)HtmlEncode Escapes characters such as '"'  
public Methodstatic (Shared in Visual Basic)IIfOverloaded.  This function works as a single line if-statement.  
public Methodstatic (Shared in Visual Basic)InIPRange Checks whether an IPv4 is within a specified range  
public Methodstatic (Shared in Visual Basic)IsAdministrator Determines whether the AccessUser is an administrator.  
public Methodstatic (Shared in Visual Basic)IsAdminLoggedIn Is the current visitor logged into admin  
public Methodstatic (Shared in Visual Basic)IsCustomSolution  
public Methodstatic (Shared in Visual Basic)IsDeveloperOverloaded.  Check is the user is a developer DO NOT USE - only for test, ask TFC  
public Methodstatic (Shared in Visual Basic)IsImage Checks for valid image file extension.  
public Methodstatic (Shared in Visual Basic)IsInternal Checks whether an URL is an internal page of the current website  
public Methodstatic (Shared in Visual Basic)IsModuleInstalled Checks whether the specified module is installed.  
public Methodstatic (Shared in Visual Basic)IsUserAgentHandHeld Checks whether the current useragent is a handheld computer.  
public Methodstatic (Shared in Visual Basic)IsValueInArrayOverloaded.  Checks an integer array for a specific value.  
public Methodstatic (Shared in Visual Basic)IsValueInArrayList Checks an arraylist of arrays for a value at a specific index.  
public Methodstatic (Shared in Visual Basic)JSEnable Escapes any ' or " in the input string by inserting \ in front of them.  
public Methodstatic (Shared in Visual Basic)JSEncode Replaces string for javascript use.  
public Methodstatic (Shared in Visual Basic)JSEscapeParse Encodes or Decodes an input string for javascript use.  
public Methodstatic (Shared in Visual Basic)LightVersionPages Returns the number of pages in solution  
public Methodstatic (Shared in Visual Basic)MD5HashToString Encrypts a string using MD5 encryption.  
public Methodstatic (Shared in Visual Basic)MediaSettings Fills extList string with all valid extensions.  
public Methodstatic (Shared in Visual Basic)MenuRestart  
public Methodstatic (Shared in Visual Basic)MultiplyStringMultiplied an input string by required times.  
public Methodstatic (Shared in Visual Basic)NewLineToBR  
public Methodstatic (Shared in Visual Basic)NumberOfDecimalPlaces Returns the number of decimal places  
public Methodstatic (Shared in Visual Basic)OpenWindowStrip Determine whether to open window or not.  
public MethodParseInt Checks the input for a integer value.  
public Methodstatic (Shared in Visual Basic)ParseLinkManager Parse the input Name property for LinkManager.  
public Methodstatic (Shared in Visual Basic)PasswordGenerate Generates a random password.  
public Methodstatic (Shared in Visual Basic)pwEncrypt Encrypts a string with MD5 encryption.  
public Methodstatic (Shared in Visual Basic)ReadTextFileOverloaded.  Returns the contents of a text file as a string.  
public Methodstatic (Shared in Visual Basic)RedirectToAspx Converts URLs with ".asp" to ".aspx".  
public Methodstatic (Shared in Visual Basic)ReplaceQueryStringOverloaded.   
public Methodstatic (Shared in Visual Basic)ReplaceStringOverloaded.  Case insensitive replace  
public Methodstatic (Shared in Visual Basic)RequestOverloaded.  Instead of using Request.QueryString or Request.Form  
public Methodstatic (Shared in Visual Basic)ReturnExtranetMasterSchemeReturns master scheme for user information.  
public Methodstatic (Shared in Visual Basic)RoundUp Rounds up a double value to an integer.  
public Methodstatic (Shared in Visual Basic)SetElementAccess Sets the permissions for a specific element.  
public Methodstatic (Shared in Visual Basic)SetGsOverloaded.  Writes a setting to the globalsettings file.  
public Methodstatic (Shared in Visual Basic)StringToIntArray Converts a , seperated string to an int array  
public Methodstatic (Shared in Visual Basic)StripHTML Strips a string of all HTML.  
public Methodstatic (Shared in Visual Basic)StripHTML_ALT Strips a string of all HTML tags.  
public Methodstatic (Shared in Visual Basic)StripIllegalChars Strips a string of characters other than "abcdefghijklmnopqrstuvwxyzæøå0123456789@. _-".  
public Methodstatic (Shared in Visual Basic)StripIllegalCharsExt Strips a string of invalid characters.  
public Methodstatic (Shared in Visual Basic)StripIllegalCharsSimpleOverloaded.  Strips a string of invalid characters.  
public Methodstatic (Shared in Visual Basic)StripOfficeHtml  
public Methodstatic (Shared in Visual Basic)StrippedQueryStringOverloaded.   
public Methodstatic (Shared in Visual Basic)TeaserString Returns a teaser text e.g. headlines  
public Methodstatic (Shared in Visual Basic)ToggleDebug If Query string parameter Debug=True, a session variable DW_Debug is set to "True". if the parameter Debug=False the DW_Debug parameter is removed from the session object.  
public Methodstatic (Shared in Visual Basic)URLEnableOverloaded.  Replaces any questionmark, hash and ampersand in the input string.  
public Methodstatic (Shared in Visual Basic)ValidateEmail Checks for a valid e-mail format.  
public Methodstatic (Shared in Visual Basic)w Response writes the object to the client.  
public Methodstatic (Shared in Visual Basic)wa Writes the alert message to the client.  
public Methodstatic (Shared in Visual Basic)we Response writes the object to the client and ends the response stream.  
public Methodstatic (Shared in Visual Basic)whe Response writes the objects data htmlencoded to the client.  
public Methodstatic (Shared in Visual Basic)WrapImage Wraps an image into the table layout so it is suitable for frontend editing.  
public Methodstatic (Shared in Visual Basic)WriteEventLog  
public Methodstatic (Shared in Visual Basic)WriteTextFileOverloaded.  Writes a string to a text file.  
public Methodstatic (Shared in Visual Basic)XmlXsltParseOverloaded.  Parses the XML document using the passed xsltReader.  
Top

See Also

© 2011 www.dynamicweb-cms.com - All Rights Reserved.