Smartsite Documentatie > Advanced > Developer > Class Library Reference > Smartsite.Runtime.Modules Namespace > SiblingsModule Class > SiblingsModule Properties
This document is provided on an "AS IS" basis without warranties of any kind. Smartsite iXperion class libraries may change in future releases.

Syntax

C# Copy imageCopy Code 
                                  public class SiblingsModule
Visual Basic (Declaration) Copy imageCopy Code 
                                  Public Class SiblingsModule

The type exposes the following properties.

Public Properties

  Name Description
Public property AcceptsInnerXml
Returns true if the module currently accepts string data within the macro tags.
(Inherited from BaseModule.)
Public property AccessDeniedReturnValue
Gets or sets the value that is returned when the site visitor has insufficient access.
(Inherited from Module.)
Public property AIMMode
Gets or sets the AIM scanning mode of the macro.
(Inherited from Module.)
Public property AIMOrigin
Returns the current AIM source. If AIMMode is Autonomous, the current instructionsource is used, otherwise the current item.
(Inherited from Module.)
Public property BufferNames
Gets or sets the buffer names.
(Inherited from Module.)
Public property Condition
Gets or sets the Viper expression to evaluate before actually executing the macro.
If the expression returns false, the execution of the module and its child modules is skipped.
(Inherited from Module.)
Public property ConditionMatched
Must return true if TestCondition() matched.
(Inherited from Module.)
Public property CurrentCacheModule
Returns a reference to the current cache module, if the current instruction is encapsulated by a cache block.
(Inherited from Module.)
Public property CurrentKey
Sets or returns the key value of the current sibling.
Public property CurrentProperty
Gets the property currently being set on the module.
(Inherited from BaseModule.)
Public property DefaultValue
Gets or sets the default value that will be returned when the execution would otherwise return an empty string.
(Inherited from Module.)
Public property DisplayBack
Value for the Display field of the Back sibling.
Public property DisplayChild
Value for the Display field of the Child sibling.
Public property DisplayFields
Comma-separated list of fields that should be present in the data set because they are used in formatting. Only relevant when used for content items. Otherwise the dataset has to be passed and the user should include these fields himself.
Public property DisplayFirst
Value for the Display field of the First sibling.
Public property DisplayLast
Value for the Display field of the Last sibling.
Public property DisplayNext
Value for the Display field of the Next sibling.
Public property DisplayParent
Value for the Display field of the Parent sibling.
Public property Format
Gets or sets the formatting Xml.
(Inherited from ResultSetModule.)
Public property Formatting
Gets the formatting options.
(Inherited from Module.)
Public property HasParameterSection
Returns true if the macro currently uses an SXML parameters section
(Inherited from BaseModule.)
Public property Id
Gets or sets the unique id of the module instance during the current processing.
Modules with Id set will be kept alive during the complete rendering and can be accessed from other modules using the Find method.
(Inherited from BaseModule.)
Public property InputData
Sets the dataset through which the siblings module will navigate. Using inputdata will not create Child links. Parent link can be created by including a level field. Level 1 is the parent, all siblings are level 0. Other values for level are ignored.
Public property IsCancelled
Gets a value indicating whether the execution of the macro is cancelled.
(Inherited from BaseModule.)
Public property IsSelfClosing
Gets a value indicating whether this instance is self closing.
(Inherited from BaseModule.)
Public property KeyField
Sets or returns the name of the key field in the data set.
Public property LevelField
The level field is distinguishes between siblings (0) and parent (1) in the dataset.
Public property LocalId
Gets or sets the local id of the macro in the current buffer scope.
(Inherited from Module.)
Public property MaxRows
Gets or sets a limit for the number of rows that the output may contain.
(Inherited from ResultSetModule.)
Public property MinimumAccessLevel
Gets or sets the minimum access level for each item by name. The given level must be defined as an AccessTypeLevel.
Public property MinimumAccessTypeLevel
Friendly name of the minimum access type level required by the site visitor to execute this macro.
(Inherited from Module.)
Public property MinimumBrowseLevel
Gets or sets the minimum access level for each item to be shown. Leave 0 to forgo security checks.
Public property ModuleInfo
Gets the module info.
(Inherited from BaseModule.)
Public property OnErrorReturnValue
Gets or sets the value to return in case on error occurs during execution.
The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context.
(Inherited from Module.)
Public property Parent
Gets or sets the parent.
Public property Properties
Gets the full list of properties as set when executing the module.
(Inherited from BaseModule.)
Public property Remarks
Gets or sets the remarks. Remarks have no effect on the actual execution of the module.
They only improve the readability of the code.
(Inherited from BaseModule.)
Public property Result
Returns a reference to the module result
(Inherited from BaseModule.)
Public property ResultFormat
Gets or sets the resultformat.
(Inherited from Module.)
Public property ResultType
Gets or sets the type of the result.
(Inherited from BaseModule.)
Public property RowDelimiter
Specifies the delimiter string that separates individual records.
(Inherited from ResultSetModule.)
Public property RowFormat
Gets or sets the formatting string.
(Inherited from ResultSetModule.)
Public property ShowHidden
Gets or sets a value indicating whether to show hidden items.
Public property SiblingOrder
Comma separated list determining the order in which siblings will be returned. Accepted names are "First", "Back" or "Previous", "Next", "Last", "Parent" or "Up" and "Child" or "Down". Child/Down creates a link to the first child of a content folder.
Public property SkipRows
Specifies which row will be the first row in the output.
(Inherited from ResultSetModule.)
Public property State
Gets a key/value collection that can be used to organize and share data during the lifecycle of a module.
(Inherited from BaseModule.)
Public property Status
Gets a value indicating the ModuleStatus of this module.
(Inherited from BaseModule.)
Public property SXMLPath
Gets the path to the macro in the current execution stack.
(Inherited from BaseModule.)
Public property TimeoutSeconds
Gets or sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
(Inherited from BaseModule.)
Public property Trim
Gets a value indicating how the whitespace is trimmed.
(Inherited from BaseModule.)
Public property TypeName
Gets the name of the Module type.
(Inherited from BaseModule.)
Public property UserSetPropertyList
Gets the user-set property list.
(Inherited from BaseModule.)
Public property Whitespace
Gets a value indicating whether to preserve whitespace.
(Inherited from BaseModule.)

Protected Properties

  Name Description
Protected property CurrentlyFormatting
Returns true if currently formatting
(Inherited from ResultSetModule.)
Protected property IContext
Gets a reference to the IContext interface.
(Inherited from BaseModule.)

Explicit Interface Implementations

See Also

Advanced