InsertFieldWithObjects Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Inserts a field with an object in a presentation template. The data is written as HTML to the supplied stream or the default response stream. The InsertfieldWithObjects class acts as the underlying engine for the Insert field with object AS component.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingPageableComponent
        ContentStudio.Site.ActiveScriptingEPTBase
          ContentStudio.Site.ActiveScripting.EPTInsertFieldWithObjects

Namespace: ContentStudio.Site.ActiveScripting.EPT
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public class InsertFieldWithObjects : EPTBase

The InsertFieldWithObjects type exposes the following members.

Constructors

  NameDescription
Public methodInsertFieldWithObjects
Initializes a new instance of the InsertFieldWithObjects class
Top
Properties

  NameDescription
Public propertyBackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public propertyComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Protected propertyCode exampleCS_DataFields
Gets a EPTXmlParser that contains a collection of EPT field definitions and values. This property is the replacement for the obsolete EPT_GetFieldName(String) and EPT_GetFieldValue(String) methods.
(Inherited from CodeBase.)
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Protected propertyPage
A reference to the current context page. This will initialize in the constructor of this class.
(Inherited from CodeBase.)
Protected propertyRunningUserControl
Gets the current running user control.
(Inherited from CodeBase.)
Top
Methods

  NameDescription
Protected methodBuildHTMLComponentException
Returns an component exception in HTML format.
(Inherited from ActiveScriptingBase.)
Protected methodCreatePageRange
Create a page range in HTML or XHTML
(Inherited from PageableComponent.)
Protected methodCSF_LookUpField(Int32, String, String, String)
Used for id lookups from xmlindex
(Inherited from EPTBase.)
Protected methodCSF_LookUpField(Int32, String, String, String, Boolean, Int32)
Used for id lookups from xmlindex
(Inherited from EPTBase.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodGenerateLinkTargetAttribute
Returns the attribute string to be written to the link.
(Inherited from ActiveScriptingBase.)
Protected methodGetCorrectField
Extracts the correct value from a passed in EPT field name and a static field value.
(Inherited from ActiveScriptingBase.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodStatic memberInvoke(String)
Invokes the component and writes its content into the default response stream. It is done without the extra query string and username/password, but with relative URL replacement, stripped HTML headers, cached objects, delegated cookies, delegated query strings and with HTTP object stored in external objects.
Public methodStatic memberInvoke(String, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32, Boolean, Boolean)
Invokes the component and writes its content into the default response stream.
Public methodStatic memberInvoke(Stream, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32, Boolean, Boolean)
Invokes the component and writes its content into the specified stream
Public methodStatic memberInvoke(String, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32, Boolean, Boolean, Boolean)
Invokes the component and writes its content into the specified stream
Public methodStatic memberInvoke(Stream, MasterPageBase, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32, Boolean, Boolean)
Invokes the component and writes its content into the specified stream
Public methodStatic memberInvoke(Stream, UserControlBase, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32, Boolean, Boolean)
Invokes the component and writes its content into the specified stream
Public methodStatic memberInvoke(Stream, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32, Boolean, Boolean, Boolean)
Invokes the component and writes its content into the specified stream
Public methodStatic memberInvoke(MasterPageBase, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32, Boolean, Boolean, Boolean)
Invokes the component and writes its content into the specified stream
Public methodStatic memberInvoke(SiteBase, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32, Boolean, Boolean, Boolean)
Invokes the component and writes its content into the specified stream
Public methodStatic memberInvoke(UserControlBase, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32, Boolean, Boolean, Boolean)
Invokes the component and writes its content into the specified stream
Public methodStatic memberInvoke(Stream, SiteBase, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32, Boolean, Boolean, Boolean)
Invokes the component and writes its content into the specified stream
Public methodStatic memberInvoke(Stream, SiteBase, UserControlBase, String, String, String, String, Boolean, Boolean, Boolean, Boolean, Int32, Boolean, Boolean, Boolean)
Invokes the component and writes its content into the specified stream
Protected methodMakeDirectEditIcon
Method for creating an direct edit icon used in web view
(Inherited from EPTBase.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodPrepareSortCells(Stream, Boolean, String, String, String, String, String, String, Boolean, Boolean)
Prepare sort cells. Writes a <td></td> or <span></span> portion of sort cell.
(Inherited from EPTBase.)
Protected methodPrepareSortCells(Stream, Boolean, String, String, String, String, String, String, Boolean, Boolean, Boolean)
Prepare sort cells. Writes a <td></td> or <span></span> portion of sort cell.
(Inherited from EPTBase.)
Protected methodReadFromApplicationCache
Returns data that is read from the application cache.
(Inherited from ActiveScriptingBase.)
Protected methodReturnQueryAsDictionary
Returns a Dictionary containing query results.
(Inherited from EPTBase.)
Protected methodSetApplicationCache
Stores a string in the application cache.
(Inherited from ActiveScriptingBase.)
Protected methodSyncronizeMLC
Provides support for components that needs to be MLC aware, by localizing the supplied category or presentation template from the current document, or the preferred language of the visitor.
(Inherited from ActiveScriptingBase.)
Public methodToString (Inherited from Object.)
Protected methodWriteAttribute(TextWriter, String, String)
Writes an attribute string to the supplied stream, unless Value is an empty string or null
(Inherited from ActiveScriptingBase.)
Protected methodWriteAttribute(TextWriter, String, String, Boolean)
Writes an attribute string to the supplied stream.
(Inherited from ActiveScriptingBase.)
Top
Remarks

To use this class, create an instance of this object, and call the Invoke method with the appropriate parameters.
See Also

Reference